Module aws_sdk_greengrassv2::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that AWS IoT Greengrass V2 can respond with.

Structs

• AssociateClientDeviceWithCoreDeviceEntry

  Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation consumes a list of these requests.

• AssociateClientDeviceWithCoreDeviceErrorEntry

  Contains an error that occurs from a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation returns a list of these errors.

• AssociatedClientDevice

  Contains information about a client device that is associated to a core device for cloud discovery.

• CloudComponentStatus

  Contains the status of a component version in the IoT Greengrass service.

• Component

  Contains information about a component.

• ComponentCandidate

  Contains information about a component that is a candidate to deploy to a Greengrass core device.

• ComponentConfigurationUpdate

  Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

• ComponentDependencyRequirement

  Contains information about a component dependency for a Lambda function component.

• ComponentDeploymentSpecification

  Contains information about a component to deploy.

• ComponentLatestVersion

  Contains information about the latest version of a component.

• ComponentPlatform

  Contains information about a platform that a component supports.

• ComponentRunWith

  Contains information system user and group that the IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.

• ComponentVersionListItem

  Contains information about a component version in a list.

• ConnectivityInfo

  Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.

• CoreDevice

  Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.

• Deployment

  Contains information about a deployment.

• DeploymentComponentUpdatePolicy

  Contains information about a deployment's policy that defines when components are safe to update.

• DeploymentConfigurationValidationPolicy

  Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• DeploymentIoTJobConfiguration

  Contains information about an IoT job configuration.

• DeploymentPolicies

  Contains information about policies that define how a deployment updates components and handles failure.

• DisassociateClientDeviceFromCoreDeviceEntry

  Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation consumes a list of these requests.

• DisassociateClientDeviceFromCoreDeviceErrorEntry

  Contains an error that occurs from a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation returns a list of these errors.

• EffectiveDeployment

  Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

• EffectiveDeploymentStatusDetails

  Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state.

• InstalledComponent

  Contains information about a component on a Greengrass core device.

• IoTJobAbortConfig

  Contains a list of criteria that define when and how to cancel a configuration deployment.

• IoTJobAbortCriteria

  Contains criteria that define when and how to cancel a job.

• IoTJobExecutionsRolloutConfig

  Contains information about the rollout configuration for a job. This configuration defines the rate at which the job deploys a configuration to a fleet of target devices.

• IoTJobExponentialRolloutRate

  Contains information about an exponential rollout rate for a configuration deployment job.

• IoTJobRateIncreaseCriteria

  Contains information about criteria to meet before a job increases its rollout rate. Specify either numberOfNotifiedThings or numberOfSucceededThings.

• IoTJobTimeoutConfig

  Contains information about the timeout configuration for a job.

• LambdaContainerParams

  Contains information about a container in which Lambda functions run on Greengrass core devices.

• LambdaDeviceMount

  Contains information about a device that Linux processes in a container can access.

• LambdaEventSource

  Contains information about an event source for an Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.

• LambdaExecutionParameters

  Contains parameters for a Lambda function that runs on IoT Greengrass.

• LambdaFunctionRecipeSource

  Contains information about an Lambda function to import to create a component.

• LambdaLinuxProcessParams

  Contains parameters for a Linux process that contains an Lambda function.

• LambdaVolumeMount

  Contains information about a volume that Linux processes in a container can access. When you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the container.

• ResolvedComponentVersion

  Contains information about a component version that is compatible to run on a Greengrass core device.

• SystemResourceLimits

  Contains information about system resource limits that the IoT Greengrass Core software applies to a component's processes. For more information, see Configure system resource limits for components.

• ValidationExceptionField

  Contains information about a validation exception field.

Enums

• CloudComponentState
  When writing a match expression against CloudComponentState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ComponentDependencyType
  When writing a match expression against ComponentDependencyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ComponentVisibilityScope
  When writing a match expression against ComponentVisibilityScope, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CoreDeviceStatus
  When writing a match expression against CoreDeviceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeploymentComponentUpdatePolicyAction
  When writing a match expression against DeploymentComponentUpdatePolicyAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeploymentFailureHandlingPolicy
  When writing a match expression against DeploymentFailureHandlingPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeploymentHistoryFilter
  When writing a match expression against DeploymentHistoryFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeploymentStatus
  When writing a match expression against DeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EffectiveDeploymentExecutionStatus
  When writing a match expression against EffectiveDeploymentExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• InstalledComponentLifecycleState
  When writing a match expression against InstalledComponentLifecycleState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• InstalledComponentTopologyFilter
  When writing a match expression against InstalledComponentTopologyFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IoTJobAbortAction
  When writing a match expression against IoTJobAbortAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IoTJobExecutionFailureType
  When writing a match expression against IoTJobExecutionFailureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IotEndpointType
  When writing a match expression against IotEndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LambdaEventSourceType
  When writing a match expression against LambdaEventSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LambdaFilesystemPermission
  When writing a match expression against LambdaFilesystemPermission, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LambdaInputPayloadEncodingType
  When writing a match expression against LambdaInputPayloadEncodingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LambdaIsolationMode
  When writing a match expression against LambdaIsolationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecipeOutputFormat
  When writing a match expression against RecipeOutputFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• S3EndpointType
  When writing a match expression against S3EndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ValidationExceptionReason
  When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VendorGuidance
  When writing a match expression against VendorGuidance, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.