DescribeManagedJobTemplate - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeManagedJobTemplate

View details of a managed job template.

Request Syntax

GET /managed-job-templates/templateName?templateVersion=templateVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

templateName

The unique name of a managed job template, which is required.

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

Required: Yes

templateVersion

An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

Pattern: ^[1-9]+.[0-9]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "description": "string", "document": "string", "documentParameters": [ { "description": "string", "example": "string", "key": "string", "optional": boolean, "regex": "string" } ], "environments": [ "string" ], "templateArn": "string", "templateName": "string", "templateVersion": "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.

description

The unique description of a managed template.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

document

The document schema for a managed job template.

Type: String

Length Constraints: Maximum length of 32768.

documentParameters

A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

Note

documentParameters can only be used when creating jobs from Amazon managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Type: Array of DocumentParameter objects

environments

A list of environments that are supported with the managed job template.

Type: Array of strings

Pattern: [^\p{C}]+

templateArn

The unique Amazon Resource Name (ARN) of the managed template.

Type: String

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

Pattern: ^arn:[!-~]+$

templateName

The unique name of a managed template, such as AWS-Reboot.

Type: String

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

templateVersion

The version for a managed template.

Type: String

Pattern: ^[1-9]+.[0-9]+

Errors

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: