SSM / Client / list_association_versions

list_association_versions#

SSM.Client.list_association_versions(**kwargs)#

Retrieves all versions of an association for a specific association ID.

Request Syntax

response = client.list_association_versions(
    AssociationId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AssociationId (string) –
[REQUIRED]

The association ID for which you want to view all versions.
MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
NextToken (string) – A token to start the list. Use this token to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationVersions': [
        {
            'AssociationId': 'string',
            'AssociationVersion': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Name': 'string',
            'DocumentVersion': 'string',
            'Parameters': {
                'string': [
                    'string',
                ]
            },
            'Targets': [
                {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ScheduleExpression': 'string',
            'OutputLocation': {
                'S3Location': {
                    'OutputS3Region': 'string',
                    'OutputS3BucketName': 'string',
                    'OutputS3KeyPrefix': 'string'
                }
            },
            'AssociationName': 'string',
            'MaxErrors': 'string',
            'MaxConcurrency': 'string',
            'ComplianceSeverity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'UNSPECIFIED',
            'SyncCompliance': 'AUTO'|'MANUAL',
            'ApplyOnlyAtCronInterval': True|False,
            'CalendarNames': [
                'string',
            ],
            'TargetLocations': [
                {
                    'Accounts': [
                        'string',
                    ],
                    'Regions': [
                        'string',
                    ],
                    'TargetLocationMaxConcurrency': 'string',
                    'TargetLocationMaxErrors': 'string',
                    'ExecutionRoleName': 'string',
                    'TargetLocationAlarmConfiguration': {
                        'IgnorePollAlarmFailure': True|False,
                        'Alarms': [
                            {
                                'Name': 'string'
                            },
                        ]
                    },
                    'IncludeChildOrganizationUnits': True|False,
                    'ExcludeAccounts': [
                        'string',
                    ],
                    'Targets': [
                        {
                            'Key': 'string',
                            'Values': [
                                'string',
                            ]
                        },
                    ],
                    'TargetsMaxConcurrency': 'string',
                    'TargetsMaxErrors': 'string'
                },
            ],
            'ScheduleOffset': 123,
            'Duration': 123,
            'TargetMaps': [
                {
                    'string': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- AssociationVersions (list) –
  
  Information about all versions of the association for the specified association ID.
  - (dict) –
    
    Information about the association version.
    - AssociationId (string) –
      
      The ID created by the system when the association was created.
    - AssociationVersion (string) –
      
      The association version.
    - CreatedDate (datetime) –
      
      The date the association version was created.
    - Name (string) –
      
      The name specified when the association was created.
    - DocumentVersion (string) –
      
      The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
    - Parameters (dict) –
      
      Parameters specified when the association version was created.
      - (string) –
        
        (list) –
        
        (string) –
    - Targets (list) –
      
      The targets specified for the association when the association version was created.
      - (dict) –
        
        An array of search criteria that targets managed nodes using a key-value pair that you specify.
        
        Note
        One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
        
        Supported formats include the following.
        
        For all Systems Manager capabilities:
        
        Key=tag-key,Values=tag-value-1,tag-value-2
        
        For Automation and Change Manager:
        
        Key=tag:tag-key,Values=tag-value
        
        Key=ResourceGroup,Values=resource-group-name
        
        Key=ParameterValues,Values=value-1,value-2,value-3
        
        To target all instances in the Amazon Web Services Region:
        
        Key=AWS::EC2::Instance,Values=*
        
        Key=InstanceIds,Values=*
        
        For Run Command and Maintenance Windows:
        
        Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
        
        Key=tag:tag-key,Values=tag-value-1,tag-value-2
        
        Key=resource-groups:Name,Values=resource-group-name
        
        Additionally, Maintenance Windows support targeting resource types:
        
        Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
        
        For State Manager:
        
        Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
        
        Key=tag:tag-key,Values=tag-value-1,tag-value-2
        
        To target all instances in the Amazon Web Services Region:
        
        Key=InstanceIds,Values=*
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
        
        Key (string) –
        
        User-defined criteria for sending commands that target managed nodes that meet the criteria.
        
        Values (list) –
        
        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.
        
        Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
        
        (string) –
    - ScheduleExpression (string) –
      
      The cron or rate schedule specified for the association when the association version was created.
    - OutputLocation (dict) –
      
      The location in Amazon S3 specified for the association when the association version was created.
      - S3Location (dict) –
        
        An S3 bucket where you want to store the results of this request.
        
        OutputS3Region (string) –
        
        The Amazon Web Services Region of the S3 bucket.
        
        OutputS3BucketName (string) –
        
        The name of the S3 bucket.
        
        OutputS3KeyPrefix (string) –
        
        The S3 bucket subfolder.
    - AssociationName (string) –
      
      The name specified for the association version when the association version was created.
    - MaxErrors (string) –
      
      The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
      
      Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
    - MaxConcurrency (string) –
      
      The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
      
      If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.
    - ComplianceSeverity (string) –
      
      The severity level that is assigned to the association.
    - SyncCompliance (string) –
      
      The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn’t run successfully, the association is NON-COMPLIANT.
      
      In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
      
      By default, all associations use AUTO mode.
    - ApplyOnlyAtCronInterval (boolean) –
      
      By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don’t want an association to run immediately after you create it. This parameter isn’t supported for rate expressions.
    - CalendarNames (list) –
      
      The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
      - (string) –
    - TargetLocations (list) –
      
      The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
      - (dict) –
        
        The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
        
        Accounts (list) –
        
        The Amazon Web Services accounts targeted by the current Automation execution.
        
        (string) –
        
        Regions (list) –
        
        The Amazon Web Services Regions targeted by the current Automation execution.
        
        (string) –
        
        TargetLocationMaxConcurrency (string) –
        
        The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
        
        TargetLocationMaxErrors (string) –
        
        The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
        
        ExecutionRoleName (string) –
        
        The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.
        
        TargetLocationAlarmConfiguration (dict) –
        
        The details for the CloudWatch alarm you want to apply to an automation or command.
        
        IgnorePollAlarmFailure (boolean) –
        
        When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
        
        Alarms (list) –
        
        The name of the CloudWatch alarm specified in the configuration.
        
        (dict) –
        
        A CloudWatch alarm you apply to an automation or command.
        
        Name (string) –
        
        The name of your CloudWatch alarm.
        
        IncludeChildOrganizationUnits (boolean) –
        
        Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.
        
        ExcludeAccounts (list) –
        
        Amazon Web Services accounts or organizational units to exclude as expanded targets.
        
        (string) –
        
        Targets (list) –
        
        A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
        
        This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
        
        (dict) –
        
        An array of search criteria that targets managed nodes using a key-value pair that you specify.
        
        Note
        One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
        
        Supported formats include the following.
        
        For all Systems Manager capabilities:
        
        Key=tag-key,Values=tag-value-1,tag-value-2
        
        For Automation and Change Manager:
        
        Key=tag:tag-key,Values=tag-value
        
        Key=ResourceGroup,Values=resource-group-name
        
        Key=ParameterValues,Values=value-1,value-2,value-3
        
        To target all instances in the Amazon Web Services Region:
        
        Key=AWS::EC2::Instance,Values=*
        
        Key=InstanceIds,Values=*
        
        For Run Command and Maintenance Windows:
        
        Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
        
        Key=tag:tag-key,Values=tag-value-1,tag-value-2
        
        Key=resource-groups:Name,Values=resource-group-name
        
        Additionally, Maintenance Windows support targeting resource types:
        
        Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
        
        For State Manager:
        
        Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
        
        Key=tag:tag-key,Values=tag-value-1,tag-value-2
        
        To target all instances in the Amazon Web Services Region:
        
        Key=InstanceIds,Values=*
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
        
        Key (string) –
        
        User-defined criteria for sending commands that target managed nodes that meet the criteria.
        
        Values (list) –
        
        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.
        
        Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
        
        (string) –
        
        TargetsMaxConcurrency (string) –
        
        The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.
        
        TargetsMaxErrors (string) –
        
        The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.
    - ScheduleOffset (integer) –
      
      Number of days to wait after the scheduled day to run an association.
    - Duration (integer) –
      
      The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
    - TargetMaps (list) –
      
      A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.
      - (dict) –
        
        (string) –
        
        (list) –
        
        (string) –
- NextToken (string) –
  
  The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.InvalidNextToken
SSM.Client.exceptions.AssociationDoesNotExist

list_association_versions#

Request Syntax

Response Syntax

Response Structure

Note

For all Systems Manager capabilities:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

Note

For all Systems Manager capabilities:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

Exceptions