SSM / Client / describe_association_executions

describe_association_executions

SSM.Client.describe_association_executions(**kwargs)

Views all executions for a specific association ID.

See also: AWS API Documentation

Request Syntax

response = client.describe_association_executions(
    AssociationId='string',
    Filters=[
        {
            'Key': 'ExecutionId'|'Status'|'CreatedTime',
            'Value': 'string',
            'Type': 'EQUAL'|'LESS_THAN'|'GREATER_THAN'
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• AssociationId (string) –

  [REQUIRED]

  The association ID for which you want to view execution history details.

• Filters (list) –

  Filters for the request. You can specify the following filters and values.

  ExecutionId (EQUAL)

  Status (EQUAL)

  CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

  • (dict) –

    Filters used in the request.

    • Key (string) – [REQUIRED]

      The key value used in the request.

    • Value (string) – [REQUIRED]

      The value specified for the key.

    • Type (string) – [REQUIRED]

      The filter type specified in the request.

• 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) – A token to start the list. Use this token to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationExecutions': [
        {
            'AssociationId': 'string',
            'AssociationVersion': 'string',
            'ExecutionId': 'string',
            'Status': 'string',
            'DetailedStatus': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastExecutionDate': datetime(2015, 1, 1),
            'ResourceCountByStatus': 'string',
            'AlarmConfiguration': {
                'IgnorePollAlarmFailure': True|False,
                'Alarms': [
                    {
                        'Name': 'string'
                    },
                ]
            },
            'TriggeredAlarms': [
                {
                    'Name': 'string',
                    'State': 'UNKNOWN'|'ALARM'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AssociationExecutions (list) –

    A list of the executions for the specified association ID.

    • (dict) –

      Includes information about the specified association.

      • AssociationId (string) –

        The association ID.

      • AssociationVersion (string) –

        The association version.

      • ExecutionId (string) –

        The execution ID for the association.

      • Status (string) –

        The status of the association execution.

      • DetailedStatus (string) –

        Detailed status information about the execution.

      • CreatedTime (datetime) –

        The time the execution started.

      • LastExecutionDate (datetime) –

        The date of the last execution.

      • ResourceCountByStatus (string) –

        An aggregate status of the resources in the execution based on the status type.

      • 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 alarms that were invoked by 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.

  • NextToken (string) –

    The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.AssociationDoesNotExist

• SSM.Client.exceptions.InvalidNextToken