SSM / Client / describe_instance_associations_status

describe_instance_associations_status#

SSM.Client.describe_instance_associations_status(**kwargs)#

The status of the associations for the managed nodes.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_associations_status(
    InstanceId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The managed node IDs for which you want association status information.

  • MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'InstanceAssociationStatusInfos': [
        {
            'AssociationId': 'string',
            'Name': 'string',
            'DocumentVersion': 'string',
            'AssociationVersion': 'string',
            'InstanceId': 'string',
            'ExecutionDate': datetime(2015, 1, 1),
            'Status': 'string',
            'DetailedStatus': 'string',
            'ExecutionSummary': 'string',
            'ErrorCode': 'string',
            'OutputUrl': {
                'S3OutputUrl': {
                    'OutputUrl': 'string'
                }
            },
            'AssociationName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InstanceAssociationStatusInfos (list) –

      Status information about the association.

      • (dict) –

        Status information about the association.

        • AssociationId (string) –

          The association ID.

        • Name (string) –

          The name of the association.

        • DocumentVersion (string) –

          The association document versions.

        • AssociationVersion (string) –

          The version of the association applied to the managed node.

        • InstanceId (string) –

          The managed node ID where the association was created.

        • ExecutionDate (datetime) –

          The date the association ran.

        • Status (string) –

          Status information about the association.

        • DetailedStatus (string) –

          Detailed status information about the association.

        • ExecutionSummary (string) –

          Summary information about association execution.

        • ErrorCode (string) –

          An error code returned by the request to create the association.

        • OutputUrl (dict) –

          A URL for an S3 bucket where you want to store the results of this request.

          • S3OutputUrl (dict) –

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

            • OutputUrl (string) –

              A URL for an S3 bucket where you want to store the results of this request.

        • AssociationName (string) –

          The name of the association applied to the managed node.

    • 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.

Exceptions

  • SSM.Client.exceptions.InternalServerError

  • SSM.Client.exceptions.InvalidInstanceId

  • SSM.Client.exceptions.InvalidNextToken