Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateNodeFromTemplateJob

Creates a camera stream node.

Request Syntax


POST /packages/template-job HTTP/1.1
Content-type: application/json

{
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NodeDescription": "string",
   "NodeName": "string",
   "OutputPackageName": "string",
   "OutputPackageVersion": "string",
   "TemplateParameters": { 
      "string" : "string" 
   },
   "TemplateType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

JobTags

Tags for the job.

Type: Array of JobResourceTags objects

Required: No

NodeDescription

A description for the node.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^.*$

Required: No

NodeName

A name for the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

OutputPackageName

An output package name for the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

OutputPackageVersion

An output package version for the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^([0-9]+)\.([0-9]+)$

Required: Yes

TemplateParameters

Template parameters for the node.

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: ^.+$

Required: Yes

TemplateType

The type of node.

Type: String

Valid Values: RTSP_CAMERA_STREAM

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "JobId": "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.

JobId

The job's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

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