Amazon IoT Greengrass · JSON Structure

Iot Greengrass Create Deployment Request Structure

CreateDeploymentRequest schema

Type: object Properties: 8 Required: 1
Edge ComputingIoTLambdaMachine-LearningReal-Time Processing

CreateDeploymentRequest is a JSON Structure definition published by Amazon IoT Greengrass, describing 8 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

targetArn deploymentName components iotJobConfiguration deploymentPolicies parentTargetArn tags clientToken

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-greengrass/refs/heads/main/json-structure/iot-greengrass-create-deployment-request-structure.json",
  "name": "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"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/iot-greengrass-create-deployment-request-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.