Own AWS? Customize your docs with AI search, analytics, and more.

POST

/greengrass/v2/createComponentVersion

http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following: <ul> <li> Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html">IoT Greengrass component recipe reference</a> in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify <code>inlineRecipe</code> when you call this operation. </li> <li> Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes: <ul> <li> Python 2.7 – <code>python2.7</code> </li> <li> Python 3.7 – <code>python3.7</code> </li> <li> Python 3.8 – <code>python3.8</code> </li> <li> Python 3.9 – <code>python3.9</code> </li> <li> Java 8 – <code>java8</code> </li> <li> Java 11 – <code>java11</code> </li> <li> Node.js 10 – <code>nodejs10.x</code> </li> <li> Node.js 12 – <code>nodejs12.x</code> </li> <li> Node.js 14 – <code>nodejs14.x</code> </li> </ul> To create a component from a Lambda function, specify <code>lambdaFunction</code> when you call this operation. <note> IoT Greengrass currently supports Lambda functions on only Linux core devices. </note> </li> </ul>

Access Token Required: API Key

Body Params

tagsobject

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 IoT Greengrass V2 Developer Guide.

clientTokenstring

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.

inlineRecipestring

The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.

lambdaFunctionobject

Contains information about an Lambda function to import to create a component.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/greengrass/v2/createComponentVersion

http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following: <ul> <li> Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html">IoT Greengrass component recipe reference</a> in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify <code>inlineRecipe</code> when you call this operation. </li> <li> Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes: <ul> <li> Python 2.7 – <code>python2.7</code> </li> <li> Python 3.7 – <code>python3.7</code> </li> <li> Python 3.8 – <code>python3.8</code> </li> <li> Python 3.9 – <code>python3.9</code> </li> <li> Java 8 – <code>java8</code> </li> <li> Java 11 – <code>java11</code> </li> <li> Node.js 10 – <code>nodejs10.x</code> </li> <li> Node.js 12 – <code>nodejs12.x</code> </li> <li> Node.js 14 – <code>nodejs14.x</code> </li> </ul> To create a component from a Lambda function, specify <code>lambdaFunction</code> when you call this operation. <note> IoT Greengrass currently supports Lambda functions on only Linux core devices. </note> </li> </ul>

Access Token Required: API Key

Body Params

tagsobject

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 IoT Greengrass V2 Developer Guide.

clientTokenstring

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.

inlineRecipestring

The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.

lambdaFunctionobject

Contains information about an Lambda function to import to create a component.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/greengrass/v2/createComponentVersion

http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following: <ul> <li> Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html">IoT Greengrass component recipe reference</a> in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify <code>inlineRecipe</code> when you call this operation. </li> <li> Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes: <ul> <li> Python 2.7 – <code>python2.7</code> </li> <li> Python 3.7 – <code>python3.7</code> </li> <li> Python 3.8 – <code>python3.8</code> </li> <li> Python 3.9 – <code>python3.9</code> </li> <li> Java 8 – <code>java8</code> </li> <li> Java 11 – <code>java11</code> </li> <li> Node.js 10 – <code>nodejs10.x</code> </li> <li> Node.js 12 – <code>nodejs12.x</code> </li> <li> Node.js 14 – <code>nodejs14.x</code> </li> </ul> To create a component from a Lambda function, specify <code>lambdaFunction</code> when you call this operation. <note> IoT Greengrass currently supports Lambda functions on only Linux core devices. </note> </li> </ul>

Access Token Required: API Key

Body Params

tagsobject

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 IoT Greengrass V2 Developer Guide.

clientTokenstring

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.

inlineRecipestring

The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.

lambdaFunctionobject

Contains information about an Lambda function to import to create a component.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/greengrass/v2/createComponentVersion

http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following: <ul> <li> Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html">IoT Greengrass component recipe reference</a> in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify <code>inlineRecipe</code> when you call this operation. </li> <li> Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes: <ul> <li> Python 2.7 – <code>python2.7</code> </li> <li> Python 3.7 – <code>python3.7</code> </li> <li> Python 3.8 – <code>python3.8</code> </li> <li> Python 3.9 – <code>python3.9</code> </li> <li> Java 8 – <code>java8</code> </li> <li> Java 11 – <code>java11</code> </li> <li> Node.js 10 – <code>nodejs10.x</code> </li> <li> Node.js 12 – <code>nodejs12.x</code> </li> <li> Node.js 14 – <code>nodejs14.x</code> </li> </ul> To create a component from a Lambda function, specify <code>lambdaFunction</code> when you call this operation. <note> IoT Greengrass currently supports Lambda functions on only Linux core devices. </note> </li> </ul>

Access Token Required: API Key

Body Params

tagsobject

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 IoT Greengrass V2 Developer Guide.

clientTokenstring

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.

inlineRecipestring

The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility. You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.

lambdaFunctionobject

Contains information about an Lambda function to import to create a component.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}