Package-level declarations

Types

Link copied to clipboard

General error information.

Link copied to clipboard

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

Link copied to clipboard

Relevant metrics on input records processed during bulk deployment.

Link copied to clipboard

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

Link copied to clipboard

The current status of the bulk deployment.

Link copied to clipboard
Link copied to clipboard

Information about a Greengrass core's connectivity.

Link copied to clipboard
class 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.

Link copied to clipboard

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

Link copied to clipboard
class Core

Information about a core.

Link copied to clipboard

Information about a core definition version.

Link copied to clipboard

Information needed to create a core definition.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information needed to create a function definition version.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about a definition.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about a deployment.

Link copied to clipboard
sealed class DeploymentType

The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

Link copied to clipboard
class Device

Information about a device.

Link copied to clipboard

Information about a device definition version.

Link copied to clipboard
sealed class EncodingType
Link copied to clipboard

Details about the error.

Link copied to clipboard
class Function

Information about a Lambda function.

Link copied to clipboard

The configuration of the Lambda function.

Link copied to clipboard

The environment configuration of the function.

Link copied to clipboard

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

Link copied to clipboard

Configuration information that specifies how a Lambda function runs.

Link copied to clipboard

Information about a function definition version.

Link copied to clipboard

Configuration information that specifies how a Lambda function runs.

Link copied to clipboard

Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Base class for all service related exceptions thrown by the Greengrass client

Link copied to clipboard

Information about a certificate authority for a group.

Link copied to clipboard

Information about a group.

Link copied to clipboard

Group owner related settings for local resources.

Link copied to clipboard

Information about a group version.

Link copied to clipboard

General error information.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Attributes that define a local device resource.

Link copied to clipboard

Attributes that define a local volume resource.

Link copied to clipboard
class Logger

Information about a logger

Link copied to clipboard
sealed class LoggerComponent
Link copied to clipboard

Information about a logger definition version.

Link copied to clipboard
sealed class LoggerLevel
Link copied to clipboard
sealed class LoggerType
Link copied to clipboard
sealed class Permission

The type of permission a function has to access a resource.

Link copied to clipboard

Information needed to reset deployments.

Link copied to clipboard
Link copied to clipboard
class Resource

Information about a resource.

Link copied to clipboard

A policy used by the function to access a resource.

Link copied to clipboard

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

Link copied to clipboard

Information about a resource definition version.

Link copied to clipboard

The owner setting for downloaded machine learning resources.

Link copied to clipboard

Runtime configuration for a thing.

Link copied to clipboard

Attributes that define an Amazon S3 machine learning resource.

Attributes that define an Amazon SageMaker machine learning resource.

Link copied to clipboard

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.

Link copied to clipboard
sealed class SoftwareToUpdate

The piece of software on the Greengrass core that will be updated.

Link copied to clipboard
Link copied to clipboard

Information about a subscription.

Link copied to clipboard

Information about a subscription definition version.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
sealed class Telemetry
Link copied to clipboard

Configuration settings for running telemetry.

Link copied to clipboard

Configuration settings for running telemetry.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class UpdateAgentLogLevel

The minimum level of log statements that should be logged by the OTA Agent during an update.

Link copied to clipboard

Connectivity information.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The architecture of the cores which are the targets of an update.

Link copied to clipboard

The operating system of the cores which are the targets of an update.

Link copied to clipboard

Information about a version.