SSM / Client / describe_association

describe_association

SSM.Client.describe_association(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Name (string) – The name of the SSM document.

• InstanceId (string) – The managed node ID.

• AssociationId (string) – The association ID for which you want information.

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

Return type:

dict

Returns:

Response Syntax

{
    'AssociationDescription': {
        'Name': 'string',
        'InstanceId': 'string',
        'AssociationVersion': 'string',
        'Date': datetime(2015, 1, 1),
        'LastUpdateAssociationDate': datetime(2015, 1, 1),
        'Status': {
            'Date': datetime(2015, 1, 1),
            'Name': 'Pending'|'Success'|'Failed',
            'Message': 'string',
            'AdditionalInfo': 'string'
        },
        'Overview': {
            'Status': 'string',
            'DetailedStatus': 'string',
            'AssociationStatusAggregatedCount': {
                'string': 123
            }
        },
        'DocumentVersion': 'string',
        'AutomationTargetParameterName': 'string',
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'AssociationId': 'string',
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'ScheduleExpression': 'string',
        'OutputLocation': {
            'S3Location': {
                'OutputS3Region': 'string',
                'OutputS3BucketName': 'string',
                'OutputS3KeyPrefix': 'string'
            }
        },
        'LastExecutionDate': datetime(2015, 1, 1),
        'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
        'AssociationName': 'string',
        'MaxErrors': 'string',
        'MaxConcurrency': 'string',
        'ComplianceSeverity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'UNSPECIFIED',
        'SyncCompliance': 'AUTO'|'MANUAL',
        'ApplyOnlyAtCronInterval': True|False,
        'CalendarNames': [
            'string',
        ],
        'TargetLocations': [
            {
                'Accounts': [
                    'string',
                ],
                'Regions': [
                    'string',
                ],
                'TargetLocationMaxConcurrency': 'string',
                'TargetLocationMaxErrors': 'string',
                'ExecutionRoleName': 'string',
                'TargetLocationAlarmConfiguration': {
                    'IgnorePollAlarmFailure': True|False,
                    'Alarms': [
                        {
                            'Name': 'string'
                        },
                    ]
                }
            },
        ],
        'ScheduleOffset': 123,
        'TargetMaps': [
            {
                'string': [
                    'string',
                ]
            },
        ],
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

• (dict) –

  • AssociationDescription (dict) –

    Information about the association.

    • Name (string) –

      The name of the SSM document.

    • InstanceId (string) –

      The managed node ID.

    • AssociationVersion (string) –

      The association version.

    • Date (datetime) –

      The date when the association was made.

    • LastUpdateAssociationDate (datetime) –

      The date when the association was last updated.

    • Status (dict) –

      The association status.

      • Date (datetime) –

        The date when the status changed.

      • Name (string) –

        The status.

      • Message (string) –

        The reason for the status.

      • AdditionalInfo (string) –

        A user-defined string.

    • Overview (dict) –

      Information about the association.

      • Status (string) –

        The status of the association. Status can be: Pending, Success, or Failed.

      • DetailedStatus (string) –

        A detailed status of the association.

      • AssociationStatusAggregatedCount (dict) –

        Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.

        • (string) –

          • (integer) –

    • DocumentVersion (string) –

      The document version.

    • AutomationTargetParameterName (string) –

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

    • Parameters (dict) –

      A description of the parameters for a document.

      • (string) –

        • (list) –

          • (string) –

    • AssociationId (string) –

      The association ID.

    • Targets (list) –

      The managed nodes targeted by the request.

      • (dict) –

        An array of search criteria that targets managed nodes using a key-value pair that you specify.

        Note

        One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

        Supported formats include the following.

        • Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>

        • Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

        • Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

        • Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>

        • Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

        • Automation targets only: Key=ResourceGroup;Values=<resource-group-name>

        For example:

        • Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

        • Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

        • Key=tag-key,Values=Name,Instance-Type,CostCenter

        • Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

        • Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.

        • Automation targets only: Key=ResourceGroup,Values=MyResourceGroup

        • State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.

        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

        • Key (string) –

          User-defined criteria for sending commands that target managed nodes that meet the criteria.

        • Values (list) –

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

          Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

          • (string) –

    • ScheduleExpression (string) –

      A cron expression that specifies a schedule when the association runs.

    • OutputLocation (dict) –

      An S3 bucket where you want to store the output details of the request.

      • S3Location (dict) –

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

        • OutputS3Region (string) –

          The Amazon Web Services Region of the S3 bucket.

        • OutputS3BucketName (string) –

          The name of the S3 bucket.

        • OutputS3KeyPrefix (string) –

          The S3 bucket subfolder.

    • LastExecutionDate (datetime) –

      The date on which the association was last run.

    • LastSuccessfulExecutionDate (datetime) –

      The last date on which the association was successfully run.

    • AssociationName (string) –

      The association name.

    • MaxErrors (string) –

      The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

      Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    • MaxConcurrency (string) –

      The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

      If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

    • ComplianceSeverity (string) –

      The severity level that is assigned to the association.

    • SyncCompliance (string) –

      The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn’t run successfully, the association is NON-COMPLIANT.

      In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

    • ApplyOnlyAtCronInterval (boolean) –

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

    • CalendarNames (list) –

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

      • (string) –

    • TargetLocations (list) –

      The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

      • (dict) –

        The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

        • Accounts (list) –

          The Amazon Web Services accounts targeted by the current Automation execution.

          • (string) –

        • Regions (list) –

          The Amazon Web Services Regions targeted by the current Automation execution.

          • (string) –

        • TargetLocationMaxConcurrency (string) –

          The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

        • TargetLocationMaxErrors (string) –

          The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

        • ExecutionRoleName (string) –

          The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

        • TargetLocationAlarmConfiguration (dict) –

          The details for the CloudWatch alarm you want to apply to an automation or command.

          • IgnorePollAlarmFailure (boolean) –

            When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

          • Alarms (list) –

            The name of the CloudWatch alarm specified in the configuration.

            • (dict) –

              A CloudWatch alarm you apply to an automation or command.

              • Name (string) –

                The name of your CloudWatch alarm.

    • ScheduleOffset (integer) –

      Number of days to wait after the scheduled day to run an association.

    • TargetMaps (list) –

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

      • (dict) –

        • (string) –

          • (list) –

            • (string) –

    • AlarmConfiguration (dict) –

      The details for the CloudWatch alarm you want to apply to an automation or command.

      • IgnorePollAlarmFailure (boolean) –

        When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

      • Alarms (list) –

        The name of the CloudWatch alarm specified in the configuration.

        • (dict) –

          A CloudWatch alarm you apply to an automation or command.

          • Name (string) –

            The name of your CloudWatch alarm.

    • TriggeredAlarms (list) –

      The CloudWatch alarm that was invoked during the association.

      • (dict) –

        The details about the state of your CloudWatch alarm.

        • Name (string) –

          The name of your CloudWatch alarm.

        • State (string) –

          The state of your CloudWatch alarm.

Exceptions

• SSM.Client.exceptions.AssociationDoesNotExist

• SSM.Client.exceptions.InvalidAssociationVersion

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.InvalidDocument

• SSM.Client.exceptions.InvalidInstanceId