AWS API Changes

2024/01/31 - Amazon Simple Systems Manager (SSM) - 7 updated api methods

Changes This release adds an optional Duration parameter to StateManager Associations. This allows customers to specify how long an apply-only-on-cron association execution should run. Once the specified Duration is out all the ongoing cancellable commands or automations are cancelled.

CreateAssociation (updated)

Link ¶
Changes (request, response)
Request

{'Duration': 'integer'}

Response

{'AssociationDescription': {'Duration': 'integer'}}

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

See also: AWS API Documentation

Request Syntax

client.create_association(
    Name='string',
    DocumentVersion='string',
    InstanceId='string',
    Parameters={
        'string': [
            'string',
        ]
    },
    Targets=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ScheduleExpression='string',
    OutputLocation={
        'S3Location': {
            'OutputS3Region': 'string',
            'OutputS3BucketName': 'string',
            'OutputS3KeyPrefix': 'string'
        }
    },
    AssociationName='string',
    AutomationTargetParameterName='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'
                    },
                ]
            }
        },
    ],
    ScheduleOffset=123,
    Duration=123,
    TargetMaps=[
        {
            'string': [
                'string',
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AlarmConfiguration={
        'IgnorePollAlarmFailure': True|False,
        'Alarms': [
            {
                'Name': 'string'
            },
        ]
    }
)

type Name:

string

param Name:

[REQUIRED]

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services account.

For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

arn:partition:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

type DocumentVersion:

string

param DocumentVersion:

The document version you want to associate with the target(s). Can be a specific version or the default version.

type InstanceId:

string

param InstanceId:

The managed node ID.

type Parameters:

dict

param Parameters:

The parameters for the runtime configuration of the document.

(string) --
- (list) --
  - (string) --

type Targets:

list

param Targets:

The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.

(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.
- Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
- Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
- Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
- Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
- Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
- Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
For example:
- Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
- Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
- Key=tag-key,Values=Name,Instance-Type,CostCenter
- Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
- Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
- Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
- State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --

type ScheduleExpression:

string

param ScheduleExpression:

A cron expression when the association will be applied to the target(s).

type OutputLocation:

dict

param OutputLocation:

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

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.

type AssociationName:

string

param AssociationName:

Specify a descriptive name for the association.

type AutomationTargetParameterName:

string

param AutomationTargetParameterName:

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

type MaxErrors:

string

param MaxErrors:

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.

type MaxConcurrency:

string

param MaxConcurrency:

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.

type ComplianceSeverity:

string

param ComplianceSeverity:

The severity level to assign to the association.

type SyncCompliance:

string

param SyncCompliance:

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. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

type ApplyOnlyAtCronInterval:

boolean

param ApplyOnlyAtCronInterval:

By default, when you create a new association, 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.

type CalendarNames:

list

param CalendarNames:

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

(string) --

type TargetLocations:

list

param TargetLocations:

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

(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) -- [REQUIRED]
    
    The name of the CloudWatch alarm specified in the configuration.
    - (dict) --
      
      A CloudWatch alarm you apply to an automation or command.
      - Name (string) -- [REQUIRED]
        
        The name of your CloudWatch alarm.

type ScheduleOffset:

integer

param ScheduleOffset:

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

type Duration:

integer

param Duration:

The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

The Duration parameter applies only when both these conditions are true:

The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.

type TargetMaps:

list

param TargetMaps:

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

(dict) --
- (string) --
  - (list) --
    - (string) --

type Tags:

list

param Tags:

Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

(dict) --

Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
- Key (string) -- [REQUIRED]
  
  The name of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

type AlarmConfiguration:

dict

param AlarmConfiguration:

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) -- [REQUIRED]

The name of the CloudWatch alarm specified in the configuration.
- (dict) --
  
  A CloudWatch alarm you apply to an automation or command.
  - Name (string) -- [REQUIRED]
    
    The name of your CloudWatch alarm.

rtype:

dict

returns:

Response Syntax

{
    'AssociationDescription': {
        'Name': 'string',
        'InstanceId': 'string',
        'AssociationVersion': 'string',
        'Date': datetime(2015, 1, 1),
        'LastUpdateAssociationDate': datetime(2015, 1, 1),
        'Status': {
            'Date': datetime(2015, 1, 1),
            'Name': 'Pending'|'Success'|'Failed',
            'Message': 'string',
            'AdditionalInfo': 'string'
        },
        'Overview': {
            'Status': 'string',
            'DetailedStatus': 'string',
            'AssociationStatusAggregatedCount': {
                'string': 123
            }
        },
        'DocumentVersion': 'string',
        'AutomationTargetParameterName': 'string',
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'AssociationId': 'string',
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'ScheduleExpression': 'string',
        'OutputLocation': {
            'S3Location': {
                'OutputS3Region': 'string',
                'OutputS3BucketName': 'string',
                'OutputS3KeyPrefix': 'string'
            }
        },
        'LastExecutionDate': datetime(2015, 1, 1),
        'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
        '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'
                        },
                    ]
                }
            },
        ],
        'ScheduleOffset': 123,
        'Duration': 123,
        'TargetMaps': [
            {
                'string': [
                    'string',
                ]
            },
        ],
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the SSM document.
  - InstanceId (string) --
    
    The managed node ID.
  - AssociationVersion (string) --
    
    The association version.
  - Date (datetime) --
    
    The date when the association was made.
  - LastUpdateAssociationDate (datetime) --
    
    The date when the association was last updated.
  - Status (dict) --
    
    The association status.
    - Date (datetime) --
      
      The date when the status changed.
    - Name (string) --
      
      The status.
    - Message (string) --
      
      The reason for the status.
    - AdditionalInfo (string) --
      
      A user-defined string.
  - Overview (dict) --
    
    Information about the association.
    - Status (string) --
      
      The status of the association. Status can be: Pending, Success, or Failed.
    - DetailedStatus (string) --
      
      A detailed status of the association.
    - AssociationStatusAggregatedCount (dict) --
      
      Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The managed nodes targeted by the request.
    - (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.
      - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
      - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
      - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
      - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
      For example:
      - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
      - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
      - Key=tag-key,Values=Name,Instance-Type,CostCenter
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
      - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
      - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
    
    A cron expression that specifies a schedule when the association runs.
  - OutputLocation (dict) --
    
    An S3 bucket where you want to store the output details of the request.
    - 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.
  - LastExecutionDate (datetime) --
    
    The date on which the association was last run.
  - LastSuccessfulExecutionDate (datetime) --
    
    The last date on which the association was successfully run.
  - AssociationName (string) --
    
    The association name.
  - 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 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 want to run the association.
    - (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.
  - 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) --
  - AlarmConfiguration (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.
  - TriggeredAlarms (list) --
    
    The CloudWatch alarm that was invoked during the association.
    - (dict) --
      
      The details about the state of your CloudWatch alarm.
      - Name (string) --
        
        The name of your CloudWatch alarm.
      - State (string) --
        
        The state of your CloudWatch alarm.

CreateAssociationBatch (updated)

Link ¶
Changes (request, response)
Request

{'Entries': {'Duration': 'integer'}}

Response

{'Failed': {'Entry': {'Duration': 'integer'}},
 'Successful': {'Duration': 'integer'}}

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

See also: AWS API Documentation

Request Syntax

client.create_association_batch(
    Entries=[
        {
            'Name': 'string',
            'InstanceId': 'string',
            'Parameters': {
                'string': [
                    'string',
                ]
            },
            'AutomationTargetParameterName': 'string',
            'DocumentVersion': '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'
                            },
                        ]
                    }
                },
            ],
            'ScheduleOffset': 123,
            'Duration': 123,
            'TargetMaps': [
                {
                    'string': [
                        'string',
                    ]
                },
            ],
            'AlarmConfiguration': {
                'IgnorePollAlarmFailure': True|False,
                'Alarms': [
                    {
                        'Name': 'string'
                    },
                ]
            }
        },
    ]
)

