| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.GreengrassV2.Types
Contents
- Service Configuration
- Errors
- CloudComponentState
- ComponentDependencyType
- ComponentVisibilityScope
- CoreDeviceStatus
- DeploymentComponentUpdatePolicyAction
- DeploymentFailureHandlingPolicy
- DeploymentHistoryFilter
- DeploymentStatus
- EffectiveDeploymentExecutionStatus
- InstalledComponentLifecycleState
- InstalledComponentTopologyFilter
- IoTJobAbortAction
- IoTJobExecutionFailureType
- LambdaEventSourceType
- LambdaFilesystemPermission
- LambdaInputPayloadEncodingType
- LambdaIsolationMode
- RecipeOutputFormat
- VendorGuidance
- AssociateClientDeviceWithCoreDeviceEntry
- AssociateClientDeviceWithCoreDeviceErrorEntry
- AssociatedClientDevice
- CloudComponentStatus
- Component
- ComponentCandidate
- ComponentConfigurationUpdate
- ComponentDependencyRequirement
- ComponentDeploymentSpecification
- ComponentLatestVersion
- ComponentPlatform
- ComponentRunWith
- ComponentVersionListItem
- ConnectivityInfo
- CoreDevice
- Deployment
- DeploymentComponentUpdatePolicy
- DeploymentConfigurationValidationPolicy
- DeploymentIoTJobConfiguration
- DeploymentPolicies
- DisassociateClientDeviceFromCoreDeviceEntry
- DisassociateClientDeviceFromCoreDeviceErrorEntry
- EffectiveDeployment
- EffectiveDeploymentStatusDetails
- InstalledComponent
- IoTJobAbortConfig
- IoTJobAbortCriteria
- IoTJobExecutionsRolloutConfig
- IoTJobExponentialRolloutRate
- IoTJobRateIncreaseCriteria
- IoTJobTimeoutConfig
- LambdaContainerParams
- LambdaDeviceMount
- LambdaEventSource
- LambdaExecutionParameters
- LambdaFunctionRecipeSource
- LambdaLinuxProcessParams
- LambdaVolumeMount
- ResolvedComponentVersion
- SystemResourceLimits
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _RequestAlreadyInProgressException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype CloudComponentState where
- CloudComponentState' { }
- pattern CloudComponentState_DEPLOYABLE :: CloudComponentState
- pattern CloudComponentState_DEPRECATED :: CloudComponentState
- pattern CloudComponentState_FAILED :: CloudComponentState
- pattern CloudComponentState_INITIATED :: CloudComponentState
- pattern CloudComponentState_REQUESTED :: CloudComponentState
- newtype ComponentDependencyType where
- newtype ComponentVisibilityScope where
- newtype CoreDeviceStatus where
- CoreDeviceStatus' { }
- pattern CoreDeviceStatus_HEALTHY :: CoreDeviceStatus
- pattern CoreDeviceStatus_UNHEALTHY :: CoreDeviceStatus
- newtype DeploymentComponentUpdatePolicyAction where
- newtype DeploymentFailureHandlingPolicy where
- newtype DeploymentHistoryFilter where
- newtype DeploymentStatus where
- DeploymentStatus' { }
- pattern DeploymentStatus_ACTIVE :: DeploymentStatus
- pattern DeploymentStatus_CANCELED :: DeploymentStatus
- pattern DeploymentStatus_COMPLETED :: DeploymentStatus
- pattern DeploymentStatus_FAILED :: DeploymentStatus
- pattern DeploymentStatus_INACTIVE :: DeploymentStatus
- newtype EffectiveDeploymentExecutionStatus where
- EffectiveDeploymentExecutionStatus' { }
- pattern EffectiveDeploymentExecutionStatus_CANCELED :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_COMPLETED :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_FAILED :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_IN_PROGRESS :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_QUEUED :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_REJECTED :: EffectiveDeploymentExecutionStatus
- pattern EffectiveDeploymentExecutionStatus_TIMED_OUT :: EffectiveDeploymentExecutionStatus
- newtype InstalledComponentLifecycleState where
- InstalledComponentLifecycleState' { }
- pattern InstalledComponentLifecycleState_BROKEN :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_ERRORED :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_FINISHED :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_INSTALLED :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_NEW :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_RUNNING :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_STARTING :: InstalledComponentLifecycleState
- pattern InstalledComponentLifecycleState_STOPPING :: InstalledComponentLifecycleState
- newtype InstalledComponentTopologyFilter where
- newtype IoTJobAbortAction where
- IoTJobAbortAction' { }
- pattern IoTJobAbortAction_CANCEL :: IoTJobAbortAction
- newtype IoTJobExecutionFailureType where
- IoTJobExecutionFailureType' { }
- pattern IoTJobExecutionFailureType_ALL :: IoTJobExecutionFailureType
- pattern IoTJobExecutionFailureType_FAILED :: IoTJobExecutionFailureType
- pattern IoTJobExecutionFailureType_REJECTED :: IoTJobExecutionFailureType
- pattern IoTJobExecutionFailureType_TIMED_OUT :: IoTJobExecutionFailureType
- newtype LambdaEventSourceType where
- newtype LambdaFilesystemPermission where
- newtype LambdaInputPayloadEncodingType where
- newtype LambdaIsolationMode where
- newtype RecipeOutputFormat where
- RecipeOutputFormat' { }
- pattern RecipeOutputFormat_JSON :: RecipeOutputFormat
- pattern RecipeOutputFormat_YAML :: RecipeOutputFormat
- newtype VendorGuidance where
- VendorGuidance' { }
- pattern VendorGuidance_ACTIVE :: VendorGuidance
- pattern VendorGuidance_DELETED :: VendorGuidance
- pattern VendorGuidance_DISCONTINUED :: VendorGuidance
- data AssociateClientDeviceWithCoreDeviceEntry = AssociateClientDeviceWithCoreDeviceEntry' {}
- newAssociateClientDeviceWithCoreDeviceEntry :: Text -> AssociateClientDeviceWithCoreDeviceEntry
- associateClientDeviceWithCoreDeviceEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceEntry Text
- data AssociateClientDeviceWithCoreDeviceErrorEntry = AssociateClientDeviceWithCoreDeviceErrorEntry' {}
- newAssociateClientDeviceWithCoreDeviceErrorEntry :: AssociateClientDeviceWithCoreDeviceErrorEntry
- associateClientDeviceWithCoreDeviceErrorEntry_code :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- associateClientDeviceWithCoreDeviceErrorEntry_message :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- associateClientDeviceWithCoreDeviceErrorEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- data AssociatedClientDevice = AssociatedClientDevice' {}
- newAssociatedClientDevice :: AssociatedClientDevice
- associatedClientDevice_associationTimestamp :: Lens' AssociatedClientDevice (Maybe UTCTime)
- associatedClientDevice_thingName :: Lens' AssociatedClientDevice (Maybe Text)
- data CloudComponentStatus = CloudComponentStatus' {}
- newCloudComponentStatus :: CloudComponentStatus
- cloudComponentStatus_componentState :: Lens' CloudComponentStatus (Maybe CloudComponentState)
- cloudComponentStatus_errors :: Lens' CloudComponentStatus (Maybe (HashMap Text Text))
- cloudComponentStatus_message :: Lens' CloudComponentStatus (Maybe Text)
- cloudComponentStatus_vendorGuidance :: Lens' CloudComponentStatus (Maybe VendorGuidance)
- cloudComponentStatus_vendorGuidanceMessage :: Lens' CloudComponentStatus (Maybe Text)
- data Component = Component' {}
- newComponent :: Component
- component_arn :: Lens' Component (Maybe Text)
- component_componentName :: Lens' Component (Maybe Text)
- component_latestVersion :: Lens' Component (Maybe ComponentLatestVersion)
- data ComponentCandidate = ComponentCandidate' {}
- newComponentCandidate :: ComponentCandidate
- componentCandidate_componentName :: Lens' ComponentCandidate (Maybe Text)
- componentCandidate_componentVersion :: Lens' ComponentCandidate (Maybe Text)
- componentCandidate_versionRequirements :: Lens' ComponentCandidate (Maybe (HashMap Text Text))
- data ComponentConfigurationUpdate = ComponentConfigurationUpdate' {}
- newComponentConfigurationUpdate :: ComponentConfigurationUpdate
- componentConfigurationUpdate_merge :: Lens' ComponentConfigurationUpdate (Maybe Text)
- componentConfigurationUpdate_reset :: Lens' ComponentConfigurationUpdate (Maybe [Text])
- data ComponentDependencyRequirement = ComponentDependencyRequirement' {}
- newComponentDependencyRequirement :: ComponentDependencyRequirement
- componentDependencyRequirement_dependencyType :: Lens' ComponentDependencyRequirement (Maybe ComponentDependencyType)
- componentDependencyRequirement_versionRequirement :: Lens' ComponentDependencyRequirement (Maybe Text)
- data ComponentDeploymentSpecification = ComponentDeploymentSpecification' {}
- newComponentDeploymentSpecification :: ComponentDeploymentSpecification
- componentDeploymentSpecification_componentVersion :: Lens' ComponentDeploymentSpecification (Maybe Text)
- componentDeploymentSpecification_configurationUpdate :: Lens' ComponentDeploymentSpecification (Maybe ComponentConfigurationUpdate)
- componentDeploymentSpecification_runWith :: Lens' ComponentDeploymentSpecification (Maybe ComponentRunWith)
- data ComponentLatestVersion = ComponentLatestVersion' {}
- newComponentLatestVersion :: ComponentLatestVersion
- componentLatestVersion_arn :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_componentVersion :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_creationTimestamp :: Lens' ComponentLatestVersion (Maybe UTCTime)
- componentLatestVersion_description :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_platforms :: Lens' ComponentLatestVersion (Maybe [ComponentPlatform])
- componentLatestVersion_publisher :: Lens' ComponentLatestVersion (Maybe Text)
- data ComponentPlatform = ComponentPlatform' {}
- newComponentPlatform :: ComponentPlatform
- componentPlatform_attributes :: Lens' ComponentPlatform (Maybe (HashMap Text Text))
- componentPlatform_name :: Lens' ComponentPlatform (Maybe Text)
- data ComponentRunWith = ComponentRunWith' {}
- newComponentRunWith :: ComponentRunWith
- componentRunWith_posixUser :: Lens' ComponentRunWith (Maybe Text)
- componentRunWith_systemResourceLimits :: Lens' ComponentRunWith (Maybe SystemResourceLimits)
- componentRunWith_windowsUser :: Lens' ComponentRunWith (Maybe Text)
- data ComponentVersionListItem = ComponentVersionListItem' {
- arn :: Maybe Text
- componentName :: Maybe Text
- componentVersion :: Maybe Text
- newComponentVersionListItem :: ComponentVersionListItem
- componentVersionListItem_arn :: Lens' ComponentVersionListItem (Maybe Text)
- componentVersionListItem_componentName :: Lens' ComponentVersionListItem (Maybe Text)
- componentVersionListItem_componentVersion :: Lens' ComponentVersionListItem (Maybe Text)
- data ConnectivityInfo = ConnectivityInfo' {}
- newConnectivityInfo :: ConnectivityInfo
- connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_metadata :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Natural)
- data CoreDevice = CoreDevice' {}
- newCoreDevice :: CoreDevice
- coreDevice_coreDeviceThingName :: Lens' CoreDevice (Maybe Text)
- coreDevice_lastStatusUpdateTimestamp :: Lens' CoreDevice (Maybe UTCTime)
- coreDevice_status :: Lens' CoreDevice (Maybe CoreDeviceStatus)
- data Deployment = Deployment' {}
- newDeployment :: Deployment
- deployment_creationTimestamp :: Lens' Deployment (Maybe UTCTime)
- deployment_deploymentId :: Lens' Deployment (Maybe Text)
- deployment_deploymentName :: Lens' Deployment (Maybe Text)
- deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus)
- deployment_isLatestForTarget :: Lens' Deployment (Maybe Bool)
- deployment_parentTargetArn :: Lens' Deployment (Maybe Text)
- deployment_revisionId :: Lens' Deployment (Maybe Text)
- deployment_targetArn :: Lens' Deployment (Maybe Text)
- data DeploymentComponentUpdatePolicy = DeploymentComponentUpdatePolicy' {}
- newDeploymentComponentUpdatePolicy :: DeploymentComponentUpdatePolicy
- deploymentComponentUpdatePolicy_action :: Lens' DeploymentComponentUpdatePolicy (Maybe DeploymentComponentUpdatePolicyAction)
- deploymentComponentUpdatePolicy_timeoutInSeconds :: Lens' DeploymentComponentUpdatePolicy (Maybe Int)
- data DeploymentConfigurationValidationPolicy = DeploymentConfigurationValidationPolicy' {}
- newDeploymentConfigurationValidationPolicy :: DeploymentConfigurationValidationPolicy
- deploymentConfigurationValidationPolicy_timeoutInSeconds :: Lens' DeploymentConfigurationValidationPolicy (Maybe Int)
- data DeploymentIoTJobConfiguration = DeploymentIoTJobConfiguration' {}
- newDeploymentIoTJobConfiguration :: DeploymentIoTJobConfiguration
- deploymentIoTJobConfiguration_abortConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobAbortConfig)
- deploymentIoTJobConfiguration_jobExecutionsRolloutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobExecutionsRolloutConfig)
- deploymentIoTJobConfiguration_timeoutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobTimeoutConfig)
- data DeploymentPolicies = DeploymentPolicies' {}
- newDeploymentPolicies :: DeploymentPolicies
- deploymentPolicies_componentUpdatePolicy :: Lens' DeploymentPolicies (Maybe DeploymentComponentUpdatePolicy)
- deploymentPolicies_configurationValidationPolicy :: Lens' DeploymentPolicies (Maybe DeploymentConfigurationValidationPolicy)
- deploymentPolicies_failureHandlingPolicy :: Lens' DeploymentPolicies (Maybe DeploymentFailureHandlingPolicy)
- data DisassociateClientDeviceFromCoreDeviceEntry = DisassociateClientDeviceFromCoreDeviceEntry' {}
- newDisassociateClientDeviceFromCoreDeviceEntry :: Text -> DisassociateClientDeviceFromCoreDeviceEntry
- disassociateClientDeviceFromCoreDeviceEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceEntry Text
- data DisassociateClientDeviceFromCoreDeviceErrorEntry = DisassociateClientDeviceFromCoreDeviceErrorEntry' {}
- newDisassociateClientDeviceFromCoreDeviceErrorEntry :: DisassociateClientDeviceFromCoreDeviceErrorEntry
- disassociateClientDeviceFromCoreDeviceErrorEntry_code :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- disassociateClientDeviceFromCoreDeviceErrorEntry_message :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- disassociateClientDeviceFromCoreDeviceErrorEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- data EffectiveDeployment = EffectiveDeployment' {
- description :: Maybe Text
- iotJobArn :: Maybe Text
- iotJobId :: Maybe Text
- reason :: Maybe Text
- statusDetails :: Maybe EffectiveDeploymentStatusDetails
- deploymentId :: Text
- deploymentName :: Text
- targetArn :: Text
- coreDeviceExecutionStatus :: EffectiveDeploymentExecutionStatus
- creationTimestamp :: POSIX
- modifiedTimestamp :: POSIX
- newEffectiveDeployment :: Text -> Text -> Text -> EffectiveDeploymentExecutionStatus -> UTCTime -> UTCTime -> EffectiveDeployment
- effectiveDeployment_description :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_iotJobArn :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_iotJobId :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_reason :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_statusDetails :: Lens' EffectiveDeployment (Maybe EffectiveDeploymentStatusDetails)
- effectiveDeployment_deploymentId :: Lens' EffectiveDeployment Text
- effectiveDeployment_deploymentName :: Lens' EffectiveDeployment Text
- effectiveDeployment_targetArn :: Lens' EffectiveDeployment Text
- effectiveDeployment_coreDeviceExecutionStatus :: Lens' EffectiveDeployment EffectiveDeploymentExecutionStatus
- effectiveDeployment_creationTimestamp :: Lens' EffectiveDeployment UTCTime
- effectiveDeployment_modifiedTimestamp :: Lens' EffectiveDeployment UTCTime
- data EffectiveDeploymentStatusDetails = EffectiveDeploymentStatusDetails' {
- errorStack :: Maybe [Text]
- errorTypes :: Maybe [Text]
- newEffectiveDeploymentStatusDetails :: EffectiveDeploymentStatusDetails
- effectiveDeploymentStatusDetails_errorStack :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text])
- effectiveDeploymentStatusDetails_errorTypes :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text])
- data InstalledComponent = InstalledComponent' {
- componentName :: Maybe Text
- componentVersion :: Maybe Text
- isRoot :: Maybe Bool
- lastInstallationSource :: Maybe Text
- lastReportedTimestamp :: Maybe POSIX
- lastStatusChangeTimestamp :: Maybe POSIX
- lifecycleState :: Maybe InstalledComponentLifecycleState
- lifecycleStateDetails :: Maybe Text
- lifecycleStatusCodes :: Maybe [Text]
- newInstalledComponent :: InstalledComponent
- installedComponent_componentName :: Lens' InstalledComponent (Maybe Text)
- installedComponent_componentVersion :: Lens' InstalledComponent (Maybe Text)
- installedComponent_isRoot :: Lens' InstalledComponent (Maybe Bool)
- installedComponent_lastInstallationSource :: Lens' InstalledComponent (Maybe Text)
- installedComponent_lastReportedTimestamp :: Lens' InstalledComponent (Maybe UTCTime)
- installedComponent_lastStatusChangeTimestamp :: Lens' InstalledComponent (Maybe UTCTime)
- installedComponent_lifecycleState :: Lens' InstalledComponent (Maybe InstalledComponentLifecycleState)
- installedComponent_lifecycleStateDetails :: Lens' InstalledComponent (Maybe Text)
- installedComponent_lifecycleStatusCodes :: Lens' InstalledComponent (Maybe [Text])
- data IoTJobAbortConfig = IoTJobAbortConfig' {}
- newIoTJobAbortConfig :: NonEmpty IoTJobAbortCriteria -> IoTJobAbortConfig
- ioTJobAbortConfig_criteriaList :: Lens' IoTJobAbortConfig (NonEmpty IoTJobAbortCriteria)
- data IoTJobAbortCriteria = IoTJobAbortCriteria' {}
- newIoTJobAbortCriteria :: IoTJobExecutionFailureType -> IoTJobAbortAction -> Double -> Natural -> IoTJobAbortCriteria
- ioTJobAbortCriteria_failureType :: Lens' IoTJobAbortCriteria IoTJobExecutionFailureType
- ioTJobAbortCriteria_action :: Lens' IoTJobAbortCriteria IoTJobAbortAction
- ioTJobAbortCriteria_thresholdPercentage :: Lens' IoTJobAbortCriteria Double
- ioTJobAbortCriteria_minNumberOfExecutedThings :: Lens' IoTJobAbortCriteria Natural
- data IoTJobExecutionsRolloutConfig = IoTJobExecutionsRolloutConfig' {}
- newIoTJobExecutionsRolloutConfig :: IoTJobExecutionsRolloutConfig
- ioTJobExecutionsRolloutConfig_exponentialRate :: Lens' IoTJobExecutionsRolloutConfig (Maybe IoTJobExponentialRolloutRate)
- ioTJobExecutionsRolloutConfig_maximumPerMinute :: Lens' IoTJobExecutionsRolloutConfig (Maybe Natural)
- data IoTJobExponentialRolloutRate = IoTJobExponentialRolloutRate' {}
- newIoTJobExponentialRolloutRate :: Natural -> Double -> IoTJobRateIncreaseCriteria -> IoTJobExponentialRolloutRate
- ioTJobExponentialRolloutRate_baseRatePerMinute :: Lens' IoTJobExponentialRolloutRate Natural
- ioTJobExponentialRolloutRate_incrementFactor :: Lens' IoTJobExponentialRolloutRate Double
- ioTJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' IoTJobExponentialRolloutRate IoTJobRateIncreaseCriteria
- data IoTJobRateIncreaseCriteria = IoTJobRateIncreaseCriteria' {}
- newIoTJobRateIncreaseCriteria :: IoTJobRateIncreaseCriteria
- ioTJobRateIncreaseCriteria_numberOfNotifiedThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural)
- ioTJobRateIncreaseCriteria_numberOfSucceededThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural)
- data IoTJobTimeoutConfig = IoTJobTimeoutConfig' {}
- newIoTJobTimeoutConfig :: IoTJobTimeoutConfig
- ioTJobTimeoutConfig_inProgressTimeoutInMinutes :: Lens' IoTJobTimeoutConfig (Maybe Integer)
- data LambdaContainerParams = LambdaContainerParams' {}
- newLambdaContainerParams :: LambdaContainerParams
- lambdaContainerParams_devices :: Lens' LambdaContainerParams (Maybe [LambdaDeviceMount])
- lambdaContainerParams_memorySizeInKB :: Lens' LambdaContainerParams (Maybe Int)
- lambdaContainerParams_mountROSysfs :: Lens' LambdaContainerParams (Maybe Bool)
- lambdaContainerParams_volumes :: Lens' LambdaContainerParams (Maybe [LambdaVolumeMount])
- data LambdaDeviceMount = LambdaDeviceMount' {}
- newLambdaDeviceMount :: Text -> LambdaDeviceMount
- lambdaDeviceMount_addGroupOwner :: Lens' LambdaDeviceMount (Maybe Bool)
- lambdaDeviceMount_permission :: Lens' LambdaDeviceMount (Maybe LambdaFilesystemPermission)
- lambdaDeviceMount_path :: Lens' LambdaDeviceMount Text
- data LambdaEventSource = LambdaEventSource' {}
- newLambdaEventSource :: Text -> LambdaEventSourceType -> LambdaEventSource
- lambdaEventSource_topic :: Lens' LambdaEventSource Text
- lambdaEventSource_type :: Lens' LambdaEventSource LambdaEventSourceType
- data LambdaExecutionParameters = LambdaExecutionParameters' {
- environmentVariables :: Maybe (HashMap Text Text)
- eventSources :: Maybe [LambdaEventSource]
- execArgs :: Maybe [Text]
- inputPayloadEncodingType :: Maybe LambdaInputPayloadEncodingType
- linuxProcessParams :: Maybe LambdaLinuxProcessParams
- maxIdleTimeInSeconds :: Maybe Int
- maxInstancesCount :: Maybe Int
- maxQueueSize :: Maybe Int
- pinned :: Maybe Bool
- statusTimeoutInSeconds :: Maybe Int
- timeoutInSeconds :: Maybe Int
- newLambdaExecutionParameters :: LambdaExecutionParameters
- lambdaExecutionParameters_environmentVariables :: Lens' LambdaExecutionParameters (Maybe (HashMap Text Text))
- lambdaExecutionParameters_eventSources :: Lens' LambdaExecutionParameters (Maybe [LambdaEventSource])
- lambdaExecutionParameters_execArgs :: Lens' LambdaExecutionParameters (Maybe [Text])
- lambdaExecutionParameters_inputPayloadEncodingType :: Lens' LambdaExecutionParameters (Maybe LambdaInputPayloadEncodingType)
- lambdaExecutionParameters_linuxProcessParams :: Lens' LambdaExecutionParameters (Maybe LambdaLinuxProcessParams)
- lambdaExecutionParameters_maxIdleTimeInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_maxInstancesCount :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_maxQueueSize :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_pinned :: Lens' LambdaExecutionParameters (Maybe Bool)
- lambdaExecutionParameters_statusTimeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_timeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- data LambdaFunctionRecipeSource = LambdaFunctionRecipeSource' {}
- newLambdaFunctionRecipeSource :: Text -> LambdaFunctionRecipeSource
- lambdaFunctionRecipeSource_componentDependencies :: Lens' LambdaFunctionRecipeSource (Maybe (HashMap Text ComponentDependencyRequirement))
- lambdaFunctionRecipeSource_componentLambdaParameters :: Lens' LambdaFunctionRecipeSource (Maybe LambdaExecutionParameters)
- lambdaFunctionRecipeSource_componentName :: Lens' LambdaFunctionRecipeSource (Maybe Text)
- lambdaFunctionRecipeSource_componentPlatforms :: Lens' LambdaFunctionRecipeSource (Maybe [ComponentPlatform])
- lambdaFunctionRecipeSource_componentVersion :: Lens' LambdaFunctionRecipeSource (Maybe Text)
- lambdaFunctionRecipeSource_lambdaArn :: Lens' LambdaFunctionRecipeSource Text
- data LambdaLinuxProcessParams = LambdaLinuxProcessParams' {}
- newLambdaLinuxProcessParams :: LambdaLinuxProcessParams
- lambdaLinuxProcessParams_containerParams :: Lens' LambdaLinuxProcessParams (Maybe LambdaContainerParams)
- lambdaLinuxProcessParams_isolationMode :: Lens' LambdaLinuxProcessParams (Maybe LambdaIsolationMode)
- data LambdaVolumeMount = LambdaVolumeMount' {}
- newLambdaVolumeMount :: Text -> Text -> LambdaVolumeMount
- lambdaVolumeMount_addGroupOwner :: Lens' LambdaVolumeMount (Maybe Bool)
- lambdaVolumeMount_permission :: Lens' LambdaVolumeMount (Maybe LambdaFilesystemPermission)
- lambdaVolumeMount_sourcePath :: Lens' LambdaVolumeMount Text
- lambdaVolumeMount_destinationPath :: Lens' LambdaVolumeMount Text
- data ResolvedComponentVersion = ResolvedComponentVersion' {}
- newResolvedComponentVersion :: ResolvedComponentVersion
- resolvedComponentVersion_arn :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_componentName :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_componentVersion :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_message :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_recipe :: Lens' ResolvedComponentVersion (Maybe ByteString)
- resolvedComponentVersion_vendorGuidance :: Lens' ResolvedComponentVersion (Maybe VendorGuidance)
- data SystemResourceLimits = SystemResourceLimits' {}
- newSystemResourceLimits :: SystemResourceLimits
- systemResourceLimits_cpus :: Lens' SystemResourceLimits (Maybe Double)
- systemResourceLimits_memory :: Lens' SystemResourceLimits (Maybe Natural)
Service Configuration
defaultService :: Service Source #
API version 2020-11-30 of the Amazon IoT Greengrass V2 SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have permission to perform the action.
_ConflictException :: AsError a => Fold a ServiceError Source #
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
_InternalServerException :: AsError a => Fold a ServiceError Source #
IoT Greengrass can't process your request right now. Try again later.
_RequestAlreadyInProgressException :: AsError a => Fold a ServiceError Source #
The request is already in progress. This exception occurs when you use a client token for multiple requests while IoT Greengrass is still processing an earlier request that uses the same client token.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource can't be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Your request exceeds a service quota. For example, you might have the maximum number of components that you can create.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.
_ValidationException :: AsError a => Fold a ServiceError Source #
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
CloudComponentState
newtype CloudComponentState Source #
Constructors
| CloudComponentState' | |
Fields | |
Bundled Patterns
| pattern CloudComponentState_DEPLOYABLE :: CloudComponentState | |
| pattern CloudComponentState_DEPRECATED :: CloudComponentState | |
| pattern CloudComponentState_FAILED :: CloudComponentState | |
| pattern CloudComponentState_INITIATED :: CloudComponentState | |
| pattern CloudComponentState_REQUESTED :: CloudComponentState |
Instances
ComponentDependencyType
newtype ComponentDependencyType Source #
Constructors
| ComponentDependencyType' | |
Fields | |
Bundled Patterns
| pattern ComponentDependencyType_HARD :: ComponentDependencyType | |
| pattern ComponentDependencyType_SOFT :: ComponentDependencyType |
Instances
ComponentVisibilityScope
newtype ComponentVisibilityScope Source #
Constructors
| ComponentVisibilityScope' | |
Fields | |
Bundled Patterns
| pattern ComponentVisibilityScope_PRIVATE :: ComponentVisibilityScope | |
| pattern ComponentVisibilityScope_PUBLIC :: ComponentVisibilityScope |
Instances
CoreDeviceStatus
newtype CoreDeviceStatus Source #
Constructors
| CoreDeviceStatus' | |
Fields | |
Bundled Patterns
| pattern CoreDeviceStatus_HEALTHY :: CoreDeviceStatus | |
| pattern CoreDeviceStatus_UNHEALTHY :: CoreDeviceStatus |
Instances
DeploymentComponentUpdatePolicyAction
newtype DeploymentComponentUpdatePolicyAction Source #
Constructors
| DeploymentComponentUpdatePolicyAction' | |
Bundled Patterns
Instances
DeploymentFailureHandlingPolicy
newtype DeploymentFailureHandlingPolicy Source #
Constructors
| DeploymentFailureHandlingPolicy' | |
Fields | |
Bundled Patterns
| pattern DeploymentFailureHandlingPolicy_DO_NOTHING :: DeploymentFailureHandlingPolicy | |
| pattern DeploymentFailureHandlingPolicy_ROLLBACK :: DeploymentFailureHandlingPolicy |
Instances
DeploymentHistoryFilter
newtype DeploymentHistoryFilter Source #
Constructors
| DeploymentHistoryFilter' | |
Fields | |
Bundled Patterns
| pattern DeploymentHistoryFilter_ALL :: DeploymentHistoryFilter | |
| pattern DeploymentHistoryFilter_LATEST_ONLY :: DeploymentHistoryFilter |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
Constructors
| DeploymentStatus' | |
Fields | |
Bundled Patterns
| pattern DeploymentStatus_ACTIVE :: DeploymentStatus | |
| pattern DeploymentStatus_CANCELED :: DeploymentStatus | |
| pattern DeploymentStatus_COMPLETED :: DeploymentStatus | |
| pattern DeploymentStatus_FAILED :: DeploymentStatus | |
| pattern DeploymentStatus_INACTIVE :: DeploymentStatus |
Instances
EffectiveDeploymentExecutionStatus
newtype EffectiveDeploymentExecutionStatus Source #
Constructors
| EffectiveDeploymentExecutionStatus' | |
Bundled Patterns
Instances
InstalledComponentLifecycleState
newtype InstalledComponentLifecycleState Source #
Constructors
| InstalledComponentLifecycleState' | |
Fields | |
Bundled Patterns
Instances
InstalledComponentTopologyFilter
newtype InstalledComponentTopologyFilter Source #
Constructors
| InstalledComponentTopologyFilter' | |
Fields | |
Bundled Patterns
| pattern InstalledComponentTopologyFilter_ALL :: InstalledComponentTopologyFilter | |
| pattern InstalledComponentTopologyFilter_ROOT :: InstalledComponentTopologyFilter |
Instances
IoTJobAbortAction
newtype IoTJobAbortAction Source #
Constructors
| IoTJobAbortAction' | |
Fields | |
Bundled Patterns
| pattern IoTJobAbortAction_CANCEL :: IoTJobAbortAction |
Instances
IoTJobExecutionFailureType
newtype IoTJobExecutionFailureType Source #
Constructors
| IoTJobExecutionFailureType' | |
Fields | |
Bundled Patterns
Instances
LambdaEventSourceType
newtype LambdaEventSourceType Source #
Constructors
| LambdaEventSourceType' | |
Fields | |
Bundled Patterns
| pattern LambdaEventSourceType_IOT_CORE :: LambdaEventSourceType | |
| pattern LambdaEventSourceType_PUB_SUB :: LambdaEventSourceType |
Instances
LambdaFilesystemPermission
newtype LambdaFilesystemPermission Source #
Constructors
| LambdaFilesystemPermission' | |
Fields | |
Bundled Patterns
| pattern LambdaFilesystemPermission_Ro :: LambdaFilesystemPermission | |
| pattern LambdaFilesystemPermission_Rw :: LambdaFilesystemPermission |
Instances
LambdaInputPayloadEncodingType
newtype LambdaInputPayloadEncodingType Source #
Constructors
| LambdaInputPayloadEncodingType' | |
Fields | |
Bundled Patterns
| pattern LambdaInputPayloadEncodingType_Binary :: LambdaInputPayloadEncodingType | |
| pattern LambdaInputPayloadEncodingType_Json :: LambdaInputPayloadEncodingType |
Instances
LambdaIsolationMode
newtype LambdaIsolationMode Source #
Constructors
| LambdaIsolationMode' | |
Fields | |
Bundled Patterns
| pattern LambdaIsolationMode_GreengrassContainer :: LambdaIsolationMode | |
| pattern LambdaIsolationMode_NoContainer :: LambdaIsolationMode |
Instances
RecipeOutputFormat
newtype RecipeOutputFormat Source #
Constructors
| RecipeOutputFormat' | |
Fields | |
Bundled Patterns
| pattern RecipeOutputFormat_JSON :: RecipeOutputFormat | |
| pattern RecipeOutputFormat_YAML :: RecipeOutputFormat |
Instances
VendorGuidance
newtype VendorGuidance Source #
Constructors
| VendorGuidance' | |
Fields | |
Bundled Patterns
| pattern VendorGuidance_ACTIVE :: VendorGuidance | |
| pattern VendorGuidance_DELETED :: VendorGuidance | |
| pattern VendorGuidance_DISCONTINUED :: VendorGuidance |
Instances
AssociateClientDeviceWithCoreDeviceEntry
data AssociateClientDeviceWithCoreDeviceEntry Source #
Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation consumes a list of these requests.
See: newAssociateClientDeviceWithCoreDeviceEntry smart constructor.
Constructors
| AssociateClientDeviceWithCoreDeviceEntry' | |
Instances
newAssociateClientDeviceWithCoreDeviceEntry Source #
Arguments
| :: Text | |
| -> AssociateClientDeviceWithCoreDeviceEntry |
Create a value of AssociateClientDeviceWithCoreDeviceEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thingName:AssociateClientDeviceWithCoreDeviceEntry', associateClientDeviceWithCoreDeviceEntry_thingName - The name of the IoT thing that represents the client device to
associate.
associateClientDeviceWithCoreDeviceEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceEntry Text Source #
The name of the IoT thing that represents the client device to associate.
AssociateClientDeviceWithCoreDeviceErrorEntry
data AssociateClientDeviceWithCoreDeviceErrorEntry Source #
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.
See: newAssociateClientDeviceWithCoreDeviceErrorEntry smart constructor.
Constructors
| AssociateClientDeviceWithCoreDeviceErrorEntry' | |
Instances
newAssociateClientDeviceWithCoreDeviceErrorEntry :: AssociateClientDeviceWithCoreDeviceErrorEntry Source #
Create a value of AssociateClientDeviceWithCoreDeviceErrorEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:AssociateClientDeviceWithCoreDeviceErrorEntry', associateClientDeviceWithCoreDeviceErrorEntry_code - The error code for the request.
$sel:message:AssociateClientDeviceWithCoreDeviceErrorEntry', associateClientDeviceWithCoreDeviceErrorEntry_message - A message that provides additional information about the error.
$sel:thingName:AssociateClientDeviceWithCoreDeviceErrorEntry', associateClientDeviceWithCoreDeviceErrorEntry_thingName - The name of the IoT thing whose associate request failed.
associateClientDeviceWithCoreDeviceErrorEntry_code :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
The error code for the request.
associateClientDeviceWithCoreDeviceErrorEntry_message :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
A message that provides additional information about the error.
associateClientDeviceWithCoreDeviceErrorEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
The name of the IoT thing whose associate request failed.
AssociatedClientDevice
data AssociatedClientDevice Source #
Contains information about a client device that is associated to a core device for cloud discovery.
See: newAssociatedClientDevice smart constructor.
Constructors
| AssociatedClientDevice' | |
Instances
newAssociatedClientDevice :: AssociatedClientDevice Source #
Create a value of AssociatedClientDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associationTimestamp:AssociatedClientDevice', associatedClientDevice_associationTimestamp - The time that the client device was associated, expressed in ISO 8601
format.
$sel:thingName:AssociatedClientDevice', associatedClientDevice_thingName - The name of the IoT thing that represents the associated client device.
associatedClientDevice_associationTimestamp :: Lens' AssociatedClientDevice (Maybe UTCTime) Source #
The time that the client device was associated, expressed in ISO 8601 format.
associatedClientDevice_thingName :: Lens' AssociatedClientDevice (Maybe Text) Source #
The name of the IoT thing that represents the associated client device.
CloudComponentStatus
data CloudComponentStatus Source #
Contains the status of a component version in the IoT Greengrass service.
See: newCloudComponentStatus smart constructor.
Constructors
| CloudComponentStatus' | |
Fields
| |
Instances
newCloudComponentStatus :: CloudComponentStatus Source #
Create a value of CloudComponentStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentState:CloudComponentStatus', cloudComponentStatus_componentState - The state of the component version.
$sel:errors:CloudComponentStatus', cloudComponentStatus_errors - A dictionary of errors that communicate why the component version is in
an error state. For example, if IoT Greengrass can't access an artifact
for the component version, then errors contains the artifact's URI as
a key, and the error message as the value for that key.
$sel:message:CloudComponentStatus', cloudComponentStatus_message - A message that communicates details, such as errors, about the status of
the component version.
$sel:vendorGuidance:CloudComponentStatus', cloudComponentStatus_vendorGuidance - The vendor guidance state for the component version. This state
indicates whether the component version has any issues that you should
consider before you deploy it. The vendor guidance state can be:
ACTIVE– This component version is available and recommended for use.DISCONTINUED– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
$sel:vendorGuidanceMessage:CloudComponentStatus', cloudComponentStatus_vendorGuidanceMessage - A message that communicates details about the vendor guidance state of
the component version. This message communicates why a component version
is discontinued or deleted.
cloudComponentStatus_componentState :: Lens' CloudComponentStatus (Maybe CloudComponentState) Source #
The state of the component version.
cloudComponentStatus_errors :: Lens' CloudComponentStatus (Maybe (HashMap Text Text)) Source #
A dictionary of errors that communicate why the component version is in
an error state. For example, if IoT Greengrass can't access an artifact
for the component version, then errors contains the artifact's URI as
a key, and the error message as the value for that key.
cloudComponentStatus_message :: Lens' CloudComponentStatus (Maybe Text) Source #
A message that communicates details, such as errors, about the status of the component version.
cloudComponentStatus_vendorGuidance :: Lens' CloudComponentStatus (Maybe VendorGuidance) Source #
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE– This component version is available and recommended for use.DISCONTINUED– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
cloudComponentStatus_vendorGuidanceMessage :: Lens' CloudComponentStatus (Maybe Text) Source #
A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.
Component
Contains information about a component.
See: newComponent smart constructor.
Constructors
| Component' | |
Fields
| |
Instances
| FromJSON Component Source # | |
| Generic Component Source # | |
| Read Component Source # | |
| Show Component Source # | |
| NFData Component Source # | |
Defined in Amazonka.GreengrassV2.Types.Component | |
| Eq Component Source # | |
| Hashable Component Source # | |
Defined in Amazonka.GreengrassV2.Types.Component | |
| type Rep Component Source # | |
Defined in Amazonka.GreengrassV2.Types.Component type Rep Component = D1 ('MetaData "Component" "Amazonka.GreengrassV2.Types.Component" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "Component'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentLatestVersion))))) | |
newComponent :: Component Source #
Create a value of Component with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Component, component_arn - The
ARN
of the component version.
$sel:componentName:Component', component_componentName - The name of the component.
$sel:latestVersion:Component', component_latestVersion - The latest version of the component and its details.
component_latestVersion :: Lens' Component (Maybe ComponentLatestVersion) Source #
The latest version of the component and its details.
ComponentCandidate
data ComponentCandidate Source #
Contains information about a component that is a candidate to deploy to a Greengrass core device.
See: newComponentCandidate smart constructor.
Constructors
| ComponentCandidate' | |
Fields
| |
Instances
newComponentCandidate :: ComponentCandidate Source #
Create a value of ComponentCandidate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentName:ComponentCandidate', componentCandidate_componentName - The name of the component.
$sel:componentVersion:ComponentCandidate', componentCandidate_componentVersion - The version of the component.
$sel:versionRequirements:ComponentCandidate', componentCandidate_versionRequirements - The version requirements for the component's dependencies. Greengrass
core devices get the version requirements from component recipes.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
componentCandidate_componentName :: Lens' ComponentCandidate (Maybe Text) Source #
The name of the component.
componentCandidate_componentVersion :: Lens' ComponentCandidate (Maybe Text) Source #
The version of the component.
componentCandidate_versionRequirements :: Lens' ComponentCandidate (Maybe (HashMap Text Text)) Source #
The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
ComponentConfigurationUpdate
data ComponentConfigurationUpdate Source #
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.
See: newComponentConfigurationUpdate smart constructor.
Constructors
| ComponentConfigurationUpdate' | |
Fields
| |
Instances
newComponentConfigurationUpdate :: ComponentConfigurationUpdate Source #
Create a value of ComponentConfigurationUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:merge:ComponentConfigurationUpdate', componentConfigurationUpdate_merge - A serialized JSON string that contains the configuration object to merge
to target devices. The core device merges this configuration with the
component's existing configuration. If this is the first time a
component deploys on a device, the core device merges this configuration
with the component's default configuration. This means that the core
device keeps it's existing configuration for keys and values that you
don't specify in this object. For more information, see
Merge configuration updates
in the IoT Greengrass V2 Developer Guide.
$sel:reset:ComponentConfigurationUpdate', componentConfigurationUpdate_reset - The list of configuration nodes to reset to default values on target
devices. Use JSON pointers to specify each node to reset. JSON pointers
start with a forward slash (/) and use forward slashes to separate
the key for each level in the object. For more information, see the
JSON pointer specification and
Reset configuration updates
in the IoT Greengrass V2 Developer Guide.
componentConfigurationUpdate_merge :: Lens' ComponentConfigurationUpdate (Maybe Text) Source #
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the IoT Greengrass V2 Developer Guide.
componentConfigurationUpdate_reset :: Lens' ComponentConfigurationUpdate (Maybe [Text]) Source #
The list of configuration nodes to reset to default values on target
devices. Use JSON pointers to specify each node to reset. JSON pointers
start with a forward slash (/) and use forward slashes to separate
the key for each level in the object. For more information, see the
JSON pointer specification and
Reset configuration updates
in the IoT Greengrass V2 Developer Guide.
ComponentDependencyRequirement
data ComponentDependencyRequirement Source #
Contains information about a component dependency for a Lambda function component.
See: newComponentDependencyRequirement smart constructor.
Constructors
| ComponentDependencyRequirement' | |
Fields
| |
Instances
newComponentDependencyRequirement :: ComponentDependencyRequirement Source #
Create a value of ComponentDependencyRequirement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dependencyType:ComponentDependencyRequirement', componentDependencyRequirement_dependencyType - The type of this dependency. Choose from the following options:
SOFT– The component doesn't restart if the dependency changes state.HARD– The component restarts if the dependency changes state.
Default: HARD
$sel:versionRequirement:ComponentDependencyRequirement', componentDependencyRequirement_versionRequirement - The component version requirement for the component dependency.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
componentDependencyRequirement_dependencyType :: Lens' ComponentDependencyRequirement (Maybe ComponentDependencyType) Source #
The type of this dependency. Choose from the following options:
SOFT– The component doesn't restart if the dependency changes state.HARD– The component restarts if the dependency changes state.
Default: HARD
componentDependencyRequirement_versionRequirement :: Lens' ComponentDependencyRequirement (Maybe Text) Source #
The component version requirement for the component dependency.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
ComponentDeploymentSpecification
data ComponentDeploymentSpecification Source #
Contains information about a component to deploy.
See: newComponentDeploymentSpecification smart constructor.
Constructors
| ComponentDeploymentSpecification' | |
Fields
| |
Instances
newComponentDeploymentSpecification :: ComponentDeploymentSpecification Source #
Create a value of ComponentDeploymentSpecification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentVersion:ComponentDeploymentSpecification', componentDeploymentSpecification_componentVersion - The version of the component.
$sel:configurationUpdate:ComponentDeploymentSpecification', componentDeploymentSpecification_configurationUpdate - The configuration updates to deploy for the component. You can define
reset updates and merge updates. A reset updates the keys that you
specify to the default configuration for the component. A merge updates
the core device's component configuration with the keys and values that
you specify. The IoT Greengrass Core software applies reset updates
before it applies merge updates. For more information, see
Update component configurations
in the IoT Greengrass V2 Developer Guide.
$sel:runWith:ComponentDeploymentSpecification', componentDeploymentSpecification_runWith - The system user and group that the IoT Greengrass Core software uses to
run component processes on the core device. If you omit this parameter,
the IoT Greengrass Core software uses the system user and group that you
configure for the core device. For more information, see
Configure the user and group that run components
in the IoT Greengrass V2 Developer Guide.
componentDeploymentSpecification_componentVersion :: Lens' ComponentDeploymentSpecification (Maybe Text) Source #
The version of the component.
componentDeploymentSpecification_configurationUpdate :: Lens' ComponentDeploymentSpecification (Maybe ComponentConfigurationUpdate) Source #
The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.
componentDeploymentSpecification_runWith :: Lens' ComponentDeploymentSpecification (Maybe ComponentRunWith) Source #
The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.
ComponentLatestVersion
data ComponentLatestVersion Source #
Contains information about the latest version of a component.
See: newComponentLatestVersion smart constructor.
Constructors
| ComponentLatestVersion' | |
Fields
| |
Instances
newComponentLatestVersion :: ComponentLatestVersion Source #
Create a value of ComponentLatestVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ComponentLatestVersion', componentLatestVersion_arn - The
ARN
of the component version.
$sel:componentVersion:ComponentLatestVersion', componentLatestVersion_componentVersion - The version of the component.
$sel:creationTimestamp:ComponentLatestVersion', componentLatestVersion_creationTimestamp - The time at which the component was created, expressed in ISO 8601
format.
$sel:description:ComponentLatestVersion', componentLatestVersion_description - The description of the component version.
$sel:platforms:ComponentLatestVersion', componentLatestVersion_platforms - The platforms that the component version supports.
$sel:publisher:ComponentLatestVersion', componentLatestVersion_publisher - The publisher of the component version.
componentLatestVersion_arn :: Lens' ComponentLatestVersion (Maybe Text) Source #
The ARN of the component version.
componentLatestVersion_componentVersion :: Lens' ComponentLatestVersion (Maybe Text) Source #
The version of the component.
componentLatestVersion_creationTimestamp :: Lens' ComponentLatestVersion (Maybe UTCTime) Source #
The time at which the component was created, expressed in ISO 8601 format.
componentLatestVersion_description :: Lens' ComponentLatestVersion (Maybe Text) Source #
The description of the component version.
componentLatestVersion_platforms :: Lens' ComponentLatestVersion (Maybe [ComponentPlatform]) Source #
The platforms that the component version supports.
componentLatestVersion_publisher :: Lens' ComponentLatestVersion (Maybe Text) Source #
The publisher of the component version.
ComponentPlatform
data ComponentPlatform Source #
Contains information about a platform that a component supports.
See: newComponentPlatform smart constructor.
Constructors
| ComponentPlatform' | |
Fields
| |
Instances
newComponentPlatform :: ComponentPlatform Source #
Create a value of ComponentPlatform with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:ComponentPlatform', componentPlatform_attributes - A dictionary of attributes for the platform. The IoT Greengrass Core
software defines the os and architecture by default. You can specify
additional platform attributes for a core device when you deploy the
Greengrass nucleus component. For more information, see the
Greengrass nucleus component
in the IoT Greengrass V2 Developer Guide.
$sel:name:ComponentPlatform', componentPlatform_name - The friendly name of the platform. This name helps you identify the
platform.
If you omit this parameter, IoT Greengrass creates a friendly name from
the os and architecture of the platform.
componentPlatform_attributes :: Lens' ComponentPlatform (Maybe (HashMap Text Text)) Source #
A dictionary of attributes for the platform. The IoT Greengrass Core
software defines the os and architecture by default. You can specify
additional platform attributes for a core device when you deploy the
Greengrass nucleus component. For more information, see the
Greengrass nucleus component
in the IoT Greengrass V2 Developer Guide.
componentPlatform_name :: Lens' ComponentPlatform (Maybe Text) Source #
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, IoT Greengrass creates a friendly name from
the os and architecture of the platform.
ComponentRunWith
data ComponentRunWith Source #
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.
See: newComponentRunWith smart constructor.
Constructors
| ComponentRunWith' | |
Fields
| |
Instances
newComponentRunWith :: ComponentRunWith Source #
Create a value of ComponentRunWith with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:posixUser:ComponentRunWith', componentRunWith_posixUser - The POSIX system user and, optionally, group to use to run this
component on Linux core devices. The user, and group if specified, must
exist on each Linux core device. Specify the user and group separated by
a colon (:) in the following format: user:group. The group is
optional. If you don't specify a group, the IoT Greengrass Core
software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
$sel:systemResourceLimits:ComponentRunWith', componentRunWith_systemResourceLimits - The system resource limits to apply to this component's process on the
core device. IoT Greengrass currently supports this feature on only
Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
$sel:windowsUser:ComponentRunWith', componentRunWith_windowsUser - The Windows user to use to run this component on Windows core devices.
The user must exist on each Windows core device, and its name and
password must be in the LocalSystem account's Credentials Manager
instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
componentRunWith_posixUser :: Lens' ComponentRunWith (Maybe Text) Source #
The POSIX system user and, optionally, group to use to run this
component on Linux core devices. The user, and group if specified, must
exist on each Linux core device. Specify the user and group separated by
a colon (:) in the following format: user:group. The group is
optional. If you don't specify a group, the IoT Greengrass Core
software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
componentRunWith_systemResourceLimits :: Lens' ComponentRunWith (Maybe SystemResourceLimits) Source #
The system resource limits to apply to this component's process on the core device. IoT Greengrass currently supports this feature on only Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
componentRunWith_windowsUser :: Lens' ComponentRunWith (Maybe Text) Source #
The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
ComponentVersionListItem
data ComponentVersionListItem Source #
Contains information about a component version in a list.
See: newComponentVersionListItem smart constructor.
Constructors
| ComponentVersionListItem' | |
Fields
| |
Instances
newComponentVersionListItem :: ComponentVersionListItem Source #
Create a value of ComponentVersionListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ComponentVersionListItem', componentVersionListItem_arn - The
ARN
of the component version.
$sel:componentName:ComponentVersionListItem', componentVersionListItem_componentName - The name of the component.
$sel:componentVersion:ComponentVersionListItem', componentVersionListItem_componentVersion - The version of the component.
componentVersionListItem_arn :: Lens' ComponentVersionListItem (Maybe Text) Source #
The ARN of the component version.
componentVersionListItem_componentName :: Lens' ComponentVersionListItem (Maybe Text) Source #
The name of the component.
componentVersionListItem_componentVersion :: Lens' ComponentVersionListItem (Maybe Text) Source #
The version of the component.
ConnectivityInfo
data ConnectivityInfo Source #
Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.
See: newConnectivityInfo smart constructor.
Constructors
| ConnectivityInfo' | |
Fields
| |
Instances
newConnectivityInfo :: ConnectivityInfo Source #
Create a value of ConnectivityInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostAddress:ConnectivityInfo', connectivityInfo_hostAddress - The IP address or DNS address where client devices can connect to an
MQTT broker on the Greengrass core device.
$sel:id:ConnectivityInfo', connectivityInfo_id - An ID for the connectivity information.
$sel:metadata:ConnectivityInfo', connectivityInfo_metadata - Additional metadata to provide to client devices that connect to this
core device.
$sel:portNumber:ConnectivityInfo', connectivityInfo_portNumber - The port where the MQTT broker operates on the core device. This port is
typically 8883, which is the default port for the MQTT broker component
that runs on core devices.
connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text) Source #
The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.
connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text) Source #
An ID for the connectivity information.
connectivityInfo_metadata :: Lens' ConnectivityInfo (Maybe Text) Source #
Additional metadata to provide to client devices that connect to this core device.
connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Natural) Source #
The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.
CoreDevice
data CoreDevice Source #
Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.
See: newCoreDevice smart constructor.
Constructors
| CoreDevice' | |
Fields
| |
Instances
newCoreDevice :: CoreDevice Source #
Create a value of CoreDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:coreDeviceThingName:CoreDevice', coreDevice_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.
$sel:lastStatusUpdateTimestamp:CoreDevice', coreDevice_lastStatusUpdateTimestamp - The time at which the core device's status last updated, expressed in
ISO 8601 format.
$sel:status:CoreDevice', coreDevice_status - The status of the core device. Core devices can have the following
statuses:
HEALTHY– The IoT Greengrass Core software and all components run on the core device without issue.UNHEALTHY– The IoT Greengrass Core software or a component is in a failed state on the core device.
coreDevice_coreDeviceThingName :: Lens' CoreDevice (Maybe Text) Source #
The name of the core device. This is also the name of the IoT thing.
coreDevice_lastStatusUpdateTimestamp :: Lens' CoreDevice (Maybe UTCTime) Source #
The time at which the core device's status last updated, expressed in ISO 8601 format.
coreDevice_status :: Lens' CoreDevice (Maybe CoreDeviceStatus) Source #
The status of the core device. Core devices can have the following statuses:
HEALTHY– The IoT Greengrass Core software and all components run on the core device without issue.UNHEALTHY– The IoT Greengrass Core software or a component is in a failed state on the core device.
Deployment
data Deployment Source #
Contains information about a deployment.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTimestamp:Deployment', deployment_creationTimestamp - The time at which the deployment was created, expressed in ISO 8601
format.
$sel:deploymentId:Deployment', deployment_deploymentId - The ID of the deployment.
$sel:deploymentName:Deployment', deployment_deploymentName - The name of the deployment.
$sel:deploymentStatus:Deployment', deployment_deploymentStatus - The status of the deployment.
$sel:isLatestForTarget:Deployment', deployment_isLatestForTarget - Whether or not the deployment is the latest revision for its target.
$sel:parentTargetArn:Deployment', deployment_parentTargetArn - The parent deployment's target
ARN
within a subdeployment.
$sel:revisionId:Deployment', deployment_revisionId - The revision number of the deployment.
$sel:targetArn:Deployment', deployment_targetArn - The
ARN
of the target IoT thing or thing group. When creating a subdeployment,
the targetARN can only be a thing group.
deployment_creationTimestamp :: Lens' Deployment (Maybe UTCTime) Source #
The time at which the deployment was created, expressed in ISO 8601 format.
deployment_deploymentId :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment.
deployment_deploymentName :: Lens' Deployment (Maybe Text) Source #
The name of the deployment.
deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus) Source #
The status of the deployment.
deployment_isLatestForTarget :: Lens' Deployment (Maybe Bool) Source #
Whether or not the deployment is the latest revision for its target.
deployment_parentTargetArn :: Lens' Deployment (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
deployment_revisionId :: Lens' Deployment (Maybe Text) Source #
The revision number of the deployment.
deployment_targetArn :: Lens' Deployment (Maybe Text) Source #
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
DeploymentComponentUpdatePolicy
data DeploymentComponentUpdatePolicy Source #
Contains information about a deployment's policy that defines when components are safe to update.
Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.
See: newDeploymentComponentUpdatePolicy smart constructor.
Constructors
| DeploymentComponentUpdatePolicy' | |
Fields
| |
Instances
newDeploymentComponentUpdatePolicy :: DeploymentComponentUpdatePolicy Source #
Create a value of DeploymentComponentUpdatePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:DeploymentComponentUpdatePolicy', deploymentComponentUpdatePolicy_action - Whether or not to notify components and wait for components to become
safe to update. Choose from the following options:
NOTIFY_COMPONENTS– The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.SKIP_NOTIFY_COMPONENTS– The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
$sel:timeoutInSeconds:DeploymentComponentUpdatePolicy', deploymentComponentUpdatePolicy_timeoutInSeconds - The amount of time in seconds that each component on a device has to
report that it's safe to update. If the component waits for longer than
this timeout, then the deployment proceeds on the device.
Default: 60
deploymentComponentUpdatePolicy_action :: Lens' DeploymentComponentUpdatePolicy (Maybe DeploymentComponentUpdatePolicyAction) Source #
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS– The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.SKIP_NOTIFY_COMPONENTS– The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
deploymentComponentUpdatePolicy_timeoutInSeconds :: Lens' DeploymentComponentUpdatePolicy (Maybe Int) Source #
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
DeploymentConfigurationValidationPolicy
data DeploymentConfigurationValidationPolicy Source #
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.
See: newDeploymentConfigurationValidationPolicy smart constructor.
Constructors
| DeploymentConfigurationValidationPolicy' | |
Fields
| |
Instances
newDeploymentConfigurationValidationPolicy :: DeploymentConfigurationValidationPolicy Source #
Create a value of DeploymentConfigurationValidationPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeoutInSeconds:DeploymentConfigurationValidationPolicy', deploymentConfigurationValidationPolicy_timeoutInSeconds - The amount of time in seconds that a component can validate its
configuration updates. If the validation time exceeds this timeout, then
the deployment proceeds for the device.
Default: 30
deploymentConfigurationValidationPolicy_timeoutInSeconds :: Lens' DeploymentConfigurationValidationPolicy (Maybe Int) Source #
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
DeploymentIoTJobConfiguration
data DeploymentIoTJobConfiguration Source #
Contains information about an IoT job configuration.
See: newDeploymentIoTJobConfiguration smart constructor.
Constructors
| DeploymentIoTJobConfiguration' | |
Fields
| |
Instances
newDeploymentIoTJobConfiguration :: DeploymentIoTJobConfiguration Source #
Create a value of DeploymentIoTJobConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:abortConfig:DeploymentIoTJobConfiguration', deploymentIoTJobConfiguration_abortConfig - The stop configuration for the job. This configuration defines when and
how to stop a job rollout.
$sel:jobExecutionsRolloutConfig:DeploymentIoTJobConfiguration', deploymentIoTJobConfiguration_jobExecutionsRolloutConfig - The rollout configuration for the job. This configuration defines the
rate at which the job rolls out to the fleet of target devices.
$sel:timeoutConfig:DeploymentIoTJobConfiguration', deploymentIoTJobConfiguration_timeoutConfig - The timeout configuration for the job. This configuration defines the
amount of time each device has to complete the job.
deploymentIoTJobConfiguration_abortConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobAbortConfig) Source #
The stop configuration for the job. This configuration defines when and how to stop a job rollout.
deploymentIoTJobConfiguration_jobExecutionsRolloutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobExecutionsRolloutConfig) Source #
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
deploymentIoTJobConfiguration_timeoutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobTimeoutConfig) Source #
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
DeploymentPolicies
data DeploymentPolicies Source #
Contains information about policies that define how a deployment updates components and handles failure.
See: newDeploymentPolicies smart constructor.
Constructors
| DeploymentPolicies' | |
Fields
| |
Instances
newDeploymentPolicies :: DeploymentPolicies Source #
Create a value of DeploymentPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentUpdatePolicy:DeploymentPolicies', deploymentPolicies_componentUpdatePolicy - The component update policy for the configuration deployment. This
policy defines when it's safe to deploy the configuration to devices.
$sel:configurationValidationPolicy:DeploymentPolicies', deploymentPolicies_configurationValidationPolicy - The configuration validation policy for the configuration deployment.
This policy defines how long each component has to validate its
configure updates.
$sel:failureHandlingPolicy:DeploymentPolicies', deploymentPolicies_failureHandlingPolicy - The failure handling policy for the configuration deployment. This
policy defines what to do if the deployment fails.
Default: ROLLBACK
deploymentPolicies_componentUpdatePolicy :: Lens' DeploymentPolicies (Maybe DeploymentComponentUpdatePolicy) Source #
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.
deploymentPolicies_configurationValidationPolicy :: Lens' DeploymentPolicies (Maybe DeploymentConfigurationValidationPolicy) Source #
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
deploymentPolicies_failureHandlingPolicy :: Lens' DeploymentPolicies (Maybe DeploymentFailureHandlingPolicy) Source #
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
DisassociateClientDeviceFromCoreDeviceEntry
data DisassociateClientDeviceFromCoreDeviceEntry Source #
Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation consumes a list of these requests.
See: newDisassociateClientDeviceFromCoreDeviceEntry smart constructor.
Constructors
| DisassociateClientDeviceFromCoreDeviceEntry' | |
Instances
newDisassociateClientDeviceFromCoreDeviceEntry Source #
Arguments
| :: Text | |
| -> DisassociateClientDeviceFromCoreDeviceEntry |
Create a value of DisassociateClientDeviceFromCoreDeviceEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thingName:DisassociateClientDeviceFromCoreDeviceEntry', disassociateClientDeviceFromCoreDeviceEntry_thingName - The name of the IoT thing that represents the client device to
disassociate.
disassociateClientDeviceFromCoreDeviceEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceEntry Text Source #
The name of the IoT thing that represents the client device to disassociate.
DisassociateClientDeviceFromCoreDeviceErrorEntry
data DisassociateClientDeviceFromCoreDeviceErrorEntry Source #
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.
See: newDisassociateClientDeviceFromCoreDeviceErrorEntry smart constructor.
Instances
newDisassociateClientDeviceFromCoreDeviceErrorEntry :: DisassociateClientDeviceFromCoreDeviceErrorEntry Source #
Create a value of DisassociateClientDeviceFromCoreDeviceErrorEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:DisassociateClientDeviceFromCoreDeviceErrorEntry', disassociateClientDeviceFromCoreDeviceErrorEntry_code - The error code for the request.
$sel:message:DisassociateClientDeviceFromCoreDeviceErrorEntry', disassociateClientDeviceFromCoreDeviceErrorEntry_message - A message that provides additional information about the error.
$sel:thingName:DisassociateClientDeviceFromCoreDeviceErrorEntry', disassociateClientDeviceFromCoreDeviceErrorEntry_thingName - The name of the IoT thing whose disassociate request failed.
disassociateClientDeviceFromCoreDeviceErrorEntry_code :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
The error code for the request.
disassociateClientDeviceFromCoreDeviceErrorEntry_message :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
A message that provides additional information about the error.
disassociateClientDeviceFromCoreDeviceErrorEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
The name of the IoT thing whose disassociate request failed.
EffectiveDeployment
data EffectiveDeployment Source #
Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
See: newEffectiveDeployment smart constructor.
Constructors
| EffectiveDeployment' | |
Fields
| |
Instances
newEffectiveDeployment Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> EffectiveDeploymentExecutionStatus | |
| -> UTCTime | |
| -> UTCTime | |
| -> EffectiveDeployment |
Create a value of EffectiveDeployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:EffectiveDeployment', effectiveDeployment_description - The description of the deployment job.
$sel:iotJobArn:EffectiveDeployment', effectiveDeployment_iotJobArn - The
ARN
of the IoT job that applies the deployment to target devices.
$sel:iotJobId:EffectiveDeployment', effectiveDeployment_iotJobId - The ID of the IoT job that applies the deployment to target devices.
$sel:reason:EffectiveDeployment', effectiveDeployment_reason - The reason code for the update, if the job was updated.
$sel:statusDetails:EffectiveDeployment', effectiveDeployment_statusDetails - The status details that explain why a deployment has an error. This
response will be null if the deployment is in a success state.
$sel:deploymentId:EffectiveDeployment', effectiveDeployment_deploymentId - The ID of the deployment.
$sel:deploymentName:EffectiveDeployment', effectiveDeployment_deploymentName - The name of the deployment.
$sel:targetArn:EffectiveDeployment', effectiveDeployment_targetArn - The
ARN
of the target IoT thing or thing group.
$sel:coreDeviceExecutionStatus:EffectiveDeployment', effectiveDeployment_coreDeviceExecutionStatus - The status of the deployment job on the Greengrass core device.
$sel:creationTimestamp:EffectiveDeployment', effectiveDeployment_creationTimestamp - The time at which the deployment was created, expressed in ISO 8601
format.
$sel:modifiedTimestamp:EffectiveDeployment', effectiveDeployment_modifiedTimestamp - The time at which the deployment job was last modified, expressed in ISO
8601 format.
effectiveDeployment_description :: Lens' EffectiveDeployment (Maybe Text) Source #
The description of the deployment job.
effectiveDeployment_iotJobArn :: Lens' EffectiveDeployment (Maybe Text) Source #
The ARN of the IoT job that applies the deployment to target devices.
effectiveDeployment_iotJobId :: Lens' EffectiveDeployment (Maybe Text) Source #
The ID of the IoT job that applies the deployment to target devices.
effectiveDeployment_reason :: Lens' EffectiveDeployment (Maybe Text) Source #
The reason code for the update, if the job was updated.
effectiveDeployment_statusDetails :: Lens' EffectiveDeployment (Maybe EffectiveDeploymentStatusDetails) Source #
The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
effectiveDeployment_deploymentId :: Lens' EffectiveDeployment Text Source #
The ID of the deployment.
effectiveDeployment_deploymentName :: Lens' EffectiveDeployment Text Source #
The name of the deployment.
effectiveDeployment_targetArn :: Lens' EffectiveDeployment Text Source #
The ARN of the target IoT thing or thing group.
effectiveDeployment_coreDeviceExecutionStatus :: Lens' EffectiveDeployment EffectiveDeploymentExecutionStatus Source #
The status of the deployment job on the Greengrass core device.
effectiveDeployment_creationTimestamp :: Lens' EffectiveDeployment UTCTime Source #
The time at which the deployment was created, expressed in ISO 8601 format.
effectiveDeployment_modifiedTimestamp :: Lens' EffectiveDeployment UTCTime Source #
The time at which the deployment job was last modified, expressed in ISO 8601 format.
EffectiveDeploymentStatusDetails
data EffectiveDeploymentStatusDetails Source #
Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state.
Greengrass nucleus v2.8.0 or later is required to get an accurate
errorStack and errorTypes response. This field will not be returned
for earlier Greengrass nucleus versions.
See: newEffectiveDeploymentStatusDetails smart constructor.
Constructors
| EffectiveDeploymentStatusDetails' | |
Fields
| |
Instances
newEffectiveDeploymentStatusDetails :: EffectiveDeploymentStatusDetails Source #
Create a value of EffectiveDeploymentStatusDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorStack:EffectiveDeploymentStatusDetails', effectiveDeploymentStatusDetails_errorStack - Contains an ordered list of short error codes that range from the most
generic error to the most specific one. The error codes describe the
reason for failure whenever the coreDeviceExecutionStatus is in a
failed state. The response will be an empty list if there is no error.
$sel:errorTypes:EffectiveDeploymentStatusDetails', effectiveDeploymentStatusDetails_errorTypes - Contains tags which describe the error. You can use the error types to
classify errors to assist with remediating the failure. The response
will be an empty list if there is no error.
effectiveDeploymentStatusDetails_errorStack :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text]) Source #
Contains an ordered list of short error codes that range from the most
generic error to the most specific one. The error codes describe the
reason for failure whenever the coreDeviceExecutionStatus is in a
failed state. The response will be an empty list if there is no error.
effectiveDeploymentStatusDetails_errorTypes :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text]) Source #
Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.
InstalledComponent
data InstalledComponent Source #
Contains information about a component on a Greengrass core device.
See: newInstalledComponent smart constructor.
Constructors
| InstalledComponent' | |
Fields
| |
Instances
newInstalledComponent :: InstalledComponent Source #
Create a value of InstalledComponent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentName:InstalledComponent', installedComponent_componentName - The name of the component.
$sel:componentVersion:InstalledComponent', installedComponent_componentVersion - The version of the component.
$sel:isRoot:InstalledComponent', installedComponent_isRoot - Whether or not the component is a root component.
$sel:lastInstallationSource:InstalledComponent', installedComponent_lastInstallationSource - The most recent deployment source that brought the component to the
Greengrass core device. For a thing group deployment or thing
deployment, the source will be the The ID of the deployment. and for
local deployments it will be LOCAL.
$sel:lastReportedTimestamp:InstalledComponent', installedComponent_lastReportedTimestamp - The last time the Greengrass core device sent a message containing a
certain component to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
$sel:lastStatusChangeTimestamp:InstalledComponent', installedComponent_lastStatusChangeTimestamp - The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
$sel:lifecycleState:InstalledComponent', installedComponent_lifecycleState - The lifecycle state of the component.
$sel:lifecycleStateDetails:InstalledComponent', installedComponent_lifecycleStateDetails - A detailed response about the lifecycle state of the component that
explains the reason why a component has an error or is broken.
$sel:lifecycleStatusCodes:InstalledComponent', installedComponent_lifecycleStatusCodes - The status codes that indicate the reason for failure whenever the
lifecycleState has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lifecycleStatusCodes response. This response can be inaccurate in
earlier Greengrass nucleus versions.
installedComponent_componentName :: Lens' InstalledComponent (Maybe Text) Source #
The name of the component.
installedComponent_componentVersion :: Lens' InstalledComponent (Maybe Text) Source #
The version of the component.
installedComponent_isRoot :: Lens' InstalledComponent (Maybe Bool) Source #
Whether or not the component is a root component.
installedComponent_lastInstallationSource :: Lens' InstalledComponent (Maybe Text) Source #
The most recent deployment source that brought the component to the
Greengrass core device. For a thing group deployment or thing
deployment, the source will be the The ID of the deployment. and for
local deployments it will be LOCAL.
installedComponent_lastReportedTimestamp :: Lens' InstalledComponent (Maybe UTCTime) Source #
The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
installedComponent_lastStatusChangeTimestamp :: Lens' InstalledComponent (Maybe UTCTime) Source #
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
installedComponent_lifecycleState :: Lens' InstalledComponent (Maybe InstalledComponentLifecycleState) Source #
The lifecycle state of the component.
installedComponent_lifecycleStateDetails :: Lens' InstalledComponent (Maybe Text) Source #
A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
installedComponent_lifecycleStatusCodes :: Lens' InstalledComponent (Maybe [Text]) Source #
The status codes that indicate the reason for failure whenever the
lifecycleState has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lifecycleStatusCodes response. This response can be inaccurate in
earlier Greengrass nucleus versions.
IoTJobAbortConfig
data IoTJobAbortConfig Source #
Contains a list of criteria that define when and how to cancel a configuration deployment.
See: newIoTJobAbortConfig smart constructor.
Constructors
| IoTJobAbortConfig' | |
Fields
| |
Instances
Create a value of IoTJobAbortConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:criteriaList:IoTJobAbortConfig', ioTJobAbortConfig_criteriaList - The list of criteria that define when and how to cancel the
configuration deployment.
ioTJobAbortConfig_criteriaList :: Lens' IoTJobAbortConfig (NonEmpty IoTJobAbortCriteria) Source #
The list of criteria that define when and how to cancel the configuration deployment.
IoTJobAbortCriteria
data IoTJobAbortCriteria Source #
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
- The number of things that receive the deployment exceeds the
minNumberOfExecutedThings. - The percentage of failures with type
failureTypeexceeds thethresholdPercentage.
See: newIoTJobAbortCriteria smart constructor.
Constructors
| IoTJobAbortCriteria' | |
Fields
| |
Instances
newIoTJobAbortCriteria Source #
Arguments
| :: IoTJobExecutionFailureType | |
| -> IoTJobAbortAction | |
| -> Double | |
| -> Natural | |
| -> IoTJobAbortCriteria |
Create a value of IoTJobAbortCriteria with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureType:IoTJobAbortCriteria', ioTJobAbortCriteria_failureType - The type of job deployment failure that can cancel a job.
$sel:action:IoTJobAbortCriteria', ioTJobAbortCriteria_action - The action to perform when the criteria are met.
$sel:thresholdPercentage:IoTJobAbortCriteria', ioTJobAbortCriteria_thresholdPercentage - The minimum percentage of failureType failures that occur before the
job can cancel.
This parameter supports up to two digits after the decimal (for example,
you can specify 10.9 or 10.99, but not 10.999).
$sel:minNumberOfExecutedThings:IoTJobAbortCriteria', ioTJobAbortCriteria_minNumberOfExecutedThings - The minimum number of things that receive the configuration before the
job can cancel.
ioTJobAbortCriteria_failureType :: Lens' IoTJobAbortCriteria IoTJobExecutionFailureType Source #
The type of job deployment failure that can cancel a job.
ioTJobAbortCriteria_action :: Lens' IoTJobAbortCriteria IoTJobAbortAction Source #
The action to perform when the criteria are met.
ioTJobAbortCriteria_thresholdPercentage :: Lens' IoTJobAbortCriteria Double Source #
The minimum percentage of failureType failures that occur before the
job can cancel.
This parameter supports up to two digits after the decimal (for example,
you can specify 10.9 or 10.99, but not 10.999).
ioTJobAbortCriteria_minNumberOfExecutedThings :: Lens' IoTJobAbortCriteria Natural Source #
The minimum number of things that receive the configuration before the job can cancel.
IoTJobExecutionsRolloutConfig
data IoTJobExecutionsRolloutConfig Source #
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.
See: newIoTJobExecutionsRolloutConfig smart constructor.
Constructors
| IoTJobExecutionsRolloutConfig' | |
Fields
| |
Instances
newIoTJobExecutionsRolloutConfig :: IoTJobExecutionsRolloutConfig Source #
Create a value of IoTJobExecutionsRolloutConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exponentialRate:IoTJobExecutionsRolloutConfig', ioTJobExecutionsRolloutConfig_exponentialRate - The exponential rate to increase the job rollout rate.
$sel:maximumPerMinute:IoTJobExecutionsRolloutConfig', ioTJobExecutionsRolloutConfig_maximumPerMinute - The maximum number of devices that receive a pending job notification,
per minute.
ioTJobExecutionsRolloutConfig_exponentialRate :: Lens' IoTJobExecutionsRolloutConfig (Maybe IoTJobExponentialRolloutRate) Source #
The exponential rate to increase the job rollout rate.
ioTJobExecutionsRolloutConfig_maximumPerMinute :: Lens' IoTJobExecutionsRolloutConfig (Maybe Natural) Source #
The maximum number of devices that receive a pending job notification, per minute.
IoTJobExponentialRolloutRate
data IoTJobExponentialRolloutRate Source #
Contains information about an exponential rollout rate for a configuration deployment job.
See: newIoTJobExponentialRolloutRate smart constructor.
Constructors
| IoTJobExponentialRolloutRate' | |
Fields
| |
Instances
newIoTJobExponentialRolloutRate Source #
Arguments
| :: Natural | |
| -> Double | |
| -> IoTJobRateIncreaseCriteria | |
| -> IoTJobExponentialRolloutRate |
Create a value of IoTJobExponentialRolloutRate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:baseRatePerMinute:IoTJobExponentialRolloutRate', ioTJobExponentialRolloutRate_baseRatePerMinute - The minimum number of devices that receive a pending job notification,
per minute, when the job starts. This parameter defines the initial
rollout rate of the job.
$sel:incrementFactor:IoTJobExponentialRolloutRate', ioTJobExponentialRolloutRate_incrementFactor - The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example,
you can specify 1.5, but not 1.55).
$sel:rateIncreaseCriteria:IoTJobExponentialRolloutRate', ioTJobExponentialRolloutRate_rateIncreaseCriteria - The criteria to increase the rollout rate for the job.
ioTJobExponentialRolloutRate_baseRatePerMinute :: Lens' IoTJobExponentialRolloutRate Natural Source #
The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.
ioTJobExponentialRolloutRate_incrementFactor :: Lens' IoTJobExponentialRolloutRate Double Source #
The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example,
you can specify 1.5, but not 1.55).
ioTJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' IoTJobExponentialRolloutRate IoTJobRateIncreaseCriteria Source #
The criteria to increase the rollout rate for the job.
IoTJobRateIncreaseCriteria
data IoTJobRateIncreaseCriteria Source #
Contains information about criteria to meet before a job increases its
rollout rate. Specify either numberOfNotifiedThings or
numberOfSucceededThings.
See: newIoTJobRateIncreaseCriteria smart constructor.
Constructors
| IoTJobRateIncreaseCriteria' | |
Fields
| |
Instances
newIoTJobRateIncreaseCriteria :: IoTJobRateIncreaseCriteria Source #
Create a value of IoTJobRateIncreaseCriteria with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberOfNotifiedThings:IoTJobRateIncreaseCriteria', ioTJobRateIncreaseCriteria_numberOfNotifiedThings - The number of devices to receive the job notification before the rollout
rate increases.
$sel:numberOfSucceededThings:IoTJobRateIncreaseCriteria', ioTJobRateIncreaseCriteria_numberOfSucceededThings - The number of devices to successfully run the configuration job before
the rollout rate increases.
ioTJobRateIncreaseCriteria_numberOfNotifiedThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural) Source #
The number of devices to receive the job notification before the rollout rate increases.
ioTJobRateIncreaseCriteria_numberOfSucceededThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural) Source #
The number of devices to successfully run the configuration job before the rollout rate increases.
IoTJobTimeoutConfig
data IoTJobTimeoutConfig Source #
Contains information about the timeout configuration for a job.
See: newIoTJobTimeoutConfig smart constructor.
Constructors
| IoTJobTimeoutConfig' | |
Fields
| |
Instances
newIoTJobTimeoutConfig :: IoTJobTimeoutConfig Source #
Create a value of IoTJobTimeoutConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inProgressTimeoutInMinutes:IoTJobTimeoutConfig', ioTJobTimeoutConfig_inProgressTimeoutInMinutes - The amount of time, in minutes, that devices have to complete the job.
The timer starts when the job status is set to IN_PROGRESS. If the job
status doesn't change to a terminal state before the time expires, then
the job status is set to TIMED_OUT.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
ioTJobTimeoutConfig_inProgressTimeoutInMinutes :: Lens' IoTJobTimeoutConfig (Maybe Integer) Source #
The amount of time, in minutes, that devices have to complete the job.
The timer starts when the job status is set to IN_PROGRESS. If the job
status doesn't change to a terminal state before the time expires, then
the job status is set to TIMED_OUT.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
LambdaContainerParams
data LambdaContainerParams Source #
Contains information about a container in which Lambda functions run on Greengrass core devices.
See: newLambdaContainerParams smart constructor.
Constructors
| LambdaContainerParams' | |
Fields
| |
Instances
newLambdaContainerParams :: LambdaContainerParams Source #
Create a value of LambdaContainerParams with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:devices:LambdaContainerParams', lambdaContainerParams_devices - The list of system devices that the container can access.
$sel:memorySizeInKB:LambdaContainerParams', lambdaContainerParams_memorySizeInKB - The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
$sel:mountROSysfs:LambdaContainerParams', lambdaContainerParams_mountROSysfs - Whether or not the container can read information from the device's
/sys folder.
Default: false
$sel:volumes:LambdaContainerParams', lambdaContainerParams_volumes - The list of volumes that the container can access.
lambdaContainerParams_devices :: Lens' LambdaContainerParams (Maybe [LambdaDeviceMount]) Source #
The list of system devices that the container can access.
lambdaContainerParams_memorySizeInKB :: Lens' LambdaContainerParams (Maybe Int) Source #
The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
lambdaContainerParams_mountROSysfs :: Lens' LambdaContainerParams (Maybe Bool) Source #
Whether or not the container can read information from the device's
/sys folder.
Default: false
lambdaContainerParams_volumes :: Lens' LambdaContainerParams (Maybe [LambdaVolumeMount]) Source #
The list of volumes that the container can access.
LambdaDeviceMount
data LambdaDeviceMount Source #
Contains information about a device that Linux processes in a container can access.
See: newLambdaDeviceMount smart constructor.
Constructors
| LambdaDeviceMount' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LambdaDeviceMount |
Create a value of LambdaDeviceMount with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addGroupOwner:LambdaDeviceMount', lambdaDeviceMount_addGroupOwner - Whether or not to add the component's system user as an owner of the
device.
Default: false
$sel:permission:LambdaDeviceMount', lambdaDeviceMount_permission - The permission to access the device: read/only (ro) or read/write
(rw).
Default: ro
$sel:path:LambdaDeviceMount', lambdaDeviceMount_path - The mount path for the device in the file system.
lambdaDeviceMount_addGroupOwner :: Lens' LambdaDeviceMount (Maybe Bool) Source #
Whether or not to add the component's system user as an owner of the device.
Default: false
lambdaDeviceMount_permission :: Lens' LambdaDeviceMount (Maybe LambdaFilesystemPermission) Source #
The permission to access the device: read/only (ro) or read/write
(rw).
Default: ro
lambdaDeviceMount_path :: Lens' LambdaDeviceMount Text Source #
The mount path for the device in the file system.
LambdaEventSource
data LambdaEventSource Source #
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.
See: newLambdaEventSource smart constructor.
Constructors
| LambdaEventSource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LambdaEventSourceType | |
| -> LambdaEventSource |
Create a value of LambdaEventSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topic:LambdaEventSource', lambdaEventSource_topic - The topic to which to subscribe to receive event messages.
$sel:type':LambdaEventSource', lambdaEventSource_type - The type of event source. Choose from the following options:
PUB_SUB– Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (+and#) in the event source topic.IOT_CORE– Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type supports MQTT wildcards (+and#) in the event source topic.
lambdaEventSource_topic :: Lens' LambdaEventSource Text Source #
The topic to which to subscribe to receive event messages.
lambdaEventSource_type :: Lens' LambdaEventSource LambdaEventSourceType Source #
The type of event source. Choose from the following options:
PUB_SUB– Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (+and#) in the event source topic.IOT_CORE– Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type supports MQTT wildcards (+and#) in the event source topic.
LambdaExecutionParameters
data LambdaExecutionParameters Source #
Contains parameters for a Lambda function that runs on IoT Greengrass.
See: newLambdaExecutionParameters smart constructor.
Constructors
| LambdaExecutionParameters' | |
Fields
| |
Instances
newLambdaExecutionParameters :: LambdaExecutionParameters Source #
Create a value of LambdaExecutionParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentVariables:LambdaExecutionParameters', lambdaExecutionParameters_environmentVariables - The map of environment variables that are available to the Lambda
function when it runs.
$sel:eventSources:LambdaExecutionParameters', lambdaExecutionParameters_eventSources - The list of event sources to which to subscribe to receive work
messages. The Lambda function runs when it receives a message from an
event source. You can subscribe this function to local
publish/subscribe messages and Amazon Web Services IoT Core MQTT
messages.
$sel:execArgs:LambdaExecutionParameters', lambdaExecutionParameters_execArgs - The list of arguments to pass to the Lambda function when it runs.
$sel:inputPayloadEncodingType:LambdaExecutionParameters', lambdaExecutionParameters_inputPayloadEncodingType - The encoding type that the Lambda function supports.
Default: json
$sel:linuxProcessParams:LambdaExecutionParameters', lambdaExecutionParameters_linuxProcessParams - The parameters for the Linux process that contains the Lambda function.
$sel:maxIdleTimeInSeconds:LambdaExecutionParameters', lambdaExecutionParameters_maxIdleTimeInSeconds - The maximum amount of time in seconds that a non-pinned Lambda function
can idle before the IoT Greengrass Core software stops its process.
$sel:maxInstancesCount:LambdaExecutionParameters', lambdaExecutionParameters_maxInstancesCount - The maximum number of instances that a non-pinned Lambda function can
run at the same time.
$sel:maxQueueSize:LambdaExecutionParameters', lambdaExecutionParameters_maxQueueSize - The maximum size of the message queue for the Lambda function component.
The IoT Greengrass core stores messages in a FIFO (first-in-first-out)
queue until it can run the Lambda function to consume each message.
$sel:pinned:LambdaExecutionParameters', lambdaExecutionParameters_pinned - Whether or not the Lambda function is pinned, or long-lived.
- A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.
- A non-pinned Lambda function starts only when it receives a work
item and exists after it idles for
maxIdleTimeInSeconds. If the function has multiple work items, the IoT Greengrass Core software creates multiple instances of the function.
Default: true
$sel:statusTimeoutInSeconds:LambdaExecutionParameters', lambdaExecutionParameters_statusTimeoutInSeconds - The interval in seconds at which a pinned (also known as long-lived)
Lambda function component sends status updates to the Lambda manager
component.
$sel:timeoutInSeconds:LambdaExecutionParameters', lambdaExecutionParameters_timeoutInSeconds - The maximum amount of time in seconds that the Lambda function can
process a work item.
lambdaExecutionParameters_environmentVariables :: Lens' LambdaExecutionParameters (Maybe (HashMap Text Text)) Source #
The map of environment variables that are available to the Lambda function when it runs.
lambdaExecutionParameters_eventSources :: Lens' LambdaExecutionParameters (Maybe [LambdaEventSource]) Source #
The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.
lambdaExecutionParameters_execArgs :: Lens' LambdaExecutionParameters (Maybe [Text]) Source #
The list of arguments to pass to the Lambda function when it runs.
lambdaExecutionParameters_inputPayloadEncodingType :: Lens' LambdaExecutionParameters (Maybe LambdaInputPayloadEncodingType) Source #
The encoding type that the Lambda function supports.
Default: json
lambdaExecutionParameters_linuxProcessParams :: Lens' LambdaExecutionParameters (Maybe LambdaLinuxProcessParams) Source #
The parameters for the Linux process that contains the Lambda function.
lambdaExecutionParameters_maxIdleTimeInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.
lambdaExecutionParameters_maxInstancesCount :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum number of instances that a non-pinned Lambda function can run at the same time.
lambdaExecutionParameters_maxQueueSize :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum size of the message queue for the Lambda function component. The IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
lambdaExecutionParameters_pinned :: Lens' LambdaExecutionParameters (Maybe Bool) Source #
Whether or not the Lambda function is pinned, or long-lived.
- A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.
- A non-pinned Lambda function starts only when it receives a work
item and exists after it idles for
maxIdleTimeInSeconds. If the function has multiple work items, the IoT Greengrass Core software creates multiple instances of the function.
Default: true
lambdaExecutionParameters_statusTimeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
lambdaExecutionParameters_timeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum amount of time in seconds that the Lambda function can process a work item.
LambdaFunctionRecipeSource
data LambdaFunctionRecipeSource Source #
Contains information about an Lambda function to import to create a component.
See: newLambdaFunctionRecipeSource smart constructor.
Constructors
| LambdaFunctionRecipeSource' | |
Fields
| |
Instances
newLambdaFunctionRecipeSource Source #
Create a value of LambdaFunctionRecipeSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentDependencies:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_componentDependencies - The component versions on which this Lambda function component depends.
$sel:componentLambdaParameters:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_componentLambdaParameters - The system and runtime parameters for the Lambda function as it runs on
the Greengrass core device.
$sel:componentName:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_componentName - The name of the component.
Defaults to the name of the Lambda function.
$sel:componentPlatforms:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_componentPlatforms - The platforms that the component version supports.
$sel:componentVersion:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_componentVersion - The version of the component.
Defaults to the version of the Lambda function as a semantic version.
For example, if your function version is 3, the component version
becomes 3.0.0.
$sel:lambdaArn:LambdaFunctionRecipeSource', lambdaFunctionRecipeSource_lambdaArn - The
ARN
of the Lambda function. The ARN must include the version of the function
to import. You can't use version aliases like $LATEST.
lambdaFunctionRecipeSource_componentDependencies :: Lens' LambdaFunctionRecipeSource (Maybe (HashMap Text ComponentDependencyRequirement)) Source #
The component versions on which this Lambda function component depends.
lambdaFunctionRecipeSource_componentLambdaParameters :: Lens' LambdaFunctionRecipeSource (Maybe LambdaExecutionParameters) Source #
The system and runtime parameters for the Lambda function as it runs on the Greengrass core device.
lambdaFunctionRecipeSource_componentName :: Lens' LambdaFunctionRecipeSource (Maybe Text) Source #
The name of the component.
Defaults to the name of the Lambda function.
lambdaFunctionRecipeSource_componentPlatforms :: Lens' LambdaFunctionRecipeSource (Maybe [ComponentPlatform]) Source #
The platforms that the component version supports.
lambdaFunctionRecipeSource_componentVersion :: Lens' LambdaFunctionRecipeSource (Maybe Text) Source #
The version of the component.
Defaults to the version of the Lambda function as a semantic version.
For example, if your function version is 3, the component version
becomes 3.0.0.
lambdaFunctionRecipeSource_lambdaArn :: Lens' LambdaFunctionRecipeSource Text Source #
The
ARN
of the Lambda function. The ARN must include the version of the function
to import. You can't use version aliases like $LATEST.
LambdaLinuxProcessParams
data LambdaLinuxProcessParams Source #
Contains parameters for a Linux process that contains an Lambda function.
See: newLambdaLinuxProcessParams smart constructor.
Constructors
| LambdaLinuxProcessParams' | |
Fields
| |
Instances
newLambdaLinuxProcessParams :: LambdaLinuxProcessParams Source #
Create a value of LambdaLinuxProcessParams with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerParams:LambdaLinuxProcessParams', lambdaLinuxProcessParams_containerParams - The parameters for the container in which the Lambda function runs.
$sel:isolationMode:LambdaLinuxProcessParams', lambdaLinuxProcessParams_isolationMode - The isolation mode for the process that contains the Lambda function.
The process can run in an isolated runtime environment inside the IoT
Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
lambdaLinuxProcessParams_containerParams :: Lens' LambdaLinuxProcessParams (Maybe LambdaContainerParams) Source #
The parameters for the container in which the Lambda function runs.
lambdaLinuxProcessParams_isolationMode :: Lens' LambdaLinuxProcessParams (Maybe LambdaIsolationMode) Source #
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
LambdaVolumeMount
data LambdaVolumeMount Source #
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.
See: newLambdaVolumeMount smart constructor.
Constructors
| LambdaVolumeMount' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> LambdaVolumeMount |
Create a value of LambdaVolumeMount with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addGroupOwner:LambdaVolumeMount', lambdaVolumeMount_addGroupOwner - Whether or not to add the IoT Greengrass user group as an owner of the
volume.
Default: false
$sel:permission:LambdaVolumeMount', lambdaVolumeMount_permission - The permission to access the volume: read/only (ro) or read/write
(rw).
Default: ro
$sel:sourcePath:LambdaVolumeMount', lambdaVolumeMount_sourcePath - The path to the physical volume in the file system.
$sel:destinationPath:LambdaVolumeMount', lambdaVolumeMount_destinationPath - The path to the logical volume in the file system.
lambdaVolumeMount_addGroupOwner :: Lens' LambdaVolumeMount (Maybe Bool) Source #
Whether or not to add the IoT Greengrass user group as an owner of the volume.
Default: false
lambdaVolumeMount_permission :: Lens' LambdaVolumeMount (Maybe LambdaFilesystemPermission) Source #
The permission to access the volume: read/only (ro) or read/write
(rw).
Default: ro
lambdaVolumeMount_sourcePath :: Lens' LambdaVolumeMount Text Source #
The path to the physical volume in the file system.
lambdaVolumeMount_destinationPath :: Lens' LambdaVolumeMount Text Source #
The path to the logical volume in the file system.
ResolvedComponentVersion
data ResolvedComponentVersion Source #
Contains information about a component version that is compatible to run on a Greengrass core device.
See: newResolvedComponentVersion smart constructor.
Constructors
| ResolvedComponentVersion' | |
Fields
| |
Instances
newResolvedComponentVersion :: ResolvedComponentVersion Source #
Create a value of ResolvedComponentVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ResolvedComponentVersion', resolvedComponentVersion_arn - The
ARN
of the component version.
$sel:componentName:ResolvedComponentVersion', resolvedComponentVersion_componentName - The name of the component.
$sel:componentVersion:ResolvedComponentVersion', resolvedComponentVersion_componentVersion - The version of the component.
$sel:message:ResolvedComponentVersion', resolvedComponentVersion_message - A message that communicates details about the vendor guidance state of
the component version. This message communicates why a component version
is discontinued or deleted.
$sel:recipe:ResolvedComponentVersion', resolvedComponentVersion_recipe - The recipe of the component version.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:vendorGuidance:ResolvedComponentVersion', resolvedComponentVersion_vendorGuidance - The vendor guidance state for the component version. This state
indicates whether the component version has any issues that you should
consider before you deploy it. The vendor guidance state can be:
ACTIVE– This component version is available and recommended for use.DISCONTINUED– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
resolvedComponentVersion_arn :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The ARN of the component version.
resolvedComponentVersion_componentName :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The name of the component.
resolvedComponentVersion_componentVersion :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The version of the component.
resolvedComponentVersion_message :: Lens' ResolvedComponentVersion (Maybe Text) Source #
A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.
resolvedComponentVersion_recipe :: Lens' ResolvedComponentVersion (Maybe ByteString) Source #
The recipe of the component version.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
resolvedComponentVersion_vendorGuidance :: Lens' ResolvedComponentVersion (Maybe VendorGuidance) Source #
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE– This component version is available and recommended for use.DISCONTINUED– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
SystemResourceLimits
data SystemResourceLimits Source #
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.
See: newSystemResourceLimits smart constructor.
Constructors
| SystemResourceLimits' | |
Fields
| |
Instances
newSystemResourceLimits :: SystemResourceLimits Source #
Create a value of SystemResourceLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cpus:SystemResourceLimits', systemResourceLimits_cpus - The maximum amount of CPU time that a component's processes can use on
the core device. A core device's total CPU time is equivalent to the
device's number of CPU cores. For example, on a core device with 4 CPU
cores, you can set this value to 2 to limit the component's processes
to 50 percent usage of each CPU core. On a device with 1 CPU core, you
can set this value to 0.25 to limit the component's processes to 25
percent usage of the CPU. If you set this value to a number greater than
the number of CPU cores, the IoT Greengrass Core software doesn't limit
the component's CPU usage.
$sel:memory:SystemResourceLimits', systemResourceLimits_memory - The maximum amount of RAM, expressed in kilobytes, that a component's
processes can use on the core device.
systemResourceLimits_cpus :: Lens' SystemResourceLimits (Maybe Double) Source #
The maximum amount of CPU time that a component's processes can use on
the core device. A core device's total CPU time is equivalent to the
device's number of CPU cores. For example, on a core device with 4 CPU
cores, you can set this value to 2 to limit the component's processes
to 50 percent usage of each CPU core. On a device with 1 CPU core, you
can set this value to 0.25 to limit the component's processes to 25
percent usage of the CPU. If you set this value to a number greater than
the number of CPU cores, the IoT Greengrass Core software doesn't limit
the component's CPU usage.
systemResourceLimits_memory :: Lens' SystemResourceLimits (Maybe Natural) Source #
The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.