SSM / Client / describe_effective_instance_associations

describe_effective_instance_associations#

SSM.Client.describe_effective_instance_associations(**kwargs)#

All associations for the managed node(s).

See also: AWS API Documentation

Request Syntax

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

  • InstanceId (string) –

    [REQUIRED]

    The managed node ID for which you want to view all associations.

  • 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

{
    'Associations': [
        {
            'AssociationId': 'string',
            'InstanceId': 'string',
            'Content': 'string',
            'AssociationVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Associations (list) –

      The associations for the requested managed node.

      • (dict) –

        One or more association documents on the managed node.

        • AssociationId (string) –

          The association ID.

        • InstanceId (string) –

          The managed node ID.

        • Content (string) –

          The content of the association document for the managed node(s).

        • AssociationVersion (string) –

          Version information for the association on 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