DescribeExecution
Checks the status of a remote task running on one or more target devices.
Request Syntax
POST /task/taskId
/execution/managedDeviceId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- managedDeviceId
-
The ID of the managed device.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- taskId
-
The ID of the task that the action is describing.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"executionId": "string",
"lastUpdatedAt": number,
"managedDeviceId": "string",
"startedAt": number,
"state": "string",
"taskId": "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.
- executionId
-
The ID of the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- lastUpdatedAt
-
When the status of the execution was last updated.
Type: Timestamp
- managedDeviceId
-
The ID of the managed device that the task is being executed on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- startedAt
-
When the execution began.
Type: Timestamp
- state
-
The current state of the execution.
Type: String
Valid Values:
QUEUED | IN_PROGRESS | CANCELED | FAILED | SUCCEEDED | REJECTED | TIMED_OUT
- taskId
-
The ID of the task being executed on the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred while processing the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: