AWS.GreengrassV2 (aws-elixir v0.8.0) View Source

AWS 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 AWS IoT Core and export IoT data to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

AWS IoT Greengrass Version 2 provides a new major version of the AWS IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the AWS IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is AWS IoT Greengrass? in the AWS IoT Greengrass V2 Developer Guide.

Link to this section Summary

Functions

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

Deletes a version of a component from AWS IoT Greengrass.

Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing.

Retrieves metadata for a version of a component.

Gets the recipe for a version of a component.

Gets the pre-signed URL to download a public component artifact.

Retrieves metadata for a AWS IoT Greengrass core device.

Retrieves a paginated list of all versions for a component.

Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.

Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.

Retrieves the list of tags for an AWS IoT Greengrass resource.

Retrieves a list of components that meet the component, version, and platform requirements of a deployment.

Adds tags to an AWS IoT Greengrass resource.

Removes a tag from an AWS IoT Greengrass resource.

Link to this section Functions

Link to this function

batch_associate_client_device_with_core_device(client, core_device_thing_name, input, options \\ [])

View Source

Associate 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 AWS IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the AWS IoT Greengrass V2 Developer Guide.

Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information, see Interact with local IoT devices in the AWS IoT Greengrass V2 Developer Guide.

Link to this function

batch_disassociate_client_device_from_core_device(client, core_device_thing_name, input, options \\ [])

View Source

Disassociate 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.

Link to this function

cancel_deployment(client, deployment_id, input, options \\ [])

View Source

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.

Link to this function

create_component_version(client, input, options \\ [])

View Source

Creates a component.

Components are software that run on AWS IoT Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS 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, dependencies, lifecycle, artifacts, and platform capability. For more information, see AWS IoT Greengrass component recipe reference in the AWS IoT Greengrass V2 Developer Guide.

To create a component from a recipe, specify inlineRecipe when you call this operation.

  • Create components from Lambda functions

Create a component from an AWS Lambda function that runs on AWS IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2.

This function only accepts Lambda functions that use the following runtimes:

* Python 2.7  `python2.7`

* Python 3.7  `python3.7`

* Python 3.8  `python3.8`

* Java 8  `java8`

* Node.js 10  `nodejs10.x`

* Node.js 12  `nodejs12.x`

To create a component from a Lambda function, specify lambdaFunction when you call this operation.

Link to this function

create_deployment(client, input, options \\ [])

View Source

Creates a continuous deployment for a target, which is a AWS IoT 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, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.

Link to this function

delete_component(client, arn, input, options \\ [])

View Source

Deletes a version of a component from AWS 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.

Link to this function

delete_core_device(client, core_device_thing_name, input, options \\ [])

View Source

Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing.

This operation removes the core device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more information about how to delete the AWS IoT thing, see DeleteThing in the AWS IoT API Reference.

Link to this function

describe_component(client, arn, options \\ [])

View Source

Retrieves metadata for a version of a component.

Link to this function

get_component(client, arn, recipe_output_format \\ nil, options \\ [])

View Source

Gets the recipe for a version of a component.

Core devices can call this operation to identify the artifacts and requirements to install a component.

Link to this function

get_component_version_artifact(client, arn, artifact_name, options \\ [])

View Source

Gets the pre-signed URL to download a public component artifact.

Core devices call this operation to identify the URL that they can use to download an artifact to install.

Link to this function

get_core_device(client, core_device_thing_name, options \\ [])

View Source

Retrieves metadata for a AWS IoT Greengrass core device.

Link to this function

get_deployment(client, deployment_id, options \\ [])

View Source

Gets a deployment.

Deployments define the components that run on AWS IoT Greengrass core devices.

Link to this function

list_client_devices_associated_with_core_device(client, core_device_thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of client devices that are associated with a core device.

Link to this function

list_component_versions(client, arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of all versions for a component.

Greater versions are listed first.

Link to this function

list_components(client, max_results \\ nil, next_token \\ nil, scope \\ nil, options \\ [])

View Source

Retrieves a paginated list of component summaries.

This list includes components that you have permission to view.

Link to this function

list_core_devices(client, max_results \\ nil, next_token \\ nil, status \\ nil, thing_group_arn \\ nil, options \\ [])

View Source

Retrieves a paginated list of AWS IoT Greengrass core devices.

Link to this function

list_deployments(client, history_filter \\ nil, max_results \\ nil, next_token \\ nil, target_arn \\ nil, options \\ [])

View Source

Retrieves a paginated list of deployments.

Link to this function

list_effective_deployments(client, core_device_thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.

Link to this function

list_installed_components(client, core_device_thing_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Retrieves the list of tags for an AWS IoT Greengrass resource.

Link to this function

resolve_component_candidates(client, input, options \\ [])

View Source

Retrieves a list of components that meet the component, version, and platform requirements of a deployment.

AWS IoT 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.0.0 and component B requires version <2.0.0 of a component dependency.

When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.

To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to an AWS IoT Greengrass resource.

If a tag already exists for the resource, this operation updates the tag's value.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from an AWS IoT Greengrass resource.