CreateComponentVersionRequest

CreateComponentVersionRequest schema

Edge ComputingIoTLambdaMachine LearningReal-Time Processing

Properties

Name Type Description
inlineRecipe object
lambdaFunction object
tags object
clientToken object
View JSON Schema on GitHub

JSON Schema

iot-greengrass-create-component-version-request-schema.json Raw ↑
{
  "$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-component-version-request-schema.json",
  "title": "CreateComponentVersionRequest",
  "description": "CreateComponentVersionRequest schema",
  "type": "object",
  "properties": {
    "inlineRecipe": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecipeBlob"
        },
        {
          "description": "<p>The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.</p> <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>"
        }
      ]
    },
    "lambdaFunction": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LambdaFunctionRecipeSource"
        },
        {
          "description": "<p>The parameters to create a component from a Lambda function.</p> <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>"
        }
      ]
    },
    "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."
        }
      ]
    }
  }
}