baiji v0.6.0 Baiji.Greengrass

AWS 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 Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS 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

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role’s permissions will allow Greengrass core Lambda functions to perform actions against the cloud

Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy AWSGreengrassResourceAccessRolePolicy

Creates a core definition. You may optionally provide the initial version of the core definition or use ‘’CreateCoreDefinitionVersion’’ at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core

Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core

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

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

Create a version of a Lambda function definition that has already been defined

Creates a group. You may optionally provide the initial version of the group or use ‘’CreateGroupVersion’’ at a later time

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

Creates a version of a group which has already been defined

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

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

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

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

Deletes a core definition. The core definition must not have been used in a deployment

Deletes a device definition. The device definition must not have been used in a deployment

Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment

Deletes a group. The group must not have been used in deployment

Deletes a logger definition. The logger definition must not have been used in a deployment

Deletes a subscription definition. The subscription definition must not have been used in a deployment

Disassociates the role from a group

Disassociates the service role from the account. Without a service role, deployments will not work

Retrieves the role associated with a particular group

Retrieves the connectivity information for a core

Retrieves information about a core definition version

Retrieves information about a core definition version

Returns the status of a deployment

Retrieves information about a device definition

Retrieves information about a device definition version

Retrieves information about a Lambda function definition, such as its creation time and latest version

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

Retrieves information about a group

Retreives the CA associated with a group. Returns the public key of the CA

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 logger definition version

Retrieves the service role that is attached to the account

Retrieves information about a subscription definition

Retrieves information about a subscription definition version

Retrieves a list of core definitions

Returns a history of deployments for the group

Lists the versions of a device definition

Retrieves a list of device definitions

Lists the versions of a Lambda function definition

Retrieves a list of Lambda function definitions

Retrieves a list of groups

Lists the versions of a logger definition

Retrieves a list of logger definitions

Lists the versions of a subscription definition

Retrieves a list of subscription definitions

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

Updates a Lambda function definition

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function associate_role_to_group(input \\ %{}, options \\ [])

Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role’s permissions will allow Greengrass core Lambda functions to perform actions against the cloud.

Link to this function associate_service_role_to_account(input \\ %{}, options \\ [])

Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy AWSGreengrassResourceAccessRolePolicy

Link to this function create_core_definition(input \\ %{}, options \\ [])

Creates a core definition. You may optionally provide the initial version of the core definition or use ‘’CreateCoreDefinitionVersion’’ at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Link to this function create_core_definition_version(input \\ %{}, options \\ [])

Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Link to this function create_deployment(input \\ %{}, options \\ [])

Creates a deployment.

Link to this function create_device_definition(input \\ %{}, options \\ [])

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

Link to this function create_device_definition_version(input \\ %{}, options \\ [])

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

Link to this function create_function_definition(input \\ %{}, options \\ [])

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(input \\ %{}, options \\ [])

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

Link to this function create_group(input \\ %{}, options \\ [])

Creates a group. You may optionally provide the initial version of the group or use ‘’CreateGroupVersion’’ at a later time.

Link to this function create_group_certificate_authority(input \\ %{}, options \\ [])

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

Link to this function create_group_version(input \\ %{}, options \\ [])

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

Link to this function create_logger_definition(input \\ %{}, options \\ [])

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

Link to this function create_logger_definition_version(input \\ %{}, options \\ [])

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

Link to this function create_subscription_definition(input \\ %{}, options \\ [])

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

Link to this function create_subscription_definition_version(input \\ %{}, options \\ [])

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

Link to this function delete_core_definition(input \\ %{}, options \\ [])

Deletes a core definition. The core definition must not have been used in a deployment.

Link to this function delete_device_definition(input \\ %{}, options \\ [])

Deletes a device definition. The device definition must not have been used in a deployment.

Link to this function delete_function_definition(input \\ %{}, options \\ [])

Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.

Link to this function delete_group(input \\ %{}, options \\ [])

Deletes a group. The group must not have been used in deployment.

Link to this function delete_logger_definition(input \\ %{}, options \\ [])

Deletes a logger definition. The logger definition must not have been used in a deployment.

Link to this function delete_subscription_definition(input \\ %{}, options \\ [])

Deletes a subscription definition. The subscription definition must not have been used in a deployment.

Link to this function disassociate_role_from_group(input \\ %{}, options \\ [])

Disassociates the role from a group.

Link to this function disassociate_service_role_from_account(input \\ %{}, options \\ [])

Disassociates the service role from the account. Without a service role, deployments will not work.

Link to this function get_associated_role(input \\ %{}, options \\ [])

Retrieves the role associated with a particular group.

Link to this function get_connectivity_info(input \\ %{}, options \\ [])

Retrieves the connectivity information for a core.

Link to this function get_core_definition(input \\ %{}, options \\ [])

Retrieves information about a core definition version.

Link to this function get_core_definition_version(input \\ %{}, options \\ [])

Retrieves information about a core definition version.

Link to this function get_deployment_status(input \\ %{}, options \\ [])

Returns the status of a deployment.

Link to this function get_device_definition(input \\ %{}, options \\ [])

Retrieves information about a device definition.

Link to this function get_device_definition_version(input \\ %{}, options \\ [])

Retrieves information about a device definition version.

Link to this function get_function_definition(input \\ %{}, options \\ [])

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

Link to this function get_function_definition_version(input \\ %{}, options \\ [])

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

Link to this function get_group(input \\ %{}, options \\ [])

Retrieves information about a group.

Link to this function get_group_certificate_authority(input \\ %{}, options \\ [])

Retreives the CA associated with a group. Returns the public key of the CA.

Link to this function get_group_certificate_configuration(input \\ %{}, options \\ [])

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

Link to this function get_group_version(input \\ %{}, options \\ [])

Retrieves information about a group version.

Link to this function get_logger_definition(input \\ %{}, options \\ [])

Retrieves information about a logger definition.

Link to this function get_logger_definition_version(input \\ %{}, options \\ [])

Retrieves information about a logger definition version.

Link to this function get_service_role_for_account(input \\ %{}, options \\ [])

Retrieves the service role that is attached to the account.

Link to this function get_subscription_definition(input \\ %{}, options \\ [])

Retrieves information about a subscription definition.

Link to this function get_subscription_definition_version(input \\ %{}, options \\ [])

Retrieves information about a subscription definition version.

Link to this function list_core_definition_versions(input \\ %{}, options \\ [])

Lists versions of a core definition.

Link to this function list_core_definitions(input \\ %{}, options \\ [])

Retrieves a list of core definitions.

Link to this function list_deployments(input \\ %{}, options \\ [])

Returns a history of deployments for the group.

Link to this function list_device_definition_versions(input \\ %{}, options \\ [])

Lists the versions of a device definition.

Link to this function list_device_definitions(input \\ %{}, options \\ [])

Retrieves a list of device definitions.

Link to this function list_function_definition_versions(input \\ %{}, options \\ [])

Lists the versions of a Lambda function definition.

Link to this function list_function_definitions(input \\ %{}, options \\ [])

Retrieves a list of Lambda function definitions.

Link to this function list_group_certificate_authorities(input \\ %{}, options \\ [])

Retrieves the current CAs for a group.

Link to this function list_group_versions(input \\ %{}, options \\ [])

List the versions of a group.

Link to this function list_groups(input \\ %{}, options \\ [])

Retrieves a list of groups.

Link to this function list_logger_definition_versions(input \\ %{}, options \\ [])

Lists the versions of a logger definition.

Link to this function list_logger_definitions(input \\ %{}, options \\ [])

Retrieves a list of logger definitions.

Link to this function list_subscription_definition_versions(input \\ %{}, options \\ [])

Lists the versions of a subscription definition.

Link to this function list_subscription_definitions(input \\ %{}, options \\ [])

Retrieves a list of subscription definitions.

Link to this function update_connectivity_info(input \\ %{}, options \\ [])

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_core_definition(input \\ %{}, options \\ [])

Updates a core definition.

Link to this function update_device_definition(input \\ %{}, options \\ [])

Updates a device definition.

Link to this function update_function_definition(input \\ %{}, options \\ [])

Updates a Lambda function definition.

Link to this function update_group(input \\ %{}, options \\ [])

Updates a group.

Link to this function update_group_certificate_configuration(input \\ %{}, options \\ [])

Updates the Cert expiry time for a group.

Link to this function update_logger_definition(input \\ %{}, options \\ [])

Updates a logger definition.

Link to this function update_subscription_definition(input \\ %{}, options \\ [])

Updates a subscription definition.