logo
Expand description

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.

If you’re using the service, you’re probably looking for GreenGrassClient and GreenGrass.

Structs

Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.

Relevant metrics on input records processed during bulk deployment.

Information about an individual group deployment in a bulk deployment operation.

Information about a Greengrass core's connectivity.

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

Information about the connector definition version, which is a container for connectors.

Information about a core.

Information about a core definition version.

Information needed to create a core definition.

Information needed to create a function definition version.

Information about a definition.

Information about a deployment.

Information about a device.

Information about a device definition version.

Details about the error.

Information about a Lambda function.

The configuration of the Lambda function.

The environment configuration of the function.

The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.

Configuration information that specifies how a Lambda function runs.

Information about a function definition version.

Configuration information that specifies how a Lambda function runs.

Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.

A client for the AWS Greengrass API.

Information about a certificate authority for a group.

Information about a group.

Group owner related settings for local resources.

Information about a group version.

Attributes that define a local device resource.

Attributes that define a local volume resource.

Information about a logger

Information about a logger definition version.

Information needed to reset deployments.

Information about a resource.

A policy used by the function to access a resource.

A container for resource data. The container takes only one of the following supported resource data types: ''LocalDeviceResourceData'', ''LocalVolumeResourceData'', ''SageMakerMachineLearningModelResourceData'', ''S3MachineLearningModelResourceData'', ''SecretsManagerSecretResourceData''.

Information about a resource definition version.

The owner setting for downloaded machine learning resources.

Runtime configuration for a thing.

Attributes that define an Amazon S3 machine learning resource.

Attributes that define an Amazon SageMaker machine learning resource.

Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.

Information about a subscription.

Information about a subscription definition version.

A map of the key-value pairs for the resource tag.

Configuration settings for running telemetry.

Configuration settings for running telemetry.

Connectivity information.

Information about a version.

Enums

Errors returned by AssociateRoleToGroup

Errors returned by AssociateServiceRoleToAccount

Errors returned by CreateConnectorDefinition

Errors returned by CreateConnectorDefinitionVersion

Errors returned by CreateCoreDefinition

Errors returned by CreateCoreDefinitionVersion

Errors returned by CreateDeployment

Errors returned by CreateDeviceDefinition

Errors returned by CreateDeviceDefinitionVersion

Errors returned by CreateFunctionDefinition

Errors returned by CreateFunctionDefinitionVersion

Errors returned by CreateGroupCertificateAuthority

Errors returned by CreateGroup

Errors returned by CreateGroupVersion

Errors returned by CreateLoggerDefinition

Errors returned by CreateLoggerDefinitionVersion

Errors returned by CreateResourceDefinition

Errors returned by CreateResourceDefinitionVersion

Errors returned by CreateSoftwareUpdateJob

Errors returned by CreateSubscriptionDefinition

Errors returned by CreateSubscriptionDefinitionVersion

Errors returned by DeleteConnectorDefinition

Errors returned by DeleteCoreDefinition

Errors returned by DeleteDeviceDefinition

Errors returned by DeleteFunctionDefinition

Errors returned by DeleteGroup

Errors returned by DeleteLoggerDefinition

Errors returned by DeleteResourceDefinition

Errors returned by DeleteSubscriptionDefinition

Errors returned by DisassociateRoleFromGroup

Errors returned by DisassociateServiceRoleFromAccount

Errors returned by GetAssociatedRole

Errors returned by GetBulkDeploymentStatus

Errors returned by GetConnectivityInfo

Errors returned by GetConnectorDefinition

Errors returned by GetConnectorDefinitionVersion

Errors returned by GetCoreDefinition

Errors returned by GetCoreDefinitionVersion

Errors returned by GetDeploymentStatus

Errors returned by GetDeviceDefinition

Errors returned by GetDeviceDefinitionVersion

Errors returned by GetFunctionDefinition

Errors returned by GetFunctionDefinitionVersion

Errors returned by GetGroupCertificateAuthority

Errors returned by GetGroupCertificateConfiguration

Errors returned by GetGroup

Errors returned by GetGroupVersion

Errors returned by GetLoggerDefinition

Errors returned by GetLoggerDefinitionVersion

Errors returned by GetResourceDefinition

Errors returned by GetResourceDefinitionVersion

Errors returned by GetServiceRoleForAccount

Errors returned by GetSubscriptionDefinition

Errors returned by GetSubscriptionDefinitionVersion

Errors returned by GetThingRuntimeConfiguration

Errors returned by ListBulkDeploymentDetailedReports

Errors returned by ListBulkDeployments

Errors returned by ListConnectorDefinitionVersions

Errors returned by ListConnectorDefinitions

Errors returned by ListCoreDefinitionVersions

Errors returned by ListCoreDefinitions

Errors returned by ListDeployments

Errors returned by ListDeviceDefinitionVersions

Errors returned by ListDeviceDefinitions

Errors returned by ListFunctionDefinitionVersions

Errors returned by ListFunctionDefinitions

Errors returned by ListGroupCertificateAuthorities

Errors returned by ListGroupVersions

Errors returned by ListGroups

Errors returned by ListLoggerDefinitionVersions

Errors returned by ListLoggerDefinitions

Errors returned by ListResourceDefinitionVersions

Errors returned by ListResourceDefinitions

Errors returned by ListSubscriptionDefinitionVersions

Errors returned by ListSubscriptionDefinitions

Errors returned by ListTagsForResource

Errors returned by ResetDeployments

Errors returned by StartBulkDeployment

Errors returned by StopBulkDeployment

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateConnectivityInfo

Errors returned by UpdateConnectorDefinition

Errors returned by UpdateCoreDefinition

Errors returned by UpdateDeviceDefinition

Errors returned by UpdateFunctionDefinition

Errors returned by UpdateGroupCertificateConfiguration

Errors returned by UpdateGroup

Errors returned by UpdateLoggerDefinition

Errors returned by UpdateResourceDefinition

Errors returned by UpdateSubscriptionDefinition

Errors returned by UpdateThingRuntimeConfiguration

Traits

Trait representing the capabilities of the AWS Greengrass API. AWS Greengrass clients implement this trait.