type Entries:

list

param Entries:

[REQUIRED]

One or more associations.

(dict) --

Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
- Name (string) -- [REQUIRED]
  
  The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
  
  You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
  
  For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
  
  arn:aws:ssm:region:account-id:document/document-name
  
  For example:
  
  arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
  
  For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
- InstanceId (string) --
  
  The managed node ID.
  
  Note
  
  InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
- Parameters (dict) --
  
  A description of the parameters for a document.
  - (string) --
    - (list) --
      - (string) --
- AutomationTargetParameterName (string) --
  
  Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
- DocumentVersion (string) --
  
  The document version.
- Targets (list) --
  
  The managed nodes targeted by the request.
  - (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.
    - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
    - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
    - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
    - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
    - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
    - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
    For example:
    - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
    - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
    - Key=tag-key,Values=Name,Instance-Type,CostCenter
    - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
    - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
    - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
    - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
    For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
  
  A cron expression that specifies a schedule when the association runs.
- OutputLocation (dict) --
  
  An S3 bucket where you want to store the results of this request.
  - 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) --
  
  Specify a descriptive name for the association.
- 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 to assign 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 only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
  - (string) --
- TargetLocations (list) --
  
  Use this action to create an association in multiple Regions and multiple accounts.
  - (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) -- [REQUIRED]
        
        The name of the CloudWatch alarm specified in the configuration.
        
        (dict) --
        
        A CloudWatch alarm you apply to an automation or command.
        
        Name (string) -- [REQUIRED]
        
        The name of your CloudWatch alarm.
