DescribeAssociationExecutionTargetsCommand

Views information about a specific execution of a specific association.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, DescribeAssociationExecutionTargetsCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, DescribeAssociationExecutionTargetsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // DescribeAssociationExecutionTargetsRequest
  AssociationId: "STRING_VALUE", // required
  ExecutionId: "STRING_VALUE", // required
  Filters: [ // AssociationExecutionTargetsFilterList
    { // AssociationExecutionTargetsFilter
      Key: "Status" || "ResourceId" || "ResourceType", // required
      Value: "STRING_VALUE", // required
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeAssociationExecutionTargetsCommand(input);
const response = await client.send(command);
// { // DescribeAssociationExecutionTargetsResult
//   AssociationExecutionTargets: [ // AssociationExecutionTargetsList
//     { // AssociationExecutionTarget
//       AssociationId: "STRING_VALUE",
//       AssociationVersion: "STRING_VALUE",
//       ExecutionId: "STRING_VALUE",
//       ResourceId: "STRING_VALUE",
//       ResourceType: "STRING_VALUE",
//       Status: "STRING_VALUE",
//       DetailedStatus: "STRING_VALUE",
//       LastExecutionDate: new Date("TIMESTAMP"),
//       OutputSource: { // OutputSource
//         OutputSourceId: "STRING_VALUE",
//         OutputSourceType: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeAssociationExecutionTargetsCommand Input

Parameter
Type
Description
AssociationId
Required
string | undefined

The association ID that includes the execution for which you want to view details.

ExecutionId
Required
string | undefined

The execution ID for which you want to view details.

Filters
AssociationExecutionTargetsFilter[] | undefined

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

Status (EQUAL)

ResourceId (EQUAL)

ResourceType (EQUAL)

MaxResults
number | undefined

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

A token to start the list. Use this token to get the next set of results.

DescribeAssociationExecutionTargetsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AssociationExecutionTargets
AssociationExecutionTarget[] | undefined

Information about the execution.

NextToken
string | undefined

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

Throws

Name
Fault
Details
AssociationDoesNotExist
client

The specified association doesn't exist.

AssociationExecutionDoesNotExist
client

The specified execution ID doesn't exist. Verify the ID number and try again.

InternalServerError
server

An error occurred on the server side.

InvalidNextToken
client

The specified token isn't valid.

SSMServiceException
Base exception class for all service exceptions from SSM service.