Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListExecutions

List all of the executions available for the current user.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Pattern: [A-Za-z0-9\-_]*={0,3}

Required: No

Response Syntax


{
   "executionList": [ 
      { 
         "creationTime": number,
         "executionId": "string",
         "requesterArn": "string",
         "requesterId": "string",
         "requestState": "string",
         "roleArn": "string",
         "status": "string",
         "storageRegion": "string",
         "targetRegions": [ "string" ],
         "toolId": "string",
         "toolVersionId": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

executionList

Array of Execution objects

Type: Array of ExecutionSummary objects

nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Pattern: [A-Za-z0-9\-_]*={0,3}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request failed because of an internal error. Try your request again later

HTTP Status Code: 500

ThrottlingException

The request failed because it exceeded a throttling quota.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

This example illustrates one usage of ListExecutions.

Example

Using AWS JSON protocol (default)

Sample Request



POST / HTTP/1.1
Host: ts.us-east-2.amazonaws.com
X-Amz-Target: Troubleshooting.ListExecutions
Content-Type: application/x-amz-json-1.0
X-Amz-Date: <Date>
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
    "maxResults": 2
}

Sample Response



HTTP/1.1 200 OK
x-amzn-RequestId: <requestId>
Content-Length: 0
Date: <Date>
Content-Type: application/x-amz-json-1.0
{
    "nextToken": "nextTokenToRetrieveNextPage",
    "executionList": [
        {
            "creationTime": 1699927.553,
            "executionId": "e-aaaaaaaaa",
            "requestState": "SUBMITTED",
            "requesterArn": "<requester iam arn>",
            "requesterId": "<requester iam arn>",
            "roleArn": "<pass role>",
            "status": "SUCCESSFUL",
            "storageRegion": "us-east-2",
            "targetRegions": [
            "us-east-1"
            ],
            "toolId": "EC2SystemsManager",
            "toolVersionId": "1.0.0"
        },
        {
            "creationTime": 1699927.553,
            "executionId": "e-bbbbbbbb",
            "requestState": "SUBMITTED",
            "requesterArn": "<requester iam arn>",
            "requesterId": "<requester iam arn>",
            "roleArn": "<pass role>",
            "status": "SUCCESSFUL",
            "storageRegion": "us-east-1",
            "targetRegions": [
            "us-west-2"
            ],
            "toolId": "EC2SystemsManager",
            "toolVersionId": "1.0.1"
        }
    ]
}