DescribeTask
Checks the metadata for a given task on a device.
Request Syntax
POST /task/taskId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- taskId
-
The ID of the task to be described.
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
{
"completedAt": number,
"createdAt": number,
"description": "string",
"lastUpdatedAt": number,
"state": "string",
"tags": {
"string" : "string"
},
"targets": [ "string" ],
"taskArn": "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.
- completedAt
-
When the task was completed.
Type: Timestamp
- createdAt
-
When the
CreateTaskoperation was called.Type: Timestamp
- description
-
The description provided of the task and managed devices.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[A-Za-z0-9 _.,!#]*$ - lastUpdatedAt
-
When the state of the task was last updated.
Type: Timestamp
- state
-
The current state of the task.
Type: String
Valid Values:
IN_PROGRESS | CANCELED | COMPLETED -
Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.
Type: String to string map
- targets
-
The managed devices that the task was sent to.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
- taskArn
-
The Amazon Resource Name (ARN) of the task.
Type: String
- taskId
-
The ID of the task.
Type: String
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:
