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§
- Associate
Role ToGroup Request - Associate
Role ToGroup Response - Associate
Service Role ToAccount Request - Associate
Service Role ToAccount Response - Bulk
Deployment Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.
- Bulk
Deployment Metrics Relevant metrics on input records processed during bulk deployment.
- Bulk
Deployment Result Information about an individual group deployment in a bulk deployment operation.
- Connectivity
Info Information about a Greengrass core's connectivity.
- Connector
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.
- Connector
Definition Version Information about the connector definition version, which is a container for connectors.
- Core
Information about a core.
- Core
Definition Version Information about a core definition version.
- Create
Connector Definition Request - Create
Connector Definition Response - Create
Connector Definition Version Request - Create
Connector Definition Version Response - Create
Core Definition Request Information needed to create a core definition.
- Create
Core Definition Response - Create
Core Definition Version Request - Create
Core Definition Version Response - Create
Deployment Request - Create
Deployment Response - Create
Device Definition Request - Create
Device Definition Response - Create
Device Definition Version Request - Create
Device Definition Version Response - Create
Function Definition Request - Create
Function Definition Response - Create
Function Definition Version Request Information needed to create a function definition version.
- Create
Function Definition Version Response - Create
Group Certificate Authority Request - Create
Group Certificate Authority Response - Create
Group Request - Create
Group Response - Create
Group Version Request - Create
Group Version Response - Create
Logger Definition Request - Create
Logger Definition Response - Create
Logger Definition Version Request - Create
Logger Definition Version Response - Create
Resource Definition Request - Create
Resource Definition Response - Create
Resource Definition Version Request - Create
Resource Definition Version Response - Create
Software Update JobRequest - Create
Software Update JobResponse - Create
Subscription Definition Request - Create
Subscription Definition Response - Create
Subscription Definition Version Request - Create
Subscription Definition Version Response - Definition
Information Information about a definition.
- Delete
Connector Definition Request - Delete
Connector Definition Response - Delete
Core Definition Request - Delete
Core Definition Response - Delete
Device Definition Request - Delete
Device Definition Response - Delete
Function Definition Request - Delete
Function Definition Response - Delete
Group Request - Delete
Group Response - Delete
Logger Definition Request - Delete
Logger Definition Response - Delete
Resource Definition Request - Delete
Resource Definition Response - Delete
Subscription Definition Request - Delete
Subscription Definition Response - Deployment
Information about a deployment.
- Device
Information about a device.
- Device
Definition Version Information about a device definition version.
- Disassociate
Role From Group Request - Disassociate
Role From Group Response - Disassociate
Service Role From Account Request - Disassociate
Service Role From Account Response - Error
Detail Details about the error.
- Function
Information about a Lambda function.
- Function
Configuration The configuration of the Lambda function.
- Function
Configuration Environment The environment configuration of the function.
- Function
Default Config The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
- Function
Default Execution Config Configuration information that specifies how a Lambda function runs.
- Function
Definition Version Information about a function definition version.
- Function
Execution Config Configuration information that specifies how a Lambda function runs.
- Function
RunAs Config 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''.
- GetAssociated
Role Request - GetAssociated
Role Response - GetBulk
Deployment Status Request - GetBulk
Deployment Status Response - GetConnectivity
Info Request - GetConnectivity
Info Response - GetConnector
Definition Request - GetConnector
Definition Response - GetConnector
Definition Version Request - GetConnector
Definition Version Response - GetCore
Definition Request - GetCore
Definition Response - GetCore
Definition Version Request - GetCore
Definition Version Response - GetDeployment
Status Request - GetDeployment
Status Response - GetDevice
Definition Request - GetDevice
Definition Response - GetDevice
Definition Version Request - GetDevice
Definition Version Response - GetFunction
Definition Request - GetFunction
Definition Response - GetFunction
Definition Version Request - GetFunction
Definition Version Response - GetGroup
Certificate Authority Request - GetGroup
Certificate Authority Response - GetGroup
Certificate Configuration Request - GetGroup
Certificate Configuration Response - GetGroup
Request - GetGroup
Response - GetGroup
Version Request - GetGroup
Version Response - GetLogger
Definition Request - GetLogger
Definition Response - GetLogger
Definition Version Request - GetLogger
Definition Version Response - GetResource
Definition Request - GetResource
Definition Response - GetResource
Definition Version Request - GetResource
Definition Version Response - GetService
Role ForAccount Request - GetService
Role ForAccount Response - GetSubscription
Definition Request - GetSubscription
Definition Response - GetSubscription
Definition Version Request - GetSubscription
Definition Version Response - Green
Grass Client - A client for the AWS Greengrass API.
- Group
Certificate Authority Properties Information about a certificate authority for a group.
- Group
Information Information about a group.
- Group
Owner Setting Group owner related settings for local resources.
- Group
Version Information about a group version.
- List
Bulk Deployment Detailed Reports Request - List
Bulk Deployment Detailed Reports Response - List
Bulk Deployments Request - List
Bulk Deployments Response - List
Connector Definition Versions Request - List
Connector Definition Versions Response - List
Connector Definitions Request - List
Connector Definitions Response - List
Core Definition Versions Request - List
Core Definition Versions Response - List
Core Definitions Request - List
Core Definitions Response - List
Deployments Request - List
Deployments Response - List
Device Definition Versions Request - List
Device Definition Versions Response - List
Device Definitions Request - List
Device Definitions Response - List
Function Definition Versions Request - List
Function Definition Versions Response - List
Function Definitions Request - List
Function Definitions Response - List
Group Certificate Authorities Request - List
Group Certificate Authorities Response - List
Group Versions Request - List
Group Versions Response - List
Groups Request - List
Groups Response - List
Logger Definition Versions Request - List
Logger Definition Versions Response - List
Logger Definitions Request - List
Logger Definitions Response - List
Resource Definition Versions Request - List
Resource Definition Versions Response - List
Resource Definitions Request - List
Resource Definitions Response - List
Subscription Definition Versions Request - List
Subscription Definition Versions Response - List
Subscription Definitions Request - List
Subscription Definitions Response - List
Tags ForResource Request - List
Tags ForResource Response - Local
Device Resource Data Attributes that define a local device resource.
- Local
Volume Resource Data Attributes that define a local volume resource.
- Logger
Information about a logger
- Logger
Definition Version Information about a logger definition version.
- Reset
Deployments Request Information needed to reset deployments.
- Reset
Deployments Response - Resource
Information about a resource.
- Resource
Access Policy A policy used by the function to access a resource.
- Resource
Data Container A container for resource data. The container takes only one of the following supported resource data types: ''LocalDeviceResourceData'', ''LocalVolumeResourceData'', ''SageMakerMachineLearningModelResourceData'', ''S3MachineLearningModelResourceData'', ''SecretsManagerSecretResourceData''.
- Resource
Definition Version Information about a resource definition version.
- Resource
Download Owner Setting The owner setting for downloaded machine learning resources.
- S3Machine
Learning Model Resource Data Attributes that define an Amazon S3 machine learning resource.
- Sage
Maker Machine Learning Model Resource Data Attributes that define an Amazon SageMaker machine learning resource.
- Secrets
Manager Secret Resource Data 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.
- Start
Bulk Deployment Request - Start
Bulk Deployment Response - Stop
Bulk Deployment Request - Stop
Bulk Deployment Response - Subscription
Information about a subscription.
- Subscription
Definition Version Information about a subscription definition version.
- TagResource
Request A map of the key-value pairs for the resource tag.
- Untag
Resource Request - Update
Connectivity Info Request Connectivity information.
- Update
Connectivity Info Response - Update
Connector Definition Request - Update
Connector Definition Response - Update
Core Definition Request - Update
Core Definition Response - Update
Device Definition Request - Update
Device Definition Response - Update
Function Definition Request - Update
Function Definition Response - Update
Group Certificate Configuration Request - Update
Group Certificate Configuration Response - Update
Group Request - Update
Group Response - Update
Logger Definition Request - Update
Logger Definition Response - Update
Resource Definition Request - Update
Resource Definition Response - Update
Subscription Definition Request - Update
Subscription Definition Response - Version
Information Information about a version.
Enums§
- Associate
Role ToGroup Error - Errors returned by AssociateRoleToGroup
- Associate
Service Role ToAccount Error - Errors returned by AssociateServiceRoleToAccount
- Create
Connector Definition Error - Errors returned by CreateConnectorDefinition
- Create
Connector Definition Version Error - Errors returned by CreateConnectorDefinitionVersion
- Create
Core Definition Error - Errors returned by CreateCoreDefinition
- Create
Core Definition Version Error - Errors returned by CreateCoreDefinitionVersion
- Create
Deployment Error - Errors returned by CreateDeployment
- Create
Device Definition Error - Errors returned by CreateDeviceDefinition
- Create
Device Definition Version Error - Errors returned by CreateDeviceDefinitionVersion
- Create
Function Definition Error - Errors returned by CreateFunctionDefinition
- Create
Function Definition Version Error - Errors returned by CreateFunctionDefinitionVersion
- Create
Group Certificate Authority Error - Errors returned by CreateGroupCertificateAuthority
- Create
Group Error - Errors returned by CreateGroup
- Create
Group Version Error - Errors returned by CreateGroupVersion
- Create
Logger Definition Error - Errors returned by CreateLoggerDefinition
- Create
Logger Definition Version Error - Errors returned by CreateLoggerDefinitionVersion
- Create
Resource Definition Error - Errors returned by CreateResourceDefinition
- Create
Resource Definition Version Error - Errors returned by CreateResourceDefinitionVersion
- Create
Software Update JobError - Errors returned by CreateSoftwareUpdateJob
- Create
Subscription Definition Error - Errors returned by CreateSubscriptionDefinition
- Create
Subscription Definition Version Error - Errors returned by CreateSubscriptionDefinitionVersion
- Delete
Connector Definition Error - Errors returned by DeleteConnectorDefinition
- Delete
Core Definition Error - Errors returned by DeleteCoreDefinition
- Delete
Device Definition Error - Errors returned by DeleteDeviceDefinition
- Delete
Function Definition Error - Errors returned by DeleteFunctionDefinition
- Delete
Group Error - Errors returned by DeleteGroup
- Delete
Logger Definition Error - Errors returned by DeleteLoggerDefinition
- Delete
Resource Definition Error - Errors returned by DeleteResourceDefinition
- Delete
Subscription Definition Error - Errors returned by DeleteSubscriptionDefinition
- Disassociate
Role From Group Error - Errors returned by DisassociateRoleFromGroup
- Disassociate
Service Role From Account Error - Errors returned by DisassociateServiceRoleFromAccount
- GetAssociated
Role Error - Errors returned by GetAssociatedRole
- GetBulk
Deployment Status Error - Errors returned by GetBulkDeploymentStatus
- GetConnectivity
Info Error - Errors returned by GetConnectivityInfo
- GetConnector
Definition Error - Errors returned by GetConnectorDefinition
- GetConnector
Definition Version Error - Errors returned by GetConnectorDefinitionVersion
- GetCore
Definition Error - Errors returned by GetCoreDefinition
- GetCore
Definition Version Error - Errors returned by GetCoreDefinitionVersion
- GetDeployment
Status Error - Errors returned by GetDeploymentStatus
- GetDevice
Definition Error - Errors returned by GetDeviceDefinition
- GetDevice
Definition Version Error - Errors returned by GetDeviceDefinitionVersion
- GetFunction
Definition Error - Errors returned by GetFunctionDefinition
- GetFunction
Definition Version Error - Errors returned by GetFunctionDefinitionVersion
- GetGroup
Certificate Authority Error - Errors returned by GetGroupCertificateAuthority
- GetGroup
Certificate Configuration Error - Errors returned by GetGroupCertificateConfiguration
- GetGroup
Error - Errors returned by GetGroup
- GetGroup
Version Error - Errors returned by GetGroupVersion
- GetLogger
Definition Error - Errors returned by GetLoggerDefinition
- GetLogger
Definition Version Error - Errors returned by GetLoggerDefinitionVersion
- GetResource
Definition Error - Errors returned by GetResourceDefinition
- GetResource
Definition Version Error - Errors returned by GetResourceDefinitionVersion
- GetService
Role ForAccount Error - Errors returned by GetServiceRoleForAccount
- GetSubscription
Definition Error - Errors returned by GetSubscriptionDefinition
- GetSubscription
Definition Version Error - Errors returned by GetSubscriptionDefinitionVersion
- List
Bulk Deployment Detailed Reports Error - Errors returned by ListBulkDeploymentDetailedReports
- List
Bulk Deployments Error - Errors returned by ListBulkDeployments
- List
Connector Definition Versions Error - Errors returned by ListConnectorDefinitionVersions
- List
Connector Definitions Error - Errors returned by ListConnectorDefinitions
- List
Core Definition Versions Error - Errors returned by ListCoreDefinitionVersions
- List
Core Definitions Error - Errors returned by ListCoreDefinitions
- List
Deployments Error - Errors returned by ListDeployments
- List
Device Definition Versions Error - Errors returned by ListDeviceDefinitionVersions
- List
Device Definitions Error - Errors returned by ListDeviceDefinitions
- List
Function Definition Versions Error - Errors returned by ListFunctionDefinitionVersions
- List
Function Definitions Error - Errors returned by ListFunctionDefinitions
- List
Group Certificate Authorities Error - Errors returned by ListGroupCertificateAuthorities
- List
Group Versions Error - Errors returned by ListGroupVersions
- List
Groups Error - Errors returned by ListGroups
- List
Logger Definition Versions Error - Errors returned by ListLoggerDefinitionVersions
- List
Logger Definitions Error - Errors returned by ListLoggerDefinitions
- List
Resource Definition Versions Error - Errors returned by ListResourceDefinitionVersions
- List
Resource Definitions Error - Errors returned by ListResourceDefinitions
- List
Subscription Definition Versions Error - Errors returned by ListSubscriptionDefinitionVersions
- List
Subscription Definitions Error - Errors returned by ListSubscriptionDefinitions
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Reset
Deployments Error - Errors returned by ResetDeployments
- Start
Bulk Deployment Error - Errors returned by StartBulkDeployment
- Stop
Bulk Deployment Error - Errors returned by StopBulkDeployment
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Connectivity Info Error - Errors returned by UpdateConnectivityInfo
- Update
Connector Definition Error - Errors returned by UpdateConnectorDefinition
- Update
Core Definition Error - Errors returned by UpdateCoreDefinition
- Update
Device Definition Error - Errors returned by UpdateDeviceDefinition
- Update
Function Definition Error - Errors returned by UpdateFunctionDefinition
- Update
Group Certificate Configuration Error - Errors returned by UpdateGroupCertificateConfiguration
- Update
Group Error - Errors returned by UpdateGroup
- Update
Logger Definition Error - Errors returned by UpdateLoggerDefinition
- Update
Resource Definition Error - Errors returned by UpdateResourceDefinition
- Update
Subscription Definition Error - Errors returned by UpdateSubscriptionDefinition
Traits§
- Green
Grass - Trait representing the capabilities of the AWS Greengrass API. AWS Greengrass clients implement this trait.