AWS IoT Greengrass V2
IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 autonomously to local events, and communicate securely with each other on
local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data
to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and
deploy applications to fleets of edge devices for local operation.
IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console.
Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components,
manage deployments, and core devices.
For more information, see What is IoT Greengrass? in the
IoT Greengrass V2 Developer Guide .
Endpoints 29
- GETGet service role for account
/greengrass/serviceroleGets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to… - PUTAssociate service role to account
/greengrass/serviceroleAssociates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this… - DELETEDisassociate service role from account
/greengrass/serviceroleDisassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role,… - POSTBatch associate client device with core device
/greengrass/v2/coreDevices/:coreDeviceThingName/associateClientDevicesAssociates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud… - POSTBatch disassociate client device from core device
/greengrass/v2/coreDevices/:coreDeviceThingName/disassociateClientDevicesDisassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use… - POSTCancel deployment
/greengrass/v2/deployments/:deploymentId/cancelCancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this… - POSTCreate component version
/greengrass/v2/createComponentVersionCreates 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… - GETList deployments
/greengrass/v2/deployments?targetArn=string&historyFilter=string&parentTargetArn=string&maxResults=0&nextToken=stringRetrieves a paginated list of deployments. - POSTCreate deployment
/greengrass/v2/deploymentsCreates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core… - GETGet component
/greengrass/v2/components/:arn?recipeOutputFormat=stringGets the recipe for a version of a component. - DELETEDelete component
/greengrass/v2/components/:arnDeletes a version of a component from IoT Greengrass. This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this… - GETGet core device
/greengrass/v2/coreDevices/:coreDeviceThingNameRetrieves metadata for a Greengrass core device. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the… - DELETEDelete core device
/greengrass/v2/coreDevices/:coreDeviceThingNameDeletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete… - GETGet deployment
/greengrass/v2/deployments/:deploymentIdGets a deployment. Deployments define the components that run on Greengrass core devices. - DELETEDelete deployment
/greengrass/v2/deployments/:deploymentIdDeletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment . Deleting a deployment doesn't… - GETDescribe component
/greengrass/v2/components/:arn/metadataRetrieves metadata for a version of a component. - GETGet component version artifact
/greengrass/v2/components/:arn/artifacts/:artifactName?s3EndpointType=stringGets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to… - GETGet connectivity info
/greengrass/things/:thingName/connectivityInfoRetrieves connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an… - PUTUpdate connectivity info
/greengrass/things/:thingName/connectivityInfoUpdates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an… - GETList client devices associated with core device
/greengrass/v2/coreDevices/:coreDeviceThingName/associatedClientDevices?maxResults=0&nextToken=stringRetrieves a paginated list of client devices that are associated with a core device. - GETList component versions
/greengrass/v2/components/:arn/versions?maxResults=0&nextToken=stringRetrieves a paginated list of all versions for a component. Greater versions are listed first. - GETList components
/greengrass/v2/components?scope=string&maxResults=0&nextToken=stringRetrieves a paginated list of component summaries. This list includes components that you have permission to view. - GETList core devices
/greengrass/v2/coreDevices?thingGroupArn=string&status=string&maxResults=0&nextToken=string&runtime=stringRetrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If… - GETList effective deployments
/greengrass/v2/coreDevices/:coreDeviceThingName/effectiveDeployments?maxResults=0&nextToken=stringRetrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices. - GETList installed components
/greengrass/v2/coreDevices/:coreDeviceThingName/installedComponents?maxResults=0&nextToken=string&topologyFilter=stringRetrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as… - GETList tags for resource
/tags/:resourceArnRetrieves the list of tags for an IoT Greengrass resource. - POSTTag resource
/tags/:resourceArnAdds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag from an IoT Greengrass resource. - POSTResolve component candidates
/greengrass/v2/resolveComponentCandidatesRetrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when…
API details
- Base URL
https://greengrass.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 29 operations on 20 pathsGET 15POST 7DELETE 5PUT 2
- Description format
- AWS Smithy model, API version
2020-11-30 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS IoT Greengrass V2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Greengrass V2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get service role for account” (GET /greengrass/servicerole), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS IoT Greengrass V2?
IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and… It is listed under IoT & devices and has 29 endpoints.
Who publishes the AWS IoT Greengrass V2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS IoT Greengrass V2?
Requests go to https://greengrass.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS IoT Greengrass V2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS IoT Greengrass V2 have?
29 operations on 20 paths (15 GET, 7 POST, 5 DELETE, 2 PUT).
Is forking the AWS IoT Greengrass V2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.