SSM / Paginator / DescribeInstanceAssociationsStatus

DescribeInstanceAssociationsStatus#

class SSM.Paginator.DescribeInstanceAssociationsStatus#
paginator = client.get_paginator('describe_instance_associations_status')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SSM.Client.describe_instance_associations_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • InstanceId (string) –

    [REQUIRED]

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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

}

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.