- ScheduleOffset (integer) --
  
  Number of days to wait after the scheduled day to run an association.
- Duration (integer) --
  
  The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
  
  The Duration parameter applies only when both these conditions are true:
  - The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
  - The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
- 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) --
- AlarmConfiguration (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) -- [REQUIRED]
    
    The name of the CloudWatch alarm specified in the configuration.
    - (dict) --
      
      A CloudWatch alarm you apply to an automation or command.
      - Name (string) -- [REQUIRED]
        
        The name of your CloudWatch alarm.

rtype:

dict

returns:

Response Syntax

{
    'Successful': [
        {
            'Name': 'string',
            'InstanceId': 'string',
            'AssociationVersion': 'string',
            'Date': datetime(2015, 1, 1),
            'LastUpdateAssociationDate': datetime(2015, 1, 1),
            'Status': {
                'Date': datetime(2015, 1, 1),
                'Name': 'Pending'|'Success'|'Failed',
                'Message': 'string',
                'AdditionalInfo': 'string'
            },
            'Overview': {
                'Status': 'string',
                'DetailedStatus': 'string',
                'AssociationStatusAggregatedCount': {
                    'string': 123
                }
            },
            'DocumentVersion': 'string',
            'AutomationTargetParameterName': 'string',
            'Parameters': {
                'string': [
                    'string',
                ]
            },
            'AssociationId': 'string',
            'Targets': [
                {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ScheduleExpression': 'string',
            'OutputLocation': {
                'S3Location': {
                    'OutputS3Region': 'string',
                    'OutputS3BucketName': 'string',
                    'OutputS3KeyPrefix': 'string'
                }
            },
            'LastExecutionDate': datetime(2015, 1, 1),
            'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
            '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'
                            },
                        ]
                    }
                },
            ],
            'ScheduleOffset': 123,
            'Duration': 123,
            'TargetMaps': [
                {
                    'string': [
                        'string',
                    ]
                },
            ],
            'AlarmConfiguration': {
                'IgnorePollAlarmFailure': True|False,
                'Alarms': [
                    {
                        'Name': 'string'
                    },
                ]
            },
            'TriggeredAlarms': [
                {
                    'Name': 'string',
                    'State': 'UNKNOWN'|'ALARM'
                },
            ]
        },
    ],
    'Failed': [
        {
            'Entry': {
                'Name': 'string',
                'InstanceId': 'string',
                'Parameters': {
                    'string': [
                        'string',
                    ]
                },
                'AutomationTargetParameterName': 'string',
                'DocumentVersion': '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'
                                },
                            ]
                        }
                    },
                ],
                'ScheduleOffset': 123,
                'Duration': 123,
                'TargetMaps': [
                    {
                        'string': [
                            'string',
                        ]
                    },
                ],
                'AlarmConfiguration': {
                    'IgnorePollAlarmFailure': True|False,
                    'Alarms': [
                        {
                            'Name': 'string'
                        },
                    ]
                }
            },
            'Message': 'string',
            'Fault': 'Client'|'Server'|'Unknown'
        },
    ]
}

Response Structure

