describe-association-executions¶

Description¶

Use this API action to view all executions for a specific association ID.

Synopsis¶

  describe-association-executions
--association-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--association-id (string)

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)

(structure)

Filters used in the request.

Key -> (string)

The key value used in the request.

Value -> (string)

The value specified for the key.

Type -> (string)

The filter type specified in the request.

Shorthand Syntax:

Key=string,Value=string,Type=string ...

JSON Syntax:

[
  {
    "Key": "ExecutionId"|"Status"|"CreatedTime",
    "Value": "string",
    "Type": "EQUAL"|"LESS_THAN"|"GREATER_THAN"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get details of all executions for an association

This example describes all executions of the specified association.

Command:

aws ssm describe-association-executions --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Output:

{
  "AssociationExecutions": [
      {
          "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
          "AssociationVersion": "1",
          "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab",
          "Status": "Success",
          "DetailedStatus": "Success",
          "CreatedTime": 1550505827.119,
          "ResourceCountByStatus": "{Success=1}"
      },
      {
          "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
          "AssociationVersion": "1",
          "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab",
          "Status": "Success",
          "DetailedStatus": "Success",
          "CreatedTime": 1550505536.843,
          "ResourceCountByStatus": "{Success=1}"
      },
              ...
  ]
}

To get details of all executions for an association after a specific date and time

This example describes all executions of an association after the specified date and time.

Command:

aws ssm describe-association-executions --association-id "8dfe3659-4309-493a-8755-0123456789ab" --filters "Key=CreatedTime,Value=2019-02-18T16:00:00Z,Type=GREATER_THAN"

Output:

{
  "AssociationExecutions": [
      {
          "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
          "AssociationVersion": "1",
          "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab",
          "Status": "Success",
          "DetailedStatus": "Success",
          "CreatedTime": 1550505827.119,
          "ResourceCountByStatus": "{Success=1}"
      }
  ]
}

Output¶

AssociationExecutions -> (list)

A list of the executions for the specified association ID.

(structure)

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 -> (timestamp)

The time the execution started.

LastExecutionDate -> (timestamp)

The date of the last execution.

ResourceCountByStatus -> (string)

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

NextToken -> (string)

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

Table of Contents

Feedback

User Guide