AWS API Changes

2020/04/28 - Amazon Simple Systems Manager (SSM) - 8 updated api methods

Changes Update ssm client to latest version

CreateAssociation (updated)

Link ¶
Changes (request, response)
Request

{'SyncCompliance': 'AUTO | MANUAL'}

Response

{'AssociationDescription': {'SyncCompliance': 'AUTO | MANUAL'}}

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

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

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'
)

type Name:

string

param Name:

[REQUIRED]

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 instance 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 instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

(dict) --

An array of search criteria that targets instances using a Key,Value combination that you specify.

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
- (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
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
- (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 EC2 instances and VPCs in your maintenance window.
- (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
- Key (string) --
  
  User-defined criteria for sending commands that target instances 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.
  - (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 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) --
  
  (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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:

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

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'
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the Systems Manager document.
  - InstanceId (string) --
    
    The ID of the instance.
  - 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 instances, and one of them was successful, this would return the count of instances by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The instances targeted by the request.
    - (dict) --
      
      An array of search criteria that targets instances using a Key,Value combination that you specify.
      
      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
      - (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
      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
      - (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 EC2 instances and VPCs in your maintenance window.
      - (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
      For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
      - Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.

CreateAssociationBatch (updated)

Link ¶
Changes (request, response)
Request

{'Entries': {'SyncCompliance': 'AUTO | MANUAL'}}

Response

{'Failed': {'Entry': {'SyncCompliance': 'AUTO | MANUAL'}},
 'Successful': {'SyncCompliance': 'AUTO | MANUAL'}}

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance 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'
        },
    ]
)

type Entries:

list

param Entries:

[REQUIRED]

One or more associations.

(dict) --

Describes the association of a Systems Manager SSM document and an instance.
- Name (string) -- [REQUIRED]
  
  The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
  
  You can specify AWS-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 AWS 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 AWS-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 ID of the instance.
- 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 document and target resources by using rate controls.
- DocumentVersion (string) --
  
  The document version.
- Targets (list) --
  
  The instances targeted by the request.
  - (dict) --
    
    An array of search criteria that targets instances using a Key,Value combination that you specify.
    
    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
    - (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
    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
    - (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 EC2 instances and VPCs in your maintenance window.
    - (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
    For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
    - Key (string) --
      
      User-defined criteria for sending commands that target instances 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.
      - (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) --
      
      (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
  
  By default, all associations use AUTO mode.

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'
        },
    ],
    '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'
            },
            '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 Systems Manager document.
    - InstanceId (string) --
      
      The ID of the instance.
    - 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 instances, and one of them was successful, this would return the count of instances by status.
        
        (string) --
        
        (integer) --
    - DocumentVersion (string) --
      
      The document version.
    - AutomationTargetParameterName (string) --
      
      Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
    - Parameters (dict) --
      
      A description of the parameters for a document.
      - (string) --
        
        (list) --
        
        (string) --
    - AssociationId (string) --
      
      The association ID.
    - Targets (list) --
      
      The instances targeted by the request.
      - (dict) --
        
        An array of search criteria that targets instances using a Key,Value combination that you specify.
        
        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
        
        (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
        
        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
        
        (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 EC2 instances and VPCs in your maintenance window.
        
        (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
        
        For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
        
        Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
      
      By default, all associations use AUTO mode.
- 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 instance. You can specify Command or Automation documents.
        
        You can specify AWS-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 AWS 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 AWS-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 ID of the instance.
      - 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 document and target resources by using rate controls.
      - DocumentVersion (string) --
        
        The document version.
      - Targets (list) --
        
        The instances targeted by the request.
        
        (dict) --
        
        An array of search criteria that targets instances using a Key,Value combination that you specify.
        
        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
        
        (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
        
        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
        
        (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 EC2 instances and VPCs in your maintenance window.
        
        (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
        
        For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
        
        Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
        
        By default, all associations use AUTO mode.
    - Message (string) --
      
      A description of the failure.
    - Fault (string) --
      
      The source of the failure.

DescribeAssociation (updated)

Link ¶
Changes (response)

{'AssociationDescription': {'SyncCompliance': 'AUTO | MANUAL'}}

Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance 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 Systems Manager document.

type InstanceId:

string

param InstanceId:

The instance 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 an instance, 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'
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the Systems Manager document.
  - InstanceId (string) --
    
    The ID of the instance.
  - 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 instances, and one of them was successful, this would return the count of instances by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The instances targeted by the request.
    - (dict) --
      
      An array of search criteria that targets instances using a Key,Value combination that you specify.
      
      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
      - (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
      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
      - (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 EC2 instances and VPCs in your maintenance window.
      - (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
      For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
      - Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.

ListAssociationVersions (updated)

Link ¶
Changes (response)

{'AssociationVersions': {'SyncCompliance': 'AUTO | MANUAL'}}

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'
        },
    ],
    '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 a Systems Manager 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 instances using a Key,Value combination that you specify.
        
        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
        
        (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
        
        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
        
        (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 EC2 instances and VPCs in your maintenance window.
        
        (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
        
        For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
        
        Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
      
      By default, all associations use AUTO mode.
- 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 (request)

{'AssociationFilterList': {'key': {'ResourceGroupName'}}}

Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.

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.
- 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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Associations (list) --
  
  The associations.
  - (dict) --
    
    Describes an association of a Systems Manager document and an instance.
    - Name (string) --
      
      The name of the Systems Manager document.
    - InstanceId (string) --
      
      The ID of the instance.
    - 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.
    - Targets (list) --
      
      The instances targeted by the request to create an association.
      - (dict) --
        
        An array of search criteria that targets instances using a Key,Value combination that you specify.
        
        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
        
        (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
        
        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
        
        (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 EC2 instances and VPCs in your maintenance window.
        
        (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
        
        For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
        
        Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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 instances, and one of them was successful, this would return the count of instances by status.
        
        (string) --
        
        (integer) --
    - ScheduleExpression (string) --
      
      A cron expression that specifies a schedule when the association runs.
    - AssociationName (string) --
      
      The association name.
- 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.

PutComplianceItems (updated)

Link ¶
Changes (request)

{'UploadType': 'COMPLETE | PARTIAL'}

Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom: string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

See also: AWS API Documentation

Request Syntax

client.put_compliance_items(
    ResourceId='string',
    ResourceType='string',
    ComplianceType='string',
    ExecutionSummary={
        'ExecutionTime': datetime(2015, 1, 1),
        'ExecutionId': 'string',
        'ExecutionType': 'string'
    },
    Items=[
        {
            'Id': 'string',
            'Title': 'string',
            'Severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
            'Status': 'COMPLIANT'|'NON_COMPLIANT',
            'Details': {
                'string': 'string'
            }
        },
    ],
    ItemContentHash='string',
    UploadType='COMPLETE'|'PARTIAL'
)

type ResourceId:

string

param ResourceId:

[REQUIRED]

Specify an ID for this resource. For a managed instance, this is the instance ID.

type ResourceType:

string

param ResourceType:

[REQUIRED]

Specify the type of resource. ManagedInstance is currently the only supported resource type.

type ComplianceType:

string

param ComplianceType:

[REQUIRED]

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom: string.

type ExecutionSummary:

dict

param ExecutionSummary:

[REQUIRED]

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

ExecutionTime (datetime) -- [REQUIRED]

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
ExecutionId (string) --

An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.
ExecutionType (string) --

The type of execution. For example, Command is a valid execution type.

type Items:

list

param Items:

[REQUIRED]

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

(dict) --

Information about a compliance item.
- Id (string) --
  
  The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.
- Title (string) --
  
  The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.
- Severity (string) -- [REQUIRED]
  
  The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
- Status (string) -- [REQUIRED]
  
  The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
- Details (dict) --
  
  A "Key": "Value" tag combination for the compliance item.
  - (string) --
    - (string) --

type ItemContentHash:

string

param ItemContentHash:

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

type UploadType:

string

param UploadType:

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateAssociation (updated)

Link ¶
Changes (request, response)
Request

{'SyncCompliance': 'AUTO | MANUAL'}

Response

{'AssociationDescription': {'SyncCompliance': 'AUTO | MANUAL'}}

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. 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> is not 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'
)

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, 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) --
  
  (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-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 AWS 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 AWS-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 instances using a Key,Value combination that you specify.

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
- (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
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
- (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 EC2 instances and VPCs in your maintenance window.
- (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
- Key (string) --
  
  User-defined criteria for sending commands that target instances 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.
  - (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:

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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:

By default, all associations use AUTO mode.

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'
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  The description of the association that was updated.
  - Name (string) --
    
    The name of the Systems Manager document.
  - InstanceId (string) --
    
    The ID of the instance.
  - 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 instances, and one of them was successful, this would return the count of instances by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The instances targeted by the request.
    - (dict) --
      
      An array of search criteria that targets instances using a Key,Value combination that you specify.
      
      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
      - (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
      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
      - (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 EC2 instances and VPCs in your maintenance window.
      - (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
      For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
      - Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.

UpdateAssociationStatus (updated)

Link ¶
Changes (response)

{'AssociationDescription': {'SyncCompliance': 'AUTO | MANUAL'}}

Updates the status of the Systems Manager document associated with the specified instance.

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 Systems Manager document.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The ID of the instance.

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'
    }
}

Response Structure

(dict) --
- AssociationDescription (dict) --
  
  Information about the association.
  - Name (string) --
    
    The name of the Systems Manager document.
  - InstanceId (string) --
    
    The ID of the instance.
  - 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 instances, and one of them was successful, this would return the count of instances by status.
      - (string) --
        
        (integer) --
  - DocumentVersion (string) --
    
    The document version.
  - AutomationTargetParameterName (string) --
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - Parameters (dict) --
    
    A description of the parameters for a document.
    - (string) --
      - (list) --
        
        (string) --
  - AssociationId (string) --
    
    The association ID.
  - Targets (list) --
    
    The instances targeted by the request.
    - (dict) --
      
      An array of search criteria that targets instances using a Key,Value combination that you specify.
      
      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
      - (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
      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
      - (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 EC2 instances and VPCs in your maintenance window.
      - (State Manager association targets only) Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the AWS Region where the association was created.
      For information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.
      - Key (string) --
        
        User-defined criteria for sending commands that target instances 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.
        
        (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) --
        
        (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 instances 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 instance 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 instance 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.