{ "opencollection": "1.0.0", "info": { "name": "AWS IoT V2 Greengrass API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Greengrass", "type": "folder" }, "items": [ { "info": { "name": "Amazon IoT Greengrass Get Service Role for Account", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/servicerole", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ] }, "docs": "Gets 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 verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide." }, { "info": { "name": "Amazon IoT Greengrass Associate Service Role to Account", "type": "http" }, "http": { "method": "PUT", "url": "http://greengrass.{region}.amazonaws.com/greengrass/servicerole", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines e" }, { "info": { "name": "Amazon IoT Greengrass Disassociate Service Role from Account", "type": "http" }, "http": { "method": "DELETE", "url": "http://greengrass.{region}.amazonaws.com/greengrass/servicerole", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ] }, "docs": "Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide." }, { "info": { "name": "Amazon IoT Greengrass Batch Associate Client Device with Core Device", "type": "http" }, "http": { "method": "POST", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/:coreDeviceThingName/associateClientDevices", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "coreDeviceThingName", "value": "", "type": "path", "description": "The name of the core device. This is also the name of the IoT thing." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Associates 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 discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer" }, { "info": { "name": "Amazon IoT Greengrass Batch Disassociate Client Device from Core Device", "type": "http" }, "http": { "method": "POST", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/:coreDeviceThingName/disassociateClientDevices", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "coreDeviceThingName", "value": "", "type": "path", "description": "The name of the core device. This is also the name of the IoT thing." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disassociates 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 cloud discovery to retrieve the core device's connectivity information and certificates." }, { "info": { "name": "Amazon IoT Greengrass Cancel Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/deployments/:deploymentId/cancel", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The ID of the deployment." } ] }, "docs": "Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device." }, { "info": { "name": "Amazon IoT Greengrass Create Component Version", "type": "http" }, "http": { "method": "POST", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/createComponentVersion", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

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: