AWS Greengrass
AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management,…
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
AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.
Endpoints 92
- GETGet associated role
/greengrass/groups/:GroupId/roleRetrieves the role associated with a particular group. - PUTAssociate role to group
/greengrass/groups/:GroupId/roleAssociates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core… - DELETEDisassociate role from group
/greengrass/groups/:GroupId/roleDisassociates the role from a group. - GETGet service role for account
/greengrass/serviceroleRetrieves the service role that is attached to your account. - PUTAssociate service role to account
/greengrass/serviceroleAssociates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for… - DELETEDisassociate service role from account
/greengrass/serviceroleDisassociates the service role from your account. Without a service role, deployments will not work. - GETList connector definitions
/greengrass/definition/connectors?MaxResults=string&NextToken=stringRetrieves a list of connector definitions. - POSTCreate connector definition
/greengrass/definition/connectorsCreates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. - GETList connector definition versions
/greengrass/definition/connectors/:ConnectorDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with… - POSTCreate connector definition version
/greengrass/definition/connectors/:ConnectorDefinitionId/versionsCreates a version of a connector definition which has already been defined. - GETList core definitions
/greengrass/definition/cores?MaxResults=string&NextToken=stringRetrieves a list of core definitions. - POSTCreate core definition
/greengrass/definition/coresCreates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass… - GETList core definition versions
/greengrass/definition/cores/:CoreDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a core definition. - POSTCreate core definition version
/greengrass/definition/cores/:CoreDefinitionId/versionsCreates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. - GETList deployments
/greengrass/groups/:GroupId/deployments?MaxResults=string&NextToken=stringReturns a history of deployments for the group. - POSTCreate deployment
/greengrass/groups/:GroupId/deploymentsCreates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. - GETList device definitions
/greengrass/definition/devices?MaxResults=string&NextToken=stringRetrieves a list of device definitions. - POSTCreate device definition
/greengrass/definition/devicesCreates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. - GETList device definition versions
/greengrass/definition/devices/:DeviceDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a device definition. - POSTCreate device definition version
/greengrass/definition/devices/:DeviceDefinitionId/versionsCreates a version of a device definition that has already been defined. - GETList function definitions
/greengrass/definition/functions?MaxResults=string&NextToken=stringRetrieves a list of Lambda function definitions. - POSTCreate function definition
/greengrass/definition/functionsCreates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial… - GETList function definition versions
/greengrass/definition/functions/:FunctionDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a Lambda function definition. - POSTCreate function definition version
/greengrass/definition/functions/:FunctionDefinitionId/versionsCreates a version of a Lambda function definition that has already been defined. - GETList groups
/greengrass/groups?MaxResults=string&NextToken=stringRetrieves a list of groups. - POSTCreate group
/greengrass/groupsCreates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup''… - GETList group certificate authorities
/greengrass/groups/:GroupId/certificateauthoritiesRetrieves the current CAs for a group. - POSTCreate group certificate authority
/greengrass/groups/:GroupId/certificateauthoritiesCreates a CA for the group. If a CA already exists, it will rotate the existing CA. - GETList group versions
/greengrass/groups/:GroupId/versions?MaxResults=string&NextToken=stringLists the versions of a group. - POSTCreate group version
/greengrass/groups/:GroupId/versionsCreates a version of a group which has already been defined. - GETList logger definitions
/greengrass/definition/loggers?MaxResults=string&NextToken=stringRetrieves a list of logger definitions. - POSTCreate logger definition
/greengrass/definition/loggersCreates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. - GETList logger definition versions
/greengrass/definition/loggers/:LoggerDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a logger definition. - POSTCreate logger definition version
/greengrass/definition/loggers/:LoggerDefinitionId/versionsCreates a version of a logger definition that has already been defined. - GETList resource definitions
/greengrass/definition/resources?MaxResults=string&NextToken=stringRetrieves a list of resource definitions. - POSTCreate resource definition
/greengrass/definition/resourcesCreates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a… - GETList resource definition versions
/greengrass/definition/resources/:ResourceDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a resource definition. - POSTCreate resource definition version
/greengrass/definition/resources/:ResourceDefinitionId/versionsCreates a version of a resource definition that has already been defined. - POSTCreate software update job
/greengrass/updatesCreates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core… - GETList subscription definitions
/greengrass/definition/subscriptions?MaxResults=string&NextToken=stringRetrieves a list of subscription definitions. - POSTCreate subscription definition
/greengrass/definition/subscriptionsCreates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a… - GETList subscription definition versions
/greengrass/definition/subscriptions/:SubscriptionDefinitionId/versions?MaxResults=string&NextToken=stringLists the versions of a subscription definition. - POSTCreate subscription definition version
/greengrass/definition/subscriptions/:SubscriptionDefinitionId/versionsCreates a version of a subscription definition which has already been defined. - GETGet connector definition
/greengrass/definition/connectors/:ConnectorDefinitionIdRetrieves information about a connector definition. - PUTUpdate connector definition
/greengrass/definition/connectors/:ConnectorDefinitionIdUpdates a connector definition. - DELETEDelete connector definition
/greengrass/definition/connectors/:ConnectorDefinitionIdDeletes a connector definition. - GETGet core definition
/greengrass/definition/cores/:CoreDefinitionIdRetrieves information about a core definition version. - PUTUpdate core definition
/greengrass/definition/cores/:CoreDefinitionIdUpdates a core definition. - DELETEDelete core definition
/greengrass/definition/cores/:CoreDefinitionIdDeletes a core definition. - GETGet device definition
/greengrass/definition/devices/:DeviceDefinitionIdRetrieves information about a device definition. - PUTUpdate device definition
/greengrass/definition/devices/:DeviceDefinitionIdUpdates a device definition. - DELETEDelete device definition
/greengrass/definition/devices/:DeviceDefinitionIdDeletes a device definition. - GETGet function definition
/greengrass/definition/functions/:FunctionDefinitionIdRetrieves information about a Lambda function definition, including its creation time and latest version. - PUTUpdate function definition
/greengrass/definition/functions/:FunctionDefinitionIdUpdates a Lambda function definition. - DELETEDelete function definition
/greengrass/definition/functions/:FunctionDefinitionIdDeletes a Lambda function definition. - GETGet group
/greengrass/groups/:GroupIdRetrieves information about a group. - PUTUpdate group
/greengrass/groups/:GroupIdUpdates a group. - DELETEDelete group
/greengrass/groups/:GroupIdDeletes a group. - GETGet logger definition
/greengrass/definition/loggers/:LoggerDefinitionIdRetrieves information about a logger definition. - PUTUpdate logger definition
/greengrass/definition/loggers/:LoggerDefinitionIdUpdates a logger definition. - DELETEDelete logger definition
/greengrass/definition/loggers/:LoggerDefinitionIdDeletes a logger definition. - GETGet resource definition
/greengrass/definition/resources/:ResourceDefinitionIdRetrieves information about a resource definition, including its creation time and latest version. - PUTUpdate resource definition
/greengrass/definition/resources/:ResourceDefinitionIdUpdates a resource definition. - DELETEDelete resource definition
/greengrass/definition/resources/:ResourceDefinitionIdDeletes a resource definition. - GETGet subscription definition
/greengrass/definition/subscriptions/:SubscriptionDefinitionIdRetrieves information about a subscription definition. - PUTUpdate subscription definition
/greengrass/definition/subscriptions/:SubscriptionDefinitionIdUpdates a subscription definition. - DELETEDelete subscription definition
/greengrass/definition/subscriptions/:SubscriptionDefinitionIdDeletes a subscription definition. - GETGet bulk deployment status
/greengrass/bulk/deployments/:BulkDeploymentId/statusReturns the status of a bulk deployment. - GETGet connectivity info
/greengrass/things/:ThingName/connectivityInfoRetrieves the connectivity information for a core. - PUTUpdate connectivity info
/greengrass/things/:ThingName/connectivityInfoUpdates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the… - GETGet connector definition version
/greengrass/definition/connectors/:ConnectorDefinitionId/versions/:ConnectorDefinitionVersionId?NextToken=stringRetrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact… - GETGet core definition version
/greengrass/definition/cores/:CoreDefinitionId/versions/:CoreDefinitionVersionIdRetrieves information about a core definition version. - GETGet deployment status
/greengrass/groups/:GroupId/deployments/:DeploymentId/statusReturns the status of a deployment. - GETGet device definition version
/greengrass/definition/devices/:DeviceDefinitionId/versions/:DeviceDefinitionVersionId?NextToken=stringRetrieves information about a device definition version. - GETGet function definition version
/greengrass/definition/functions/:FunctionDefinitionId/versions/:FunctionDefinitionVersionId?NextToken=stringRetrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. - GETGet group certificate authority
/greengrass/groups/:GroupId/certificateauthorities/:CertificateAuthorityIdRetreives the CA associated with a group. Returns the public key of the CA. - GETGet group certificate configuration
/greengrass/groups/:GroupId/certificateauthorities/configuration/expiryRetrieves the current configuration for the CA used by the group. - PUTUpdate group certificate configuration
/greengrass/groups/:GroupId/certificateauthorities/configuration/expiryUpdates the Certificate expiry time for a group. - GETGet group version
/greengrass/groups/:GroupId/versions/:GroupVersionIdRetrieves information about a group version. - GETGet logger definition version
/greengrass/definition/loggers/:LoggerDefinitionId/versions/:LoggerDefinitionVersionId?NextToken=stringRetrieves information about a logger definition version. - GETGet resource definition version
/greengrass/definition/resources/:ResourceDefinitionId/versions/:ResourceDefinitionVersionIdRetrieves information about a resource definition version, including which resources are included in the version. - GETGet subscription definition version
/greengrass/definition/subscriptions/:SubscriptionDefinitionId/versions/:SubscriptionDefinitionVersionId?NextToken=stringRetrieves information about a subscription definition version. - GETGet thing runtime configuration
/greengrass/things/:ThingName/runtimeconfigGet the runtime configuration of a thing. - PUTUpdate thing runtime configuration
/greengrass/things/:ThingName/runtimeconfigUpdates the runtime configuration of a thing. - GETList bulk deployment detailed reports
/greengrass/bulk/deployments/:BulkDeploymentId/detailed-reports?MaxResults=string&NextToken=stringGets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. - GETList bulk deployments
/greengrass/bulk/deployments?MaxResults=string&NextToken=stringReturns a list of bulk deployments. - POSTStart bulk deployment
/greengrass/bulk/deploymentsDeploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be… - GETList tags for resource
/tags/:ResourceArnRetrieves a list of resource tags for a resource arn. - POSTTag resource
/tags/:ResourceArnAdds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition',… - DELETEUntag resource
/tags/:ResourceArn?tagKeys=Remove resource tags from a Greengrass Resource. - POSTReset deployments
/greengrass/groups/:GroupId/deployments/$resetResets a group's deployments. - PUTStop bulk deployment
/greengrass/bulk/deployments/:BulkDeploymentId/$stopStops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment…
API details
- Base URL
https://greengrass.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 92 operations on 48 pathsGET 45POST 22PUT 14DELETE 11
- Description format
- AWS Smithy model, API version
2017-06-07 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Greengrass 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 Greengrass 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 associated role” (GET /greengrass/groups/:GroupId/role), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Greengrass?
AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management,… It is listed under IoT & devices and has 92 endpoints.
Who publishes the AWS Greengrass?
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 Greengrass?
Requests go to https://greengrass.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Greengrass?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Greengrass have?
92 operations on 48 paths (45 GET, 22 POST, 14 PUT, 11 DELETE).
Is forking the AWS Greengrass free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.