CreateDeploymentRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-greengrass/refs/heads/main/json-schema/iot-greengrass-create-deployment-request-schema.json",
  "title": "CreateDeploymentRequest",
  "description": "CreateDeploymentRequest schema",
  "type": "object",
  "properties": {
    "targetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetARN"
        },
        {
          "description": "The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group."
        }
      ]
    },
    "deploymentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentNameString"
        },
        {
          "description": "The name of the deployment."
        }
      ]
    },
    "components": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentDeploymentSpecifications"
        },
        {
          "description": "The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component."
        }
      ]
    },
    "iotJobConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentIoTJobConfiguration"
        },
        {
          "description": "The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration."
        }
      ]
    },
    "deploymentPolicies": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentPolicies"
        },
        {
          "description": "The deployment policies for the deployment. These policies define how the deployment updates components and handles failure."
        }
      ]
    },
    "parentTargetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupARN"
        },
        {
          "description": "The parent deployment's target <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> within a subdeployment."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "A list of key-value pairs that contain metadata for the resource. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html\">Tag your resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientTokenString"
        },
        {
          "description": "A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours."
        }
      ]
    }
  },
  "required": [
    "targetArn"
  ]
}