DescribeNodeFromTemplateJob
Returns information about a job to create a camera stream node.
Request Syntax
GET /packages/template-job/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,
"JobId": "string",
"JobTags": [
{
"ResourceType": "string",
"Tags": {
"string" : "string"
}
}
],
"LastUpdatedTime": number,
"NodeDescription": "string",
"NodeName": "string",
"OutputPackageName": "string",
"OutputPackageVersion": "string",
"Status": "string",
"StatusMessage": "string",
"TemplateParameters": {
"string" : "string"
},
"TemplateType": "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
- JobId
-
The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$ - JobTags
-
The job's tags.
Type: Array of JobResourceTags objects
- LastUpdatedTime
-
When the job was updated.
Type: Timestamp
- NodeDescription
-
The node's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^.*$ - NodeName
-
The node's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-\_]+$ - OutputPackageName
-
The job's output package name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-\_]+$ - OutputPackageVersion
-
The job's output package version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^([0-9]+)\.([0-9]+)$ - Status
-
The job's status.
Type: String
Valid Values:
PENDING | SUCCEEDED | FAILED - StatusMessage
-
The job's status message.
Type: String
- TemplateParameters
-
The job's template parameters.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern:
^.+$Value Length Constraints: Minimum length of 1. Maximum length of 255.
Value Pattern:
^.+$ - TemplateType
-
The job's template type.
Type: String
Valid Values:
RTSP_CAMERA_STREAM
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
- 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:
