List all command executions.
Important
-
You must provide only the
startedTimeFilteror thecompletedTimeFilterinformation. If you provide both time filters, the API will generate an error. You can use this information to retrieve a list of command executions within a specific timeframe. -
You must provide only the
commandArnor thethingArninformation depending on whether you want to list executions for a specific command or an IoT thing. If you provide both fields, the API will generate an error.
For more information about considerations for using this API, see List command executions in your account (CLI).
Request Syntax
POST /command-executions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json
{
"commandArn": "string",
"completedTimeFilter": {
"after": "string",
"before": "string"
},
"namespace": "string",
"sortOrder": "string",
"startedTimeFilter": {
"after": "string",
"before": "string"
},
"status": "string",
"targetArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return in this operation.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwisenullto receive the first set of results.
Request Body
The request accepts the following data in JSON format.
- commandArn
-
The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.
Type: String
Required: No
- completedTimeFilter
-
List all command executions that completed any time before or after the date and time that you specify. The date and time uses the format
yyyy-MM-dd'T'HH:mm.Type: TimeFilter object
Required: No
- namespace
-
The namespace of the command.
Type: String
Valid Values:
AWS-IoT | AWS-IoT-FleetWiseRequired: No
- sortOrder
-
Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the
startTimeFilterandcompleteTimeFilterparameters.Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
- startedTimeFilter
-
List all command executions that started any time before or after the date and time that you specify. The date and time uses the format
yyyy-MM-dd'T'HH:mm.Type: TimeFilter object
Required: No
- status
-
List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.
Type: String
Valid Values:
CREATED | IN_PROGRESS | SUCCEEDED | FAILED | REJECTED | TIMED_OUTRequired: No
- targetArn
-
The Amazon Resource Number (ARN) of the target device. You can use this information to list all command executions for a particular device.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"commandExecutions": [
{
"commandArn": "string",
"completedAt": number,
"createdAt": number,
"executionId": "string",
"startedAt": number,
"status": "string",
"targetArn": "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.
- commandExecutions
-
The list of command executions.
Type: Array of CommandExecutionSummary objects
- nextToken
-
The token to use to get the next set of results, or
nullif there are no additional results.Type: String
Errors
- InternalServerException
-
Internal error from the service that indicates an unexpected error or that the service is unavailable.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- ValidationException
-
The request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
