GreengrassV2Client
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.
Functions
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 equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
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 Guide.
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.
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.
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.
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.
Deletes a version of a component from IoT Greengrass.
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.
Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Retrieves metadata for a version of a component.
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.
Gets the recipe for a version of a component.
Gets 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 download an artifact to install.
Retrieves connectivity information for a Greengrass core device.
Retrieves metadata for a Greengrass core device.
Gets a deployment. Deployments define the components that run on Greengrass core devices.
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.
Retrieves a paginated list of client devices that are associated with a core device.
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
Retrieves a paginated list of all versions for a component. Greater versions are listed first.
Retrieves a paginated list of Greengrass core devices.
Retrieves a paginated list of deployments.
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
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.
Retrieves the list of tags for an IoT Greengrass resource.
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.
Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
Removes a tag from an IoT Greengrass resource.
Updates connectivity information for a Greengrass core device.
Inherited functions
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 equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
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 Guide.
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.
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.
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.
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.
Deletes a version of a component from IoT Greengrass.
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.
Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.
Retrieves metadata for a version of a component.
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.
Gets the recipe for a version of a component.
Gets 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 download an artifact to install.
Retrieves connectivity information for a Greengrass core device.
Retrieves metadata for a Greengrass core device.
Gets a deployment. Deployments define the components that run on Greengrass core devices.
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.
Retrieves a paginated list of client devices that are associated with a core device.
Paginate over ListClientDevicesAssociatedWithCoreDeviceResponse results.
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
Paginate over ListComponentsResponse results.
Retrieves a paginated list of all versions for a component. Greater versions are listed first.
Paginate over ListComponentVersionsResponse results.
Retrieves a paginated list of Greengrass core devices.
Paginate over ListCoreDevicesResponse results.
Retrieves a paginated list of deployments.
Paginate over ListDeploymentsResponse results.
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
Paginate over ListEffectiveDeploymentsResponse results.
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.
Paginate over ListInstalledComponentsResponse results.
Retrieves the list of tags for an IoT Greengrass resource.
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.
Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
Removes a tag from an IoT Greengrass resource.
Updates connectivity information for a Greengrass core device.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.