Amazon IoT Device Management · JSON Structure

Iot Device Management Describe Managed Job Template Response Structure

DescribeManagedJobTemplateResponse schema

Type: object Properties: 7
Device ManagementFleet ManagementIoTOTA Updates

DescribeManagedJobTemplateResponse is a JSON Structure definition published by Amazon IoT Device Management, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

templateName templateArn description templateVersion environments documentParameters document

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-structure/iot-device-management-describe-managed-job-template-response-structure.json",
  "name": "DescribeManagedJobTemplateResponse",
  "description": "DescribeManagedJobTemplateResponse schema",
  "type": "object",
  "properties": {
    "templateName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ManagedJobTemplateName"
        },
        {
          "description": "The unique name of a managed template, such as <code>AWS-Reboot</code>."
        }
      ]
    },
    "templateArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobTemplateArn"
        },
        {
          "description": "The unique Amazon Resource Name (ARN) of the managed template."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobDescription"
        },
        {
          "description": "The unique description of a managed template."
        }
      ]
    },
    "templateVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ManagedTemplateVersion"
        },
        {
          "description": "The version for a managed template."
        }
      ]
    },
    "environments": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Environments"
        },
        {
          "description": "A list of environments that are supported with the managed job template."
        }
      ]
    },
    "documentParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentParameters"
        },
        {
          "description": "<p>A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.</p> <note> <p> <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.</p> </note>"
        }
      ]
    },
    "document": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobDocument"
        },
        {
          "description": "The document schema for a managed job template."
        }
      ]
    }
  }
}