(dict) --
- Successful (list) --
  
  Information about the associations that succeeded.
  - (dict) --
    
    Describes the parameters for a document.
    - Name (string) --
      
      The name of the SSM document.
    - InstanceId (string) --
      
      The managed node ID.
    - AssociationVersion (string) --
      
      The association version.
    - Date (datetime) --
      
      The date when the association was made.
    - LastUpdateAssociationDate (datetime) --
      
      The date when the association was last updated.
    - Status (dict) --
      
      The association status.
      - Date (datetime) --
        
        The date when the status changed.
      - Name (string) --
        
        The status.
      - Message (string) --
        
        The reason for the status.
      - AdditionalInfo (string) --
        
        A user-defined string.
    - Overview (dict) --
      
      Information about the association.
      - Status (string) --
        
        The status of the association. Status can be: Pending, Success, or Failed.
      - DetailedStatus (string) --
        
        A detailed status of the association.
      - AssociationStatusAggregatedCount (dict) --
        
        Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
        
        (string) --
        
        (integer) --
    - DocumentVersion (string) --
      
      The document version.
    - AutomationTargetParameterName (string) --
      
      Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
    - Parameters (dict) --
      
      A description of the parameters for a document.
      - (string) --
        
        (list) --
        
        (string) --
    - AssociationId (string) --
      
      The association ID.
    - Targets (list) --
      
      The managed nodes targeted by the request.
      - (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.
        
        Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
        
        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
        
        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
        
        Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
        
        For example:
        
        Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
        
        Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
        
        Key=tag-key,Values=Name,Instance-Type,CostCenter
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
        
        Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
        
        State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
      
      A cron expression that specifies a schedule when the association runs.
    - OutputLocation (dict) --
      
      An S3 bucket where you want to store the output details of the request.
      - 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.
    - LastExecutionDate (datetime) --
      
      The date on which the association was last run.
    - LastSuccessfulExecutionDate (datetime) --
      
      The last date on which the association was successfully run.
    - AssociationName (string) --
      
      The association name.
    - 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 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 want to run the association.
      - (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.
    - 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) --
    - AlarmConfiguration (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.
    - TriggeredAlarms (list) --
      
      The CloudWatch alarm that was invoked during the association.
      - (dict) --
        
        The details about the state of your CloudWatch alarm.
        
        Name (string) --
        
        The name of your CloudWatch alarm.
        
        State (string) --
        
        The state of your CloudWatch alarm.
- Failed (list) --
  
  Information about the associations that failed.
  - (dict) --
    
    Describes a failed association.
    - Entry (dict) --
      
      The association.
      - Name (string) --
        
        The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
        
        You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
        
        For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
        
        arn:aws:ssm:region:account-id:document/document-name
        
        For example:
        
        arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
        
        For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
      - InstanceId (string) --
        
        The managed node ID.
        
        Note
        
        InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
      - Parameters (dict) --
        
        A description of the parameters for a document.
        
        (string) --
        
        (list) --
        
        (string) --
      - AutomationTargetParameterName (string) --
        
        Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
      - DocumentVersion (string) --
        
        The document version.
      - Targets (list) --
        
        The managed nodes targeted by the request.
        
        (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.
        
        Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
        
        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
        
        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
        
        Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
        
        For example:
        
        Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
        
        Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
        
        Key=tag-key,Values=Name,Instance-Type,CostCenter
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
        
        Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
        
        State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
        
        A cron expression that specifies a schedule when the association runs.
      - OutputLocation (dict) --
        
        An S3 bucket where you want to store the results of this request.
        
        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) --
        
        Specify a descriptive name for the association.
      - 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 to assign 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 only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
        
        (string) --
      - TargetLocations (list) --
        
        Use this action to create an association in multiple Regions and multiple accounts.
        
        (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.
      - ScheduleOffset (integer) --
        
        Number of days to wait after the scheduled day to run an association.
      - Duration (integer) --
        
        The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
        
        The Duration parameter applies only when both these conditions are true:
        
        The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
        
        The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
      - 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) --
      - AlarmConfiguration (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.
    - Message (string) --
      
      A description of the failure.
    - Fault (string) --
      
      The source of the failure.

DescribeAssociation (updated)

Link ¶
Changes (response)

{'AssociationDescription': {'Duration': 'integer'}}

Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

See also: AWS API Documentation

Request Syntax

client.describe_association(
    Name='string',
    InstanceId='string',
    AssociationId='string',
    AssociationVersion='string'
)

type Name:

string

param Name:

The name of the SSM document.

type InstanceId:

string

param InstanceId:

The managed node ID.

type AssociationId:

string

param AssociationId:

The association ID for which you want information.

type AssociationVersion:

string

param AssociationVersion:

Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

rtype:

dict

returns:

Response Syntax

{
    'AssociationDescription': {
        'Name': 'string',
        'InstanceId': 'string',
        'AssociationVersion': 'string',
        'Date': datetime(2015, 1, 1),
        'LastUpdateAssociationDate': datetime(2015, 1, 1),
        'Status': {
            'Date': datetime(2015, 1, 1),
            'Name': 'Pending'|'Success'|'Failed',
            'Message': 'string',
            'AdditionalInfo': 'string'
        },
        'Overview': {
            'Status': 'string',
            'DetailedStatus': 'string',
            'AssociationStatusAggregatedCount': {
                'string': 123
            }
        },
        'DocumentVersion': 'string',
        'AutomationTargetParameterName': 'string',
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'AssociationId': 'string',
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'ScheduleExpression': 'string',
        'OutputLocation': {
            'S3Location': {
                'OutputS3Region': 'string',
                'OutputS3BucketName': 'string',
                'OutputS3KeyPrefix': 'string'
            }
        },
        'LastExecutionDate': datetime(2015, 1, 1),
        'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
        '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'
                        },
                    ]
                }
            },
        ],
        'ScheduleOffset': 123,
        'Duration': 123,
        'TargetMaps': [
            {
                'string': [
                    'string',
                ]
            },
        ],
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the SSM document.
  - InstanceId (string) --
    
    The managed node ID.
  - AssociationVersion (string) --
    
    The association version.
  - Date (datetime) --
    
    The date when the association was made.
  - LastUpdateAssociationDate (datetime) --
    
    The date when the association was last updated.
  - Status (dict) --
    
    The association status.
    - Date (datetime) --
      
      The date when the status changed.
    - Name (string) --
      
      The status.
    - Message (string) --
      
      The reason for the status.
    - AdditionalInfo (string) --
      
      A user-defined string.
  - Overview (dict) --
    
    Information about the association.
    - Status (string) --
      
      The status of the association. Status can be: Pending, Success, or Failed.
    - DetailedStatus (string) --
      
      A detailed status of the association.
    - AssociationStatusAggregatedCount (dict) --
      
      Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The managed nodes targeted by the request.
    - (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.
      - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
      - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
      - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
      - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
      For example:
      - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
      - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
      - Key=tag-key,Values=Name,Instance-Type,CostCenter
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
      - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
      - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
    
    A cron expression that specifies a schedule when the association runs.
  - OutputLocation (dict) --
    
    An S3 bucket where you want to store the output details of the request.
    - 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.
  - LastExecutionDate (datetime) --
    
    The date on which the association was last run.
  - LastSuccessfulExecutionDate (datetime) --
    
    The last date on which the association was successfully run.
  - AssociationName (string) --
    
    The association name.
  - 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 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 want to run the association.
    - (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.
  - 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) --
  - AlarmConfiguration (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.
  - TriggeredAlarms (list) --
    
    The CloudWatch alarm that was invoked during the association.
    - (dict) --
      
      The details about the state of your CloudWatch alarm.
      - Name (string) --
        
        The name of your CloudWatch alarm.
      - State (string) --
        
        The state of your CloudWatch alarm.

ListAssociationVersions (updated)

Link ¶
Changes (response)

{'AssociationVersions': {'Duration': 'integer'}}

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

See also: AWS API Documentation

Request Syntax

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

type AssociationId:

string

param AssociationId:

[REQUIRED]

The association ID for which you want to view all versions.

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

A token to start the list. Use this token to get the next set of results.

rtype:

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'
                            },
                        ]
                    }
                },
            ],
            '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.
        
        Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
        
        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
        
        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
        
        Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
        
        For example:
        
        Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
        
        Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
        
        Key=tag-key,Values=Name,Instance-Type,CostCenter
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
        
        Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
        
        State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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.
    - 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.

ListAssociations (updated)

Link ¶
Changes (response)

{'Associations': {'Duration': 'integer'}}

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

See also: AWS API Documentation

Request Syntax

client.list_associations(
    AssociationFilterList=[
        {
            'key': 'InstanceId'|'Name'|'AssociationId'|'AssociationStatusName'|'LastExecutedBefore'|'LastExecutedAfter'|'AssociationName'|'ResourceGroupName',
            'value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type AssociationFilterList:

list

param AssociationFilterList:

One or more filters. Use a filter to return a more specific list of results.

(dict) --

Describes a filter.
- key (string) -- [REQUIRED]
  
  The name of the filter.
  
  Note
  
  InstanceId has been deprecated.
- value (string) -- [REQUIRED]
  
  The filter value.

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

The token for the next set of items to return. (You received this token from a previous call.)

rtype:

dict

returns:

Response Syntax

{
    'Associations': [
        {
            'Name': 'string',
            'InstanceId': 'string',
            'AssociationId': 'string',
            'AssociationVersion': 'string',
            'DocumentVersion': 'string',
            'Targets': [
                {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'LastExecutionDate': datetime(2015, 1, 1),
            'Overview': {
                'Status': 'string',
                'DetailedStatus': 'string',
                'AssociationStatusAggregatedCount': {
                    'string': 123
                }
            },
            'ScheduleExpression': 'string',
            'AssociationName': 'string',
            'ScheduleOffset': 123,
            'Duration': 123,
            'TargetMaps': [
                {
                    'string': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Associations (list) --
  
  The associations.
  - (dict) --
    
    Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
    - Name (string) --
      
      The name of the SSM document.
    - InstanceId (string) --
      
      The managed node ID.
    - AssociationId (string) --
      
      The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
    - AssociationVersion (string) --
      
      The association version.
    - DocumentVersion (string) --
      
      The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
      
      Warning
      
      State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
    - Targets (list) --
      
      The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.
      - (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.
        
        Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
        
        Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
        
        Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
        
        Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
        
        For example:
        
        Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
        
        Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
        
        Key=tag-key,Values=Name,Instance-Type,CostCenter
        
        Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
        
        Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
        
        Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
        
        State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
        
        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
    - LastExecutionDate (datetime) --
      
      The date on which the association was last run.
    - Overview (dict) --
      
      Information about the association.
      - Status (string) --
        
        The status of the association. Status can be: Pending, Success, or Failed.
      - DetailedStatus (string) --
        
        A detailed status of the association.
      - AssociationStatusAggregatedCount (dict) --
        
        Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
        
        (string) --
        
        (integer) --
    - ScheduleExpression (string) --
      
      A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
    - AssociationName (string) --
      
      The association name.
    - 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 to use when requesting the next set of items. If there are no additional items to return, the string is empty.

UpdateAssociation (updated)

Link ¶
Changes (request, response)
Request

{'Duration': 'integer'}

Response

{'AssociationDescription': {'Duration': 'integer'}}

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.

In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

See also: AWS API Documentation

Request Syntax

client.update_association(
    AssociationId='string',
    Parameters={
        'string': [
            'string',
        ]
    },
    DocumentVersion='string',
    ScheduleExpression='string',
    OutputLocation={
        'S3Location': {
            'OutputS3Region': 'string',
            'OutputS3BucketName': 'string',
            'OutputS3KeyPrefix': 'string'
        }
    },
    Name='string',
    Targets=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    AssociationName='string',
    AssociationVersion='string',
    AutomationTargetParameterName='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'
                    },
                ]
            }
        },
    ],
    ScheduleOffset=123,
    Duration=123,
    TargetMaps=[
        {
            'string': [
                'string',
            ]
        },
    ],
    AlarmConfiguration={
        'IgnorePollAlarmFailure': True|False,
        'Alarms': [
            {
                'Name': 'string'
            },
        ]
    }
)

type AssociationId:

string

param AssociationId:

[REQUIRED]

The ID of the association you want to update.

type Parameters:

dict

param Parameters:

The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

(string) --
- (list) --
  - (string) --

type DocumentVersion:

string

param DocumentVersion:

The document version you want update for the association.

type ScheduleExpression:

string

param ScheduleExpression:

The cron expression used to schedule the association that you want to update.

type OutputLocation:

dict

param OutputLocation:

An S3 bucket where you want to store the results of this request.

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.

type Name:

string

param Name:

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

type Targets:

list

param Targets:

The targets of the association.

(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.
- Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
- Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
- Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
- Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
- Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
- Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
For example:
- Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
- Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
- Key=tag-key,Values=Name,Instance-Type,CostCenter
- Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
- Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
- Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
- State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --

type AssociationName:

string

param AssociationName:

The name of the association that you want to update.

type AssociationVersion:

string

param AssociationVersion:

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

type AutomationTargetParameterName:

string

param AutomationTargetParameterName:

type MaxErrors:

string

param MaxErrors:

type MaxConcurrency:

string

param MaxConcurrency:

type ComplianceSeverity:

string

param ComplianceSeverity:

The severity level to assign to the association.

type SyncCompliance:

string

param SyncCompliance:

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.

type ApplyOnlyAtCronInterval:

boolean

param ApplyOnlyAtCronInterval:

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.

If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the Latest version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.

You can reset this option. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

type CalendarNames:

list

param CalendarNames:

(string) --

type TargetLocations:

list

param TargetLocations:

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.

(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) -- [REQUIRED]
    
    The name of the CloudWatch alarm specified in the configuration.
    - (dict) --
      
      A CloudWatch alarm you apply to an automation or command.
      - Name (string) -- [REQUIRED]
        
        The name of your CloudWatch alarm.

type ScheduleOffset:

integer

param ScheduleOffset:

type Duration:

integer

param Duration:

The Duration parameter applies only when both these conditions are true:

The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.

type TargetMaps:

list

param TargetMaps:

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

(dict) --
- (string) --
  - (list) --
    - (string) --

type AlarmConfiguration:

dict

param AlarmConfiguration:

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) -- [REQUIRED]

The name of the CloudWatch alarm specified in the configuration.
- (dict) --
  
  A CloudWatch alarm you apply to an automation or command.
  - Name (string) -- [REQUIRED]
    
    The name of your CloudWatch alarm.

rtype:

dict

returns:

Response Syntax

{
    'AssociationDescription': {
        'Name': 'string',
        'InstanceId': 'string',
        'AssociationVersion': 'string',
        'Date': datetime(2015, 1, 1),
        'LastUpdateAssociationDate': datetime(2015, 1, 1),
        'Status': {
            'Date': datetime(2015, 1, 1),
            'Name': 'Pending'|'Success'|'Failed',
            'Message': 'string',
            'AdditionalInfo': 'string'
        },
        'Overview': {
            'Status': 'string',
            'DetailedStatus': 'string',
            'AssociationStatusAggregatedCount': {
                'string': 123
            }
        },
        'DocumentVersion': 'string',
        'AutomationTargetParameterName': 'string',
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'AssociationId': 'string',
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'ScheduleExpression': 'string',
        'OutputLocation': {
            'S3Location': {
                'OutputS3Region': 'string',
                'OutputS3BucketName': 'string',
                'OutputS3KeyPrefix': 'string'
            }
        },
        'LastExecutionDate': datetime(2015, 1, 1),
        'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
        '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'
                        },
                    ]
                }
            },
        ],
        'ScheduleOffset': 123,
        'Duration': 123,
        'TargetMaps': [
            {
                'string': [
                    'string',
                ]
            },
        ],
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  The description of the association that was updated.
  - Name (string) --
    
    The name of the SSM document.
  - InstanceId (string) --
    
    The managed node ID.
  - AssociationVersion (string) --
    
    The association version.
  - Date (datetime) --
    
    The date when the association was made.
  - LastUpdateAssociationDate (datetime) --
    
    The date when the association was last updated.
  - Status (dict) --
    
    The association status.
    - Date (datetime) --
      
      The date when the status changed.
    - Name (string) --
      
      The status.
    - Message (string) --
      
      The reason for the status.
    - AdditionalInfo (string) --
      
      A user-defined string.
  - Overview (dict) --
    
    Information about the association.
    - Status (string) --
      
      The status of the association. Status can be: Pending, Success, or Failed.
    - DetailedStatus (string) --
      
      A detailed status of the association.
    - AssociationStatusAggregatedCount (dict) --
      
      Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The managed nodes targeted by the request.
    - (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.
      - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
      - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
      - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
      - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
      For example:
      - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
      - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
      - Key=tag-key,Values=Name,Instance-Type,CostCenter
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
      - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
      - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
    
    A cron expression that specifies a schedule when the association runs.
  - OutputLocation (dict) --
    
    An S3 bucket where you want to store the output details of the request.
    - 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.
  - LastExecutionDate (datetime) --
    
    The date on which the association was last run.
  - LastSuccessfulExecutionDate (datetime) --
    
    The last date on which the association was successfully run.
  - AssociationName (string) --
    
    The association name.
  - 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 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 want to run the association.
    - (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.
  - 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) --
  - AlarmConfiguration (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.
  - TriggeredAlarms (list) --
    
    The CloudWatch alarm that was invoked during the association.
    - (dict) --
      
      The details about the state of your CloudWatch alarm.
      - Name (string) --
        
        The name of your CloudWatch alarm.
      - State (string) --
        
        The state of your CloudWatch alarm.

UpdateAssociationStatus (updated)

Link ¶
Changes (response)

{'AssociationDescription': {'Duration': 'integer'}}

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

See also: AWS API Documentation

Request Syntax

client.update_association_status(
    Name='string',
    InstanceId='string',
    AssociationStatus={
        'Date': datetime(2015, 1, 1),
        'Name': 'Pending'|'Success'|'Failed',
        'Message': 'string',
        'AdditionalInfo': 'string'
    }
)

type Name:

string

param Name:

[REQUIRED]

The name of the SSM document.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The managed node ID.

type AssociationStatus:

dict

param AssociationStatus:

[REQUIRED]

The association status.

Date (datetime) -- [REQUIRED]

The date when the status changed.
Name (string) -- [REQUIRED]

The status.
Message (string) -- [REQUIRED]

The reason for the status.
AdditionalInfo (string) --

A user-defined string.

rtype:

dict

returns:

Response Syntax

{
    'AssociationDescription': {
        'Name': 'string',
        'InstanceId': 'string',
        'AssociationVersion': 'string',
        'Date': datetime(2015, 1, 1),
        'LastUpdateAssociationDate': datetime(2015, 1, 1),
        'Status': {
            'Date': datetime(2015, 1, 1),
            'Name': 'Pending'|'Success'|'Failed',
            'Message': 'string',
            'AdditionalInfo': 'string'
        },
        'Overview': {
            'Status': 'string',
            'DetailedStatus': 'string',
            'AssociationStatusAggregatedCount': {
                'string': 123
            }
        },
        'DocumentVersion': 'string',
        'AutomationTargetParameterName': 'string',
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'AssociationId': 'string',
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'ScheduleExpression': 'string',
        'OutputLocation': {
            'S3Location': {
                'OutputS3Region': 'string',
                'OutputS3BucketName': 'string',
                'OutputS3KeyPrefix': 'string'
            }
        },
        'LastExecutionDate': datetime(2015, 1, 1),
        'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
        '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'
                        },
                    ]
                }
            },
        ],
        'ScheduleOffset': 123,
        'Duration': 123,
        'TargetMaps': [
            {
                'string': [
                    'string',
                ]
            },
        ],
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the SSM document.
  - InstanceId (string) --
    
    The managed node ID.
  - AssociationVersion (string) --
    
    The association version.
  - Date (datetime) --
    
    The date when the association was made.
  - LastUpdateAssociationDate (datetime) --
    
    The date when the association was last updated.
  - Status (dict) --
    
    The association status.
    - Date (datetime) --
      
      The date when the status changed.
    - Name (string) --
      
      The status.
    - Message (string) --
      
      The reason for the status.
    - AdditionalInfo (string) --
      
      A user-defined string.
  - Overview (dict) --
    
    Information about the association.
    - Status (string) --
      
      The status of the association. Status can be: Pending, Success, or Failed.
    - DetailedStatus (string) --
      
      A detailed status of the association.
    - AssociationStatusAggregatedCount (dict) --
      
      Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The managed nodes targeted by the request.
    - (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.
      - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
      - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
      - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
      - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
      For example:
      - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
      - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
      - Key=tag-key,Values=Name,Instance-Type,CostCenter
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
      - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
      - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances 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) --
    
    A cron expression that specifies a schedule when the association runs.
  - OutputLocation (dict) --
    
    An S3 bucket where you want to store the output details of the request.
    - 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.
  - LastExecutionDate (datetime) --
    
    The date on which the association was last run.
  - LastSuccessfulExecutionDate (datetime) --
    
    The last date on which the association was successfully run.
  - AssociationName (string) --
    
    The association name.
  - 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 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 want to run the association.
    - (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.
  - 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) --
  - AlarmConfiguration (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.
  - TriggeredAlarms (list) --
    
    The CloudWatch alarm that was invoked during the association.
    - (dict) --
      
      The details about the state of your CloudWatch alarm.
      - Name (string) --
        
        The name of your CloudWatch alarm.
      - State (string) --
        
        The state of your CloudWatch alarm.