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

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.

Link to this section Summary

Functions

Creates a version of a connector definition which has already been defined.

Creates a version of a core definition that has already been defined.

Creates a version of a device definition that has already been defined.

Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.

Creates a version of a Lambda function definition that has already been defined.

Creates a version of a group which has already been defined.

Creates a version of a logger definition that has already been defined.

Creates a resource definition which contains a list of resources to be used in a group.

Creates a version of a resource definition that has already been defined.

Creates 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 software.

Creates a version of a subscription definition which has already been defined.

Disassociates the service role from your account.

Retrieves the role associated with a particular group.

Retrieves the connectivity information for a core.

Retrieves information about a connector definition.

Retrieves information about a connector definition version, including the connectors that the version contains.

Retrieves information about a core definition version.

Retrieves information about a device definition.

Retrieves information about a Lambda function definition, including its creation time and latest version.

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Retrieves information about a group.

Retrieves the current configuration for the CA used by the group.

Retrieves information about a group version.

Retrieves information about a logger definition.

Retrieves information about a resource definition, including its creation time and latest version.

Retrieves information about a resource definition version, including which resources are included in the version.

Retrieves the service role that is attached to your account.

Retrieves information about a subscription definition.

Get the runtime configuration of a thing.

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Lists the versions of a connector definition, which are containers for connectors.

Retrieves a list of resource tags for a resource arn.

Deploys multiple groups in one operation.

Adds tags to a Greengrass resource.

Remove resource tags from a Greengrass Resource.

Updates the connectivity information for the core.

Link to this section Functions

Link to this function

associate_role_to_group(client, group_id, input, options \\ [])

View Source

Associates 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 Lambda functions to perform actions against the cloud.

Link to this function

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

View Source

Associates 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 deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

Link to this function

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

View Source

Creates a connector definition.

You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

Link to this function

create_connector_definition_version(client, connector_definition_id, input, options \\ [])

View Source

Creates a version of a connector definition which has already been defined.

Link to this function

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

View Source

Creates a core definition.

You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

Link to this function

create_core_definition_version(client, core_definition_id, input, options \\ [])

View Source

Creates a version of a core definition that has already been defined.

Greengrass groups must each contain exactly one Greengrass core.

Link to this function

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

View Source

Creates a deployment.

''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Link to this function

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

View Source

Creates a device definition.

You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.

Link to this function

create_device_definition_version(client, device_definition_id, input, options \\ [])

View Source

Creates a version of a device definition that has already been defined.

Link to this function

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

View Source

Creates 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 version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later.

Link to this function

create_function_definition_version(client, function_definition_id, input, options \\ [])

View Source

Creates a version of a Lambda function definition that has already been defined.

Link to this function

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

View Source

Creates 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'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

Link to this function

create_group_certificate_authority(client, group_id, input, options \\ [])

View Source

Creates a CA for the group.

If a CA already exists, it will rotate the existing CA.

Link to this function

create_group_version(client, group_id, input, options \\ [])

View Source

Creates a version of a group which has already been defined.

Link to this function

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

View Source

Creates a logger definition.

You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.

Link to this function

create_logger_definition_version(client, logger_definition_id, input, options \\ [])

View Source

Creates a version of a logger definition that has already been defined.

Link to this function

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

View Source

Creates 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 list of resources now, or use ''CreateResourceDefinitionVersion'' later.

Link to this function

create_resource_definition_version(client, resource_definition_id, input, options \\ [])

View Source

Creates a version of a resource definition that has already been defined.

Link to this function

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

View Source

Creates 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 software.

It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Link to this function

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

View Source

Creates a subscription definition.

You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.

Link to this function

create_subscription_definition_version(client, subscription_definition_id, input, options \\ [])

View Source

Creates a version of a subscription definition which has already been defined.

Link to this function

delete_connector_definition(client, connector_definition_id, input, options \\ [])

View Source

Deletes a connector definition.

Link to this function

delete_core_definition(client, core_definition_id, input, options \\ [])

View Source

Deletes a core definition.

Link to this function

delete_device_definition(client, device_definition_id, input, options \\ [])

View Source

Deletes a device definition.

Link to this function

delete_function_definition(client, function_definition_id, input, options \\ [])

View Source

Deletes a Lambda function definition.

Link to this function

delete_group(client, group_id, input, options \\ [])

View Source

Deletes a group.

Link to this function

delete_logger_definition(client, logger_definition_id, input, options \\ [])

View Source

Deletes a logger definition.

Link to this function

delete_resource_definition(client, resource_definition_id, input, options \\ [])

View Source

Deletes a resource definition.

Link to this function

delete_subscription_definition(client, subscription_definition_id, input, options \\ [])

View Source

Deletes a subscription definition.

Link to this function

disassociate_role_from_group(client, group_id, input, options \\ [])

View Source

Disassociates the role from a group.

Link to this function

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

View Source

Disassociates the service role from your account.

Without a service role, deployments will not work.

Link to this function

get_associated_role(client, group_id, options \\ [])

View Source

Retrieves the role associated with a particular group.

Link to this function

get_bulk_deployment_status(client, bulk_deployment_id, options \\ [])

View Source

Returns the status of a bulk deployment.

Link to this function

get_connectivity_info(client, thing_name, options \\ [])

View Source

Retrieves the connectivity information for a core.

Link to this function

get_connector_definition(client, connector_definition_id, options \\ [])

View Source

Retrieves information about a connector definition.

Link to this function

get_connector_definition_version(client, connector_definition_id, connector_definition_version_id, next_token \\ nil, options \\ [])

View Source

Retrieves information about a connector definition version, including the connectors that the version contains.

Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

Link to this function

get_core_definition(client, core_definition_id, options \\ [])

View Source

Retrieves information about a core definition version.

