DescribeDeviceJob
Returns information about a device job.
Request Syntax
GET /jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- JobId
-
The job's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CreatedTime": number,
"DeviceArn": "string",
"DeviceId": "string",
"DeviceName": "string",
"DeviceType": "string",
"ImageVersion": "string",
"JobId": "string",
"JobType": "string",
"Status": "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.
- CreatedTime
-
When the job was created.
Type: Timestamp
- DeviceArn
-
The device's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- DeviceId
-
The device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$ - DeviceName
-
The device's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$ - DeviceType
-
The device's type.
Type: String
Valid Values:
PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE - ImageVersion
-
For an OTA job, the target version of the device software.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^.+$ - JobId
-
The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$ - JobType
-
The job's type.
Type: String
Valid Values:
OTA | REBOOT - Status
-
The job's status.
Type: String
Valid Values:
PENDING | IN_PROGRESS | VERIFYING | REBOOTING | DOWNLOADING | COMPLETED | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
- ConflictException
-
The target resource is in use.
HTTP Status Code: 409
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The target resource was not found.
HTTP Status Code: 404
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
