# AWS IoT Greengrass V2 API

> AWS IoT Greengrass V2 API on Apizie: 29 endpoints (Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web…, Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon…, Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this…, Associates a list of client devices with a core device. Use this API operation to specify which client…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:amazonaws-greengrassv2/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-greengrassv2`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://apizie.tech/api/cloud/amazonaws-greengrassv2
- OpenAPI: https://apizie.tech/api/cloud/amazonaws-greengrassv2/openapi.json

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react…

## Endpoints

### Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-service-role-for-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/associate-service-role-to-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/disassociate-service-role-from-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Associates a list of client devices with a core device. Use this API operation to specify which client…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/batch-associate-client-device-with-core-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| body | object | yes | JSON request body |

### Disassociates a list of client devices from a core device. After you disassociate a client device from a…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/batch-disassociate-client-device-from-core-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| body | object | yes | JSON request body |

### Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/cancel-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| deploymentId | string | yes | The ID of the deployment. |

### Creates a component. Components are software that run on Greengrass core devices. After you develop and test…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/create-component-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of deployments.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| targetArn | string | no | The ARN of the target IoT thing or thing group. |
| historyFilter | string | no | The filter for the list of deployments. Choose one of the following options: ALL – The list includes all deployments. LATEST_ONLY – The… |
| parentTargetArn | string | no | The parent deployment's target ARN within a subdeployment. |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/create-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Gets the recipe for a version of a component.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| recipeOutputFormat | string | no | The format of the recipe. |
| arn | string | yes | The ARN of the component version. |

### Deletes a version of a component from IoT Greengrass. This operation deletes the component's recipe and…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/delete-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The ARN of the component version. |

### Retrieves metadata for a Greengrass core device. IoT Greengrass relies on individual devices to send status…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-core-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |

### Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/delete-core-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |

### Gets a deployment. Deployments define the components that run on Greengrass core devices.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| deploymentId | string | yes | The ID of the deployment. |

### Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/delete-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| deploymentId | string | yes | The ID of the deployment. |

### Retrieves metadata for a version of a component.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/describe-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The ARN of the component version. |

### Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-component-version-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The ARN of the component version. Specify the ARN of a public or a Lambda component version. |
| artifactName | string | yes | The name of the artifact. You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact.… |

### Retrieves connectivity information for a Greengrass core device. Connectivity information includes endpoints…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-connectivity-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the core device. This is also the name of the IoT thing. |

### Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/update-connectivity-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| body | object | yes | JSON request body |

### Retrieves a paginated list of client devices that are associated with a core device.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-client-devices-associated-with-core-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Retrieves a paginated list of all versions for a component. Greater versions are listed first.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-component-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The ARN of the component. |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Retrieves a paginated list of component summaries. This list includes components that you have permission to…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-components` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| scope | string | no | The scope of the components to list. Default: PRIVATE |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Retrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual devices to send…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-core-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingGroupArn | string | no | The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have… |
| status | string | no | The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status.… |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-effective-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |

### Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list…
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-installed-components` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| coreDeviceThingName | string | yes | The name of the core device. This is also the name of the IoT thing. |
| maxResults | integer | no | The maximum number of results to be returned per paginated request. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| topologyFilter | string | no | The filter for the list of components. Choose from the following options: ALL – The list includes all components installed on the core… |

### Retrieves the list of tags for an IoT Greengrass resource.
`GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource. |

### Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource to tag. |
| body | object | yes | JSON request body |

### Retrieves a list of components that meet the component, version, and platform requirements of a deployment.…
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/resolve-component-candidates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Removes a tag from an IoT Greengrass resource.
`POST https://apizie.tech/v1/cloud:amazonaws-greengrassv2/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource to untag. |
| tagKeys | array | yes | A list of keys for tags to remove from the resource. |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-service-role-for-account" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS IoT Greengrass V2 API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:amazonaws-greengrassv2/get-service-role-for-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS IoT Greengrass V2 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS IoT Greengrass V2 itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS IoT Greengrass V2 API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-greengrassv2.

### What is the status of the AWS IoT Greengrass V2 API?
Needs your own provider key (bring your own key)