Link to this function

get_core_definition_version(client, core_definition_id, core_definition_version_id, options \\ [])

View Source

Retrieves information about a core definition version.

Link to this function

get_deployment_status(client, deployment_id, group_id, options \\ [])

View Source

Returns the status of a deployment.

Link to this function

get_device_definition(client, device_definition_id, options \\ [])

View Source

Retrieves information about a device definition.

Link to this function

get_device_definition_version(client, device_definition_id, device_definition_version_id, next_token \\ nil, options \\ [])

View Source

Retrieves information about a device definition version.

Link to this function

get_function_definition(client, function_definition_id, options \\ [])

View Source

Retrieves information about a Lambda function definition, including its creation time and latest version.

Link to this function

get_function_definition_version(client, function_definition_id, function_definition_version_id, next_token \\ nil, options \\ [])

View Source

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Link to this function

get_group(client, group_id, options \\ [])

View Source

Retrieves information about a group.

Link to this function

get_group_certificate_authority(client, certificate_authority_id, group_id, options \\ [])

View Source

Retreives the CA associated with a group.

Returns the public key of the CA.

Link to this function

get_group_certificate_configuration(client, group_id, options \\ [])

View Source

Retrieves the current configuration for the CA used by the group.

Link to this function

get_group_version(client, group_id, group_version_id, options \\ [])

View Source

Retrieves information about a group version.

Link to this function

get_logger_definition(client, logger_definition_id, options \\ [])

View Source

Retrieves information about a logger definition.

Link to this function

get_logger_definition_version(client, logger_definition_id, logger_definition_version_id, next_token \\ nil, options \\ [])

View Source

Retrieves information about a logger definition version.

Link to this function

get_resource_definition(client, resource_definition_id, options \\ [])

View Source

Retrieves information about a resource definition, including its creation time and latest version.

Link to this function

get_resource_definition_version(client, resource_definition_id, resource_definition_version_id, options \\ [])

View Source

Retrieves information about a resource definition version, including which resources are included in the version.

Link to this function

get_service_role_for_account(client, options \\ [])

View Source

Retrieves the service role that is attached to your account.

Link to this function

get_subscription_definition(client, subscription_definition_id, options \\ [])

View Source

Retrieves information about a subscription definition.

Link to this function

get_subscription_definition_version(client, subscription_definition_id, subscription_definition_version_id, next_token \\ nil, options \\ [])

View Source

Retrieves information about a subscription definition version.

Link to this function

get_thing_runtime_configuration(client, thing_name, options \\ [])

View Source

Get the runtime configuration of a thing.

Link to this function

list_bulk_deployment_detailed_reports(client, bulk_deployment_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Link to this function

list_bulk_deployments(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of bulk deployments.

Link to this function

list_connector_definition_versions(client, connector_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a connector definition, which are containers for connectors.

Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

Link to this function

list_connector_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of connector definitions.

Link to this function

list_core_definition_versions(client, core_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a core definition.

Link to this function

list_core_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of core definitions.

Link to this function

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

View Source

Returns a history of deployments for the group.

Link to this function

list_device_definition_versions(client, device_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a device definition.

Link to this function

list_device_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of device definitions.

Link to this function

list_function_definition_versions(client, function_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a Lambda function definition.

Link to this function

list_function_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of Lambda function definitions.

Link to this function

list_group_certificate_authorities(client, group_id, options \\ [])

View Source

Retrieves the current CAs for a group.

Link to this function

list_group_versions(client, group_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a group.

Link to this function

list_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of groups.

Link to this function

list_logger_definition_versions(client, logger_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a logger definition.

Link to this function

list_logger_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of logger definitions.

Link to this function

list_resource_definition_versions(client, resource_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a resource definition.

Link to this function

list_resource_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of resource definitions.

Link to this function

list_subscription_definition_versions(client, subscription_definition_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the versions of a subscription definition.

Link to this function

list_subscription_definitions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of subscription definitions.

Link to this function

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

View Source

Retrieves a list of resource tags for a resource arn.

Link to this function

reset_deployments(client, group_id, input, options \\ [])

View Source

Resets a group's deployments.

Link to this function

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

View Source

Deploys multiple groups in one operation.

This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

Link to this function

stop_bulk_deployment(client, bulk_deployment_id, input, options \\ [])

View Source

Stops 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 while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

Link to this function

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

View Source

Adds tags to a Greengrass resource.

Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

Link to this function

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

View Source

Remove resource tags from a Greengrass Resource.

Link to this function

update_connectivity_info(client, thing_name, input, options \\ [])

View Source

Updates 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 location of the core and connect to it.

Link to this function

update_connector_definition(client, connector_definition_id, input, options \\ [])

View Source

Updates a connector definition.

Link to this function

update_core_definition(client, core_definition_id, input, options \\ [])

View Source

Updates a core definition.

Link to this function

update_device_definition(client, device_definition_id, input, options \\ [])

View Source

Updates a device definition.

Link to this function

update_function_definition(client, function_definition_id, input, options \\ [])

View Source

Updates a Lambda function definition.

Link to this function

update_group(client, group_id, input, options \\ [])

View Source

Updates a group.

Link to this function

update_group_certificate_configuration(client, group_id, input, options \\ [])

View Source

Updates the Certificate expiry time for a group.

Link to this function

update_logger_definition(client, logger_definition_id, input, options \\ [])

View Source

Updates a logger definition.

Link to this function

update_resource_definition(client, resource_definition_id, input, options \\ [])

View Source

Updates a resource definition.

Link to this function

update_subscription_definition(client, subscription_definition_id, input, options \\ [])

View Source

Updates a subscription definition.

Link to this function

update_thing_runtime_configuration(client, thing_name, input, options \\ [])

View Source

Updates the runtime configuration of a thing.