{ "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:
Create components from recipes
Create a component from a recipe, which is a file that defines the component's metadata, parameters, depend" }, { "info": { "name": "Amazon IoT Greengrass List Deployments", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/deployments", "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": "targetArn", "value": "", "type": "query", "description": "The ARN of the target IoT thing or thing group." }, { "name": "historyFilter", "value": "", "type": "query", "description": "
The filter for the list of deployments. Choose one of the following options:
ALL – The list includes all deployments.
LATEST_ONLY – The list includes only the latest revision of each deployment.
Default: LATEST_ONLY
Creates 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 devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Ev" }, { "info": { "name": "Amazon IoT Greengrass Get Component", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/components/:arn", "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": "recipeOutputFormat", "value": "", "type": "query", "description": "The format of the recipe." }, { "name": "arn", "value": "", "type": "path", "description": "The ARN of the component version." } ] }, "docs": "Gets the recipe for a version of a component." }, { "info": { "name": "Amazon IoT Greengrass Delete Component", "type": "http" }, "http": { "method": "DELETE", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/components/:arn", "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": "arn", "value": "", "type": "path", "description": "The ARN of the component version." } ] }, "docs": "
Deletes 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 component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
Retrieves metadata for a Greengrass core device.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the followin" }, { "info": { "name": "Amazon IoT Greengrass Delete Core Device", "type": "http" }, "http": { "method": "DELETE", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/:coreDeviceThingName", "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." } ] }, "docs": "Deletes 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 the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference." }, { "info": { "name": "Amazon IoT Greengrass Get Deployment", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/deployments/:deploymentId", "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": "Gets a deployment. Deployments define the components that run on Greengrass core devices." }, { "info": { "name": "Amazon IoT Greengrass Delete Deployment", "type": "http" }, "http": { "method": "DELETE", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/deployments/:deploymentId", "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": "
Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
" }, { "info": { "name": "Amazon IoT Greengrass Describe Component", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/components/:arn/metadata", "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": "arn", "value": "", "type": "path", "description": "The ARN of the component version." } ] }, "docs": "Retrieves metadata for a version of a component." }, { "info": { "name": "Amazon IoT Greengrass Get Component Version Artifact", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/components/:arn/artifacts/:artifactName", "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": "arn", "value": "", "type": "path", "description": "The ARN of the component version. Specify the ARN of a public or a Lambda component version." }, { "name": "artifactName", "value": "", "type": "path", "description": "The name of the artifact.
You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.
Retrieves connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see " }, { "info": { "name": "Amazon IoT Greengrass Update Connectivity Info", "type": "http" }, "http": { "method": "PUT", "url": "http://greengrass.{region}.amazonaws.com/greengrass/things/:thingName/connectivityInfo", "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": "thingName", "value": "", "type": "path", "description": "The name of the core device. This is also the name of the IoT thing." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Updates connectivity information for a Greengrass core device.
Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see ARN of the component." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned per paginated request." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token to be used for the next set of paginated results." } ] }, "docs": "Retrieves a paginated list of all versions for a component. Greater versions are listed first." }, { "info": { "name": "Amazon IoT Greengrass List Components", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/components", "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": "scope", "value": "", "type": "query", "description": "
The scope of the components to list.
Default: PRIVATE
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
Retrieves a paginated list of Greengrass core devices.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.
Core devices send status updates at the fo" }, { "info": { "name": "Amazon IoT Greengrass List Effective Deployments", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/:coreDeviceThingName/effectiveDeployments", "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." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned per paginated request." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token to be used for the next set of paginated results." } ] }, "docs": "Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices." }, { "info": { "name": "Amazon IoT Greengrass List Installed Components", "type": "http" }, "http": { "method": "GET", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/:coreDeviceThingName/installedComponents", "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." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned per paginated request." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token to be used for the next set of paginated results." }, { "name": "topologyFilter", "value": "", "type": "query", "description": "
The filter for the list of components. Choose from the following options:
ALL – The list includes all components installed on the core device.
ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.
Default: ROOT
Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.
IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't conne" }, { "info": { "name": "Amazon IoT Greengrass Resolve Component Candidates", "type": "http" }, "http": { "method": "POST", "url": "http://greengrass.{region}.amazonaws.com/greengrass/v2/resolveComponentCandidates", "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": "
Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2."
}
]
}
],
"bundled": true
}