[ aws . ssm ]

describe-association-execution-targets

Description

Views information about a specific execution of a specific association.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-association-execution-targets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AssociationExecutionTargets

Synopsis

  describe-association-execution-targets
--association-id <value>
--execution-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 that includes the execution for which you want to view details.

--execution-id (string)

The execution ID for which you want to view details.

--filters (list)

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

Status (EQUAL)

ResourceId (EQUAL)

ResourceType (EQUAL)

(structure)

Filters for the association execution.

Key -> (string)

The key value used in the request.

Value -> (string)

The value specified for the key.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "Status"|"ResourceId"|"ResourceType",
    "Value": "string"
  }
  ...
]

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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get details of an association execution

The following describe-association-execution-targets example describes the specified association execution.

aws ssm describe-association-execution-targets \
    --association-id "8dfe3659-4309-493a-8755-0123456789ab" \
    --execution-id "7abb6378-a4a5-4f10-8312-0123456789ab"

Output:

{
    "AssociationExecutionTargets": [
        {
            "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
            "AssociationVersion": "1",
            "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab",
            "ResourceId": "i-1234567890abcdef0",
            "ResourceType": "ManagedInstance",
            "Status": "Success",
            "DetailedStatus": "Success",
            "LastExecutionDate": 1550505538.497,
            "OutputSource": {
                "OutputSourceId": "97fff367-fc5a-4299-aed8-0123456789ab",
                "OutputSourceType": "RunCommand"
            }
        }
    ]
}

For more information, see Viewing association histories in the AWS Systems Manager User Guide.

Output

AssociationExecutionTargets -> (list)

Information about the execution.

(structure)

Includes information about the specified association execution.

AssociationId -> (string)

The association ID.

AssociationVersion -> (string)

The association version.

ExecutionId -> (string)

The execution ID.

ResourceId -> (string)

The resource ID, for example, the managed node ID where the association ran.

ResourceType -> (string)

The resource type, for example, EC2.

Status -> (string)

The association execution status.

DetailedStatus -> (string)

Detailed information about the execution status.

LastExecutionDate -> (timestamp)

The date of the last execution.

OutputSource -> (structure)

The location where the association details are saved.

OutputSourceId -> (string)

The ID of the output source, for example the URL of an S3 bucket.

OutputSourceType -> (string)

The type of source where the association execution details are stored, for example, Amazon S3.

NextToken -> (string)

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