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 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateServiceRoleToAccount
- BatchAssociateClientDeviceWithCoreDevice
- BatchDisassociateClientDeviceFromCoreDevice
- CancelDeployment
- CreateComponentVersion
- CreateDeployment
- DeleteComponent
- DeleteCoreDevice
- DeleteDeployment
- DescribeComponent
- DisassociateServiceRoleFromAccount
- GetComponent
- GetComponentVersionArtifact
- GetConnectivityInfo
- GetCoreDevice
- GetDeployment
- GetServiceRoleForAccount
- ListClientDevicesAssociatedWithCoreDevice (Paginated)
- ListComponentVersions (Paginated)
- ListComponents (Paginated)
- ListCoreDevices (Paginated)
- ListDeployments (Paginated)
- ListEffectiveDeployments (Paginated)
- ListInstalledComponents (Paginated)
- ListTagsForResource
- ResolveComponentCandidates
- TagResource
- UntagResource
- UpdateConnectivityInfo
- Types
- 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
Derived from API version 2020-11-30
of the AWS service descriptions, licensed under Apache 2.0.
IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.
IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.
For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.
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
- data AssociateServiceRoleToAccount = AssociateServiceRoleToAccount' Text
- newAssociateServiceRoleToAccount :: Text -> AssociateServiceRoleToAccount
- data AssociateServiceRoleToAccountResponse = AssociateServiceRoleToAccountResponse' (Maybe Text) Int
- newAssociateServiceRoleToAccountResponse :: Int -> AssociateServiceRoleToAccountResponse
- data BatchAssociateClientDeviceWithCoreDevice = BatchAssociateClientDeviceWithCoreDevice' (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry)) Text
- newBatchAssociateClientDeviceWithCoreDevice :: Text -> BatchAssociateClientDeviceWithCoreDevice
- data BatchAssociateClientDeviceWithCoreDeviceResponse = BatchAssociateClientDeviceWithCoreDeviceResponse' (Maybe [AssociateClientDeviceWithCoreDeviceErrorEntry]) Int
- newBatchAssociateClientDeviceWithCoreDeviceResponse :: Int -> BatchAssociateClientDeviceWithCoreDeviceResponse
- data BatchDisassociateClientDeviceFromCoreDevice = BatchDisassociateClientDeviceFromCoreDevice' (Maybe (NonEmpty DisassociateClientDeviceFromCoreDeviceEntry)) Text
- newBatchDisassociateClientDeviceFromCoreDevice :: Text -> BatchDisassociateClientDeviceFromCoreDevice
- data BatchDisassociateClientDeviceFromCoreDeviceResponse = BatchDisassociateClientDeviceFromCoreDeviceResponse' (Maybe [DisassociateClientDeviceFromCoreDeviceErrorEntry]) Int
- newBatchDisassociateClientDeviceFromCoreDeviceResponse :: Int -> BatchDisassociateClientDeviceFromCoreDeviceResponse
- data CancelDeployment = CancelDeployment' Text
- newCancelDeployment :: Text -> CancelDeployment
- data CancelDeploymentResponse = CancelDeploymentResponse' (Maybe Text) Int
- newCancelDeploymentResponse :: Int -> CancelDeploymentResponse
- data CreateComponentVersion = CreateComponentVersion' (Maybe Text) (Maybe Base64) (Maybe LambdaFunctionRecipeSource) (Maybe (HashMap Text Text))
- newCreateComponentVersion :: CreateComponentVersion
- data CreateComponentVersionResponse = CreateComponentVersionResponse' (Maybe Text) Int Text Text POSIX CloudComponentStatus
- newCreateComponentVersionResponse :: Int -> Text -> Text -> UTCTime -> CloudComponentStatus -> CreateComponentVersionResponse
- data CreateDeployment = CreateDeployment' (Maybe Text) (Maybe (HashMap Text ComponentDeploymentSpecification)) (Maybe Text) (Maybe DeploymentPolicies) (Maybe DeploymentIoTJobConfiguration) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateDeployment :: Text -> CreateDeployment
- data CreateDeploymentResponse = CreateDeploymentResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
- data DeleteComponent = DeleteComponent' Text
- newDeleteComponent :: Text -> DeleteComponent
- data DeleteComponentResponse = DeleteComponentResponse' {
- newDeleteComponentResponse :: DeleteComponentResponse
- data DeleteCoreDevice = DeleteCoreDevice' Text
- newDeleteCoreDevice :: Text -> DeleteCoreDevice
- data DeleteCoreDeviceResponse = DeleteCoreDeviceResponse' {
- newDeleteCoreDeviceResponse :: DeleteCoreDeviceResponse
- data DeleteDeployment = DeleteDeployment' Text
- newDeleteDeployment :: Text -> DeleteDeployment
- data DeleteDeploymentResponse = DeleteDeploymentResponse' {
- newDeleteDeploymentResponse :: DeleteDeploymentResponse
- data DescribeComponent = DescribeComponent' Text
- newDescribeComponent :: Text -> DescribeComponent
- data DescribeComponentResponse = DescribeComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text) (Maybe CloudComponentStatus) (Maybe (HashMap Text Text)) Int
- newDescribeComponentResponse :: Int -> DescribeComponentResponse
- data DisassociateServiceRoleFromAccount = DisassociateServiceRoleFromAccount' {
- newDisassociateServiceRoleFromAccount :: DisassociateServiceRoleFromAccount
- data DisassociateServiceRoleFromAccountResponse = DisassociateServiceRoleFromAccountResponse' (Maybe Text) Int
- newDisassociateServiceRoleFromAccountResponse :: Int -> DisassociateServiceRoleFromAccountResponse
- data GetComponent = GetComponent' (Maybe RecipeOutputFormat) Text
- newGetComponent :: Text -> GetComponent
- data GetComponentResponse = GetComponentResponse' (Maybe (HashMap Text Text)) Int RecipeOutputFormat Base64
- newGetComponentResponse :: Int -> RecipeOutputFormat -> ByteString -> GetComponentResponse
- data GetComponentVersionArtifact = GetComponentVersionArtifact' Text Text
- newGetComponentVersionArtifact :: Text -> Text -> GetComponentVersionArtifact
- data GetComponentVersionArtifactResponse = GetComponentVersionArtifactResponse' Int Text
- newGetComponentVersionArtifactResponse :: Int -> Text -> GetComponentVersionArtifactResponse
- data GetConnectivityInfo = GetConnectivityInfo' Text
- newGetConnectivityInfo :: Text -> GetConnectivityInfo
- data GetConnectivityInfoResponse = GetConnectivityInfoResponse' (Maybe [ConnectivityInfo]) (Maybe Text) Int
- newGetConnectivityInfoResponse :: Int -> GetConnectivityInfoResponse
- data GetCoreDevice = GetCoreDevice' Text
- newGetCoreDevice :: Text -> GetCoreDevice
- data GetCoreDeviceResponse = GetCoreDeviceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe CoreDeviceStatus) (Maybe (HashMap Text Text)) Int
- newGetCoreDeviceResponse :: Int -> GetCoreDeviceResponse
- data GetDeployment = GetDeployment' Text
- newGetDeployment :: Text -> GetDeployment
- data GetDeploymentResponse = GetDeploymentResponse' (Maybe (HashMap Text ComponentDeploymentSpecification)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeploymentPolicies) (Maybe DeploymentStatus) (Maybe Text) (Maybe DeploymentIoTJobConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newGetDeploymentResponse :: Int -> GetDeploymentResponse
- data GetServiceRoleForAccount = GetServiceRoleForAccount' {
- newGetServiceRoleForAccount :: GetServiceRoleForAccount
- data GetServiceRoleForAccountResponse = GetServiceRoleForAccountResponse' (Maybe Text) (Maybe Text) Int
- newGetServiceRoleForAccountResponse :: Int -> GetServiceRoleForAccountResponse
- data ListClientDevicesAssociatedWithCoreDevice = ListClientDevicesAssociatedWithCoreDevice' (Maybe Natural) (Maybe Text) Text
- newListClientDevicesAssociatedWithCoreDevice :: Text -> ListClientDevicesAssociatedWithCoreDevice
- data ListClientDevicesAssociatedWithCoreDeviceResponse = ListClientDevicesAssociatedWithCoreDeviceResponse' (Maybe (NonEmpty AssociatedClientDevice)) (Maybe Text) Int
- newListClientDevicesAssociatedWithCoreDeviceResponse :: Int -> ListClientDevicesAssociatedWithCoreDeviceResponse
- data ListComponentVersions = ListComponentVersions' (Maybe Natural) (Maybe Text) Text
- newListComponentVersions :: Text -> ListComponentVersions
- data ListComponentVersionsResponse = ListComponentVersionsResponse' (Maybe [ComponentVersionListItem]) (Maybe Text) Int
- newListComponentVersionsResponse :: Int -> ListComponentVersionsResponse
- data ListComponents = ListComponents' (Maybe Natural) (Maybe Text) (Maybe ComponentVisibilityScope)
- newListComponents :: ListComponents
- data ListComponentsResponse = ListComponentsResponse' (Maybe [Component]) (Maybe Text) Int
- newListComponentsResponse :: Int -> ListComponentsResponse
- data ListCoreDevices = ListCoreDevices' (Maybe Natural) (Maybe Text) (Maybe CoreDeviceStatus) (Maybe Text)
- newListCoreDevices :: ListCoreDevices
- data ListCoreDevicesResponse = ListCoreDevicesResponse' (Maybe [CoreDevice]) (Maybe Text) Int
- newListCoreDevicesResponse :: Int -> ListCoreDevicesResponse
- data ListDeployments = ListDeployments' (Maybe DeploymentHistoryFilter) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newListDeployments :: ListDeployments
- data ListDeploymentsResponse = ListDeploymentsResponse' (Maybe [Deployment]) (Maybe Text) Int
- newListDeploymentsResponse :: Int -> ListDeploymentsResponse
- data ListEffectiveDeployments = ListEffectiveDeployments' (Maybe Natural) (Maybe Text) Text
- newListEffectiveDeployments :: Text -> ListEffectiveDeployments
- data ListEffectiveDeploymentsResponse = ListEffectiveDeploymentsResponse' (Maybe [EffectiveDeployment]) (Maybe Text) Int
- newListEffectiveDeploymentsResponse :: Int -> ListEffectiveDeploymentsResponse
- data ListInstalledComponents = ListInstalledComponents' (Maybe Natural) (Maybe Text) (Maybe InstalledComponentTopologyFilter) Text
- newListInstalledComponents :: Text -> ListInstalledComponents
- data ListInstalledComponentsResponse = ListInstalledComponentsResponse' (Maybe [InstalledComponent]) (Maybe Text) Int
- newListInstalledComponentsResponse :: Int -> ListInstalledComponentsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ResolveComponentCandidates = ResolveComponentCandidates' (Maybe [ComponentCandidate]) (Maybe ComponentPlatform)
- newResolveComponentCandidates :: ResolveComponentCandidates
- data ResolveComponentCandidatesResponse = ResolveComponentCandidatesResponse' (Maybe [ResolvedComponentVersion]) Int
- newResolveComponentCandidatesResponse :: Int -> ResolveComponentCandidatesResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateConnectivityInfo = UpdateConnectivityInfo' Text [ConnectivityInfo]
- newUpdateConnectivityInfo :: Text -> UpdateConnectivityInfo
- data UpdateConnectivityInfoResponse = UpdateConnectivityInfoResponse' (Maybe Text) (Maybe Text) Int
- newUpdateConnectivityInfoResponse :: Int -> UpdateConnectivityInfoResponse
- 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' Text
- newAssociateClientDeviceWithCoreDeviceEntry :: Text -> AssociateClientDeviceWithCoreDeviceEntry
- data AssociateClientDeviceWithCoreDeviceErrorEntry = AssociateClientDeviceWithCoreDeviceErrorEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newAssociateClientDeviceWithCoreDeviceErrorEntry :: AssociateClientDeviceWithCoreDeviceErrorEntry
- data AssociatedClientDevice = AssociatedClientDevice' (Maybe POSIX) (Maybe Text)
- newAssociatedClientDevice :: AssociatedClientDevice
- data CloudComponentStatus = CloudComponentStatus' (Maybe CloudComponentState) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VendorGuidance) (Maybe Text)
- newCloudComponentStatus :: CloudComponentStatus
- data Component = Component' (Maybe Text) (Maybe Text) (Maybe ComponentLatestVersion)
- newComponent :: Component
- data ComponentCandidate = ComponentCandidate' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newComponentCandidate :: ComponentCandidate
- data ComponentConfigurationUpdate = ComponentConfigurationUpdate' (Maybe Text) (Maybe [Text])
- newComponentConfigurationUpdate :: ComponentConfigurationUpdate
- data ComponentDependencyRequirement = ComponentDependencyRequirement' (Maybe ComponentDependencyType) (Maybe Text)
- newComponentDependencyRequirement :: ComponentDependencyRequirement
- data ComponentDeploymentSpecification = ComponentDeploymentSpecification' (Maybe Text) (Maybe ComponentConfigurationUpdate) (Maybe ComponentRunWith)
- newComponentDeploymentSpecification :: ComponentDeploymentSpecification
- data ComponentLatestVersion = ComponentLatestVersion' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text)
- newComponentLatestVersion :: ComponentLatestVersion
- data ComponentPlatform = ComponentPlatform' (Maybe (HashMap Text Text)) (Maybe Text)
- newComponentPlatform :: ComponentPlatform
- data ComponentRunWith = ComponentRunWith' (Maybe Text) (Maybe SystemResourceLimits) (Maybe Text)
- newComponentRunWith :: ComponentRunWith
- data ComponentVersionListItem = ComponentVersionListItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newComponentVersionListItem :: ComponentVersionListItem
- data ConnectivityInfo = ConnectivityInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newConnectivityInfo :: ConnectivityInfo
- data CoreDevice = CoreDevice' (Maybe Text) (Maybe POSIX) (Maybe CoreDeviceStatus)
- newCoreDevice :: CoreDevice
- data Deployment = Deployment' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeploymentStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newDeployment :: Deployment
- data DeploymentComponentUpdatePolicy = DeploymentComponentUpdatePolicy' (Maybe DeploymentComponentUpdatePolicyAction) (Maybe Int)
- newDeploymentComponentUpdatePolicy :: DeploymentComponentUpdatePolicy
- data DeploymentConfigurationValidationPolicy = DeploymentConfigurationValidationPolicy' (Maybe Int)
- newDeploymentConfigurationValidationPolicy :: DeploymentConfigurationValidationPolicy
- data DeploymentIoTJobConfiguration = DeploymentIoTJobConfiguration' (Maybe IoTJobAbortConfig) (Maybe IoTJobExecutionsRolloutConfig) (Maybe IoTJobTimeoutConfig)
- newDeploymentIoTJobConfiguration :: DeploymentIoTJobConfiguration
- data DeploymentPolicies = DeploymentPolicies' (Maybe DeploymentComponentUpdatePolicy) (Maybe DeploymentConfigurationValidationPolicy) (Maybe DeploymentFailureHandlingPolicy)
- newDeploymentPolicies :: DeploymentPolicies
- data DisassociateClientDeviceFromCoreDeviceEntry = DisassociateClientDeviceFromCoreDeviceEntry' Text
- newDisassociateClientDeviceFromCoreDeviceEntry :: Text -> DisassociateClientDeviceFromCoreDeviceEntry
- data DisassociateClientDeviceFromCoreDeviceErrorEntry = DisassociateClientDeviceFromCoreDeviceErrorEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newDisassociateClientDeviceFromCoreDeviceErrorEntry :: DisassociateClientDeviceFromCoreDeviceErrorEntry
- data EffectiveDeployment = EffectiveDeployment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EffectiveDeploymentStatusDetails) Text Text Text EffectiveDeploymentExecutionStatus POSIX POSIX
- newEffectiveDeployment :: Text -> Text -> Text -> EffectiveDeploymentExecutionStatus -> UTCTime -> UTCTime -> EffectiveDeployment
- data EffectiveDeploymentStatusDetails = EffectiveDeploymentStatusDetails' (Maybe [Text]) (Maybe [Text])
- newEffectiveDeploymentStatusDetails :: EffectiveDeploymentStatusDetails
- data InstalledComponent = InstalledComponent' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe InstalledComponentLifecycleState) (Maybe Text) (Maybe [Text])
- newInstalledComponent :: InstalledComponent
- data IoTJobAbortConfig = IoTJobAbortConfig' (NonEmpty IoTJobAbortCriteria)
- newIoTJobAbortConfig :: NonEmpty IoTJobAbortCriteria -> IoTJobAbortConfig
- data IoTJobAbortCriteria = IoTJobAbortCriteria' IoTJobExecutionFailureType IoTJobAbortAction Double Natural
- newIoTJobAbortCriteria :: IoTJobExecutionFailureType -> IoTJobAbortAction -> Double -> Natural -> IoTJobAbortCriteria
- data IoTJobExecutionsRolloutConfig = IoTJobExecutionsRolloutConfig' (Maybe IoTJobExponentialRolloutRate) (Maybe Natural)
- newIoTJobExecutionsRolloutConfig :: IoTJobExecutionsRolloutConfig
- data IoTJobExponentialRolloutRate = IoTJobExponentialRolloutRate' Natural Double IoTJobRateIncreaseCriteria
- newIoTJobExponentialRolloutRate :: Natural -> Double -> IoTJobRateIncreaseCriteria -> IoTJobExponentialRolloutRate
- data IoTJobRateIncreaseCriteria = IoTJobRateIncreaseCriteria' (Maybe Natural) (Maybe Natural)
- newIoTJobRateIncreaseCriteria :: IoTJobRateIncreaseCriteria
- data IoTJobTimeoutConfig = IoTJobTimeoutConfig' (Maybe Integer)
- newIoTJobTimeoutConfig :: IoTJobTimeoutConfig
- data LambdaContainerParams = LambdaContainerParams' (Maybe [LambdaDeviceMount]) (Maybe Int) (Maybe Bool) (Maybe [LambdaVolumeMount])
- newLambdaContainerParams :: LambdaContainerParams
- data LambdaDeviceMount = LambdaDeviceMount' (Maybe Bool) (Maybe LambdaFilesystemPermission) Text
- newLambdaDeviceMount :: Text -> LambdaDeviceMount
- data LambdaEventSource = LambdaEventSource' Text LambdaEventSourceType
- newLambdaEventSource :: Text -> LambdaEventSourceType -> LambdaEventSource
- data LambdaExecutionParameters = LambdaExecutionParameters' (Maybe (HashMap Text Text)) (Maybe [LambdaEventSource]) (Maybe [Text]) (Maybe LambdaInputPayloadEncodingType) (Maybe LambdaLinuxProcessParams) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int)
- newLambdaExecutionParameters :: LambdaExecutionParameters
- data LambdaFunctionRecipeSource = LambdaFunctionRecipeSource' (Maybe (HashMap Text ComponentDependencyRequirement)) (Maybe LambdaExecutionParameters) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text) Text
- newLambdaFunctionRecipeSource :: Text -> LambdaFunctionRecipeSource
- data LambdaLinuxProcessParams = LambdaLinuxProcessParams' (Maybe LambdaContainerParams) (Maybe LambdaIsolationMode)
- newLambdaLinuxProcessParams :: LambdaLinuxProcessParams
- data LambdaVolumeMount = LambdaVolumeMount' (Maybe Bool) (Maybe LambdaFilesystemPermission) Text Text
- newLambdaVolumeMount :: Text -> Text -> LambdaVolumeMount
- data ResolvedComponentVersion = ResolvedComponentVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Base64) (Maybe VendorGuidance)
- newResolvedComponentVersion :: ResolvedComponentVersion
- data SystemResourceLimits = SystemResourceLimits' (Maybe Double) (Maybe Natural)
- newSystemResourceLimits :: SystemResourceLimits
Service Configuration
defaultService :: Service Source #
API version 2020-11-30
of the Amazon IoT Greengrass V2 SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by GreengrassV2
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have permission to perform the action.
ConflictException
_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
_InternalServerException :: AsError a => Fold a ServiceError Source #
IoT Greengrass can't process your request right now. Try again later.
RequestAlreadyInProgressException
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource can't be found.
ServiceQuotaExceededException
_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
_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
_ValidationException :: AsError a => Fold a ServiceError Source #
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateServiceRoleToAccount
data AssociateServiceRoleToAccount Source #
See: newAssociateServiceRoleToAccount
smart constructor.
Instances
newAssociateServiceRoleToAccount Source #
Create a value of AssociateServiceRoleToAccount
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:roleArn:AssociateServiceRoleToAccount'
, associateServiceRoleToAccount_roleArn
- The Amazon Resource Name (ARN) of the service role to associate with IoT
Greengrass for your Amazon Web Services account in this Amazon Web
Services Region.
data AssociateServiceRoleToAccountResponse Source #
See: newAssociateServiceRoleToAccountResponse
smart constructor.
Instances
newAssociateServiceRoleToAccountResponse Source #
Create a value of AssociateServiceRoleToAccountResponse
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:associatedAt:AssociateServiceRoleToAccountResponse'
, associateServiceRoleToAccountResponse_associatedAt
- The time when the service role was associated with IoT Greengrass for
your Amazon Web Services account in this Amazon Web Services Region.
$sel:httpStatus:AssociateServiceRoleToAccountResponse'
, associateServiceRoleToAccountResponse_httpStatus
- The response's http status code.
BatchAssociateClientDeviceWithCoreDevice
data BatchAssociateClientDeviceWithCoreDevice Source #
See: newBatchAssociateClientDeviceWithCoreDevice
smart constructor.
BatchAssociateClientDeviceWithCoreDevice' (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry)) Text |
Instances
newBatchAssociateClientDeviceWithCoreDevice Source #
Create a value of BatchAssociateClientDeviceWithCoreDevice
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:entries:BatchAssociateClientDeviceWithCoreDevice'
, batchAssociateClientDeviceWithCoreDevice_entries
- The list of client devices to associate.
BatchAssociateClientDeviceWithCoreDevice
, batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data BatchAssociateClientDeviceWithCoreDeviceResponse Source #
See: newBatchAssociateClientDeviceWithCoreDeviceResponse
smart constructor.
BatchAssociateClientDeviceWithCoreDeviceResponse' (Maybe [AssociateClientDeviceWithCoreDeviceErrorEntry]) Int |
Instances
newBatchAssociateClientDeviceWithCoreDeviceResponse Source #
:: Int |
|
-> BatchAssociateClientDeviceWithCoreDeviceResponse |
Create a value of BatchAssociateClientDeviceWithCoreDeviceResponse
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:errorEntries:BatchAssociateClientDeviceWithCoreDeviceResponse'
, batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries
- The list of any errors for the entries in the request. Each error entry
contains the name of the IoT thing that failed to associate.
$sel:httpStatus:BatchAssociateClientDeviceWithCoreDeviceResponse'
, batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus
- The response's http status code.
BatchDisassociateClientDeviceFromCoreDevice
data BatchDisassociateClientDeviceFromCoreDevice Source #
See: newBatchDisassociateClientDeviceFromCoreDevice
smart constructor.
BatchDisassociateClientDeviceFromCoreDevice' (Maybe (NonEmpty DisassociateClientDeviceFromCoreDeviceEntry)) Text |
Instances
newBatchDisassociateClientDeviceFromCoreDevice Source #
Create a value of BatchDisassociateClientDeviceFromCoreDevice
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:entries:BatchDisassociateClientDeviceFromCoreDevice'
, batchDisassociateClientDeviceFromCoreDevice_entries
- The list of client devices to disassociate.
BatchDisassociateClientDeviceFromCoreDevice
, batchDisassociateClientDeviceFromCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data BatchDisassociateClientDeviceFromCoreDeviceResponse Source #
See: newBatchDisassociateClientDeviceFromCoreDeviceResponse
smart constructor.
BatchDisassociateClientDeviceFromCoreDeviceResponse' (Maybe [DisassociateClientDeviceFromCoreDeviceErrorEntry]) Int |
Instances
newBatchDisassociateClientDeviceFromCoreDeviceResponse Source #
:: Int |
|
-> BatchDisassociateClientDeviceFromCoreDeviceResponse |
Create a value of BatchDisassociateClientDeviceFromCoreDeviceResponse
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:errorEntries:BatchDisassociateClientDeviceFromCoreDeviceResponse'
, batchDisassociateClientDeviceFromCoreDeviceResponse_errorEntries
- The list of any errors for the entries in the request. Each error entry
contains the name of the IoT thing that failed to disassociate.
$sel:httpStatus:BatchDisassociateClientDeviceFromCoreDeviceResponse'
, batchDisassociateClientDeviceFromCoreDeviceResponse_httpStatus
- The response's http status code.
CancelDeployment
data CancelDeployment Source #
See: newCancelDeployment
smart constructor.
Instances
Create a value of CancelDeployment
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:
CancelDeployment
, cancelDeployment_deploymentId
- The ID of the deployment.
data CancelDeploymentResponse Source #
See: newCancelDeploymentResponse
smart constructor.
Instances
newCancelDeploymentResponse Source #
Create a value of CancelDeploymentResponse
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:
CancelDeploymentResponse
, cancelDeploymentResponse_message
- A message that communicates if the cancel was successful.
$sel:httpStatus:CancelDeploymentResponse'
, cancelDeploymentResponse_httpStatus
- The response's http status code.
CreateComponentVersion
data CreateComponentVersion Source #
See: newCreateComponentVersion
smart constructor.
CreateComponentVersion' (Maybe Text) (Maybe Base64) (Maybe LambdaFunctionRecipeSource) (Maybe (HashMap Text Text)) |
Instances
newCreateComponentVersion :: CreateComponentVersion Source #
Create a value of CreateComponentVersion
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:clientToken:CreateComponentVersion'
, createComponentVersion_clientToken
- A unique, case-sensitive identifier that you can provide to ensure that
the request is idempotent. Idempotency means that the request is
successfully processed only once, even if you send the request multiple
times. When a request succeeds, and you specify the same client token
for subsequent successful requests, the IoT Greengrass V2 service
returns the successful response that it caches from the previous
request. IoT Greengrass V2 caches successful responses for idempotent
requests for up to 8 hours.
$sel:inlineRecipe:CreateComponentVersion'
, createComponentVersion_inlineRecipe
- The recipe to use to create the component. The recipe defines the
component's metadata, parameters, dependencies, lifecycle, artifacts,
and platform compatibility.
You must specify either inlineRecipe
or lambdaFunction
.--
-- 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:lambdaFunction:CreateComponentVersion'
, createComponentVersion_lambdaFunction
- The parameters to create a component from a Lambda function.
You must specify either inlineRecipe
or lambdaFunction
.
$sel:tags:CreateComponentVersion'
, createComponentVersion_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
data CreateComponentVersionResponse Source #
See: newCreateComponentVersionResponse
smart constructor.
Instances
newCreateComponentVersionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> CloudComponentStatus | |
-> CreateComponentVersionResponse |
Create a value of CreateComponentVersionResponse
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:
CreateComponentVersionResponse
, createComponentVersionResponse_arn
- The
ARN
of the component version.
$sel:httpStatus:CreateComponentVersionResponse'
, createComponentVersionResponse_httpStatus
- The response's http status code.
CreateComponentVersionResponse
, createComponentVersionResponse_componentName
- The name of the component.
CreateComponentVersionResponse
, createComponentVersionResponse_componentVersion
- The version of the component.
CreateComponentVersionResponse
, createComponentVersionResponse_creationTimestamp
- The time at which the component was created, expressed in ISO 8601
format.
CreateComponentVersionResponse
, createComponentVersionResponse_status
- The status of the component version in IoT Greengrass V2. This status is
different from the status of the component on a core device.
CreateDeployment
data CreateDeployment Source #
See: newCreateDeployment
smart constructor.
Instances
Create a value of CreateDeployment
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:clientToken:CreateDeployment'
, createDeployment_clientToken
- A unique, case-sensitive identifier that you can provide to ensure that
the request is idempotent. Idempotency means that the request is
successfully processed only once, even if you send the request multiple
times. When a request succeeds, and you specify the same client token
for subsequent successful requests, the IoT Greengrass V2 service
returns the successful response that it caches from the previous
request. IoT Greengrass V2 caches successful responses for idempotent
requests for up to 8 hours.
$sel:components:CreateDeployment'
, createDeployment_components
- The components to deploy. This is a dictionary, where each key is the
name of a component, and each key's value is the version and
configuration to deploy for that component.
CreateDeployment
, createDeployment_deploymentName
- The name of the deployment.
$sel:deploymentPolicies:CreateDeployment'
, createDeployment_deploymentPolicies
- The deployment policies for the deployment. These policies define how
the deployment updates components and handles failure.
$sel:iotJobConfiguration:CreateDeployment'
, createDeployment_iotJobConfiguration
- The job configuration for the deployment configuration. The job
configuration specifies the rollout, timeout, and stop configurations
for the deployment configuration.
CreateDeployment
, createDeployment_parentTargetArn
- The parent deployment's target
ARN
within a subdeployment.
$sel:tags:CreateDeployment'
, createDeployment_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
CreateDeployment
, createDeployment_targetArn
- The
ARN
of the target IoT thing or thing group. When creating a subdeployment,
the targetARN can only be a thing group.
data CreateDeploymentResponse Source #
See: newCreateDeploymentResponse
smart constructor.
Instances
newCreateDeploymentResponse Source #
Create a value of CreateDeploymentResponse
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:
CreateDeploymentResponse
, createDeploymentResponse_deploymentId
- The ID of the deployment.
CreateDeploymentResponse
, createDeploymentResponse_iotJobArn
- The
ARN
of the IoT job that applies the deployment to target devices.
CreateDeploymentResponse
, createDeploymentResponse_iotJobId
- The ID of the IoT job that applies the deployment to target devices.
$sel:httpStatus:CreateDeploymentResponse'
, createDeploymentResponse_httpStatus
- The response's http status code.
DeleteComponent
data DeleteComponent Source #
See: newDeleteComponent
smart constructor.
Instances
Create a value of DeleteComponent
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:
DeleteComponent
, deleteComponent_arn
- The
ARN
of the component version.
data DeleteComponentResponse Source #
See: newDeleteComponentResponse
smart constructor.
Instances
Generic DeleteComponentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteComponent type Rep DeleteComponentResponse :: Type -> Type # | |
Read DeleteComponentResponse Source # | |
Show DeleteComponentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteComponent showsPrec :: Int -> DeleteComponentResponse -> ShowS # show :: DeleteComponentResponse -> String # showList :: [DeleteComponentResponse] -> ShowS # | |
NFData DeleteComponentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteComponent rnf :: DeleteComponentResponse -> () # | |
Eq DeleteComponentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteComponent | |
type Rep DeleteComponentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteComponent |
newDeleteComponentResponse :: DeleteComponentResponse Source #
Create a value of DeleteComponentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCoreDevice
data DeleteCoreDevice Source #
See: newDeleteCoreDevice
smart constructor.
Instances
Create a value of DeleteCoreDevice
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:
DeleteCoreDevice
, deleteCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data DeleteCoreDeviceResponse Source #
See: newDeleteCoreDeviceResponse
smart constructor.
Instances
Generic DeleteCoreDeviceResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteCoreDevice type Rep DeleteCoreDeviceResponse :: Type -> Type # | |
Read DeleteCoreDeviceResponse Source # | |
Show DeleteCoreDeviceResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteCoreDevice showsPrec :: Int -> DeleteCoreDeviceResponse -> ShowS # show :: DeleteCoreDeviceResponse -> String # showList :: [DeleteCoreDeviceResponse] -> ShowS # | |
NFData DeleteCoreDeviceResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteCoreDevice rnf :: DeleteCoreDeviceResponse -> () # | |
Eq DeleteCoreDeviceResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteCoreDevice | |
type Rep DeleteCoreDeviceResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteCoreDevice |
newDeleteCoreDeviceResponse :: DeleteCoreDeviceResponse Source #
Create a value of DeleteCoreDeviceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDeployment
data DeleteDeployment Source #
See: newDeleteDeployment
smart constructor.
Instances
Create a value of DeleteDeployment
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:
DeleteDeployment
, deleteDeployment_deploymentId
- The ID of the deployment.
data DeleteDeploymentResponse Source #
See: newDeleteDeploymentResponse
smart constructor.
Instances
Generic DeleteDeploymentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteDeployment type Rep DeleteDeploymentResponse :: Type -> Type # | |
Read DeleteDeploymentResponse Source # | |
Show DeleteDeploymentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteDeployment showsPrec :: Int -> DeleteDeploymentResponse -> ShowS # show :: DeleteDeploymentResponse -> String # showList :: [DeleteDeploymentResponse] -> ShowS # | |
NFData DeleteDeploymentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteDeployment rnf :: DeleteDeploymentResponse -> () # | |
Eq DeleteDeploymentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteDeployment | |
type Rep DeleteDeploymentResponse Source # | |
Defined in Amazonka.GreengrassV2.DeleteDeployment |
newDeleteDeploymentResponse :: DeleteDeploymentResponse Source #
Create a value of DeleteDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeComponent
data DescribeComponent Source #
See: newDescribeComponent
smart constructor.
Instances
Create a value of DescribeComponent
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:
DescribeComponent
, describeComponent_arn
- The
ARN
of the component version.
data DescribeComponentResponse Source #
See: newDescribeComponentResponse
smart constructor.
DescribeComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text) (Maybe CloudComponentStatus) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeComponentResponse Source #
Create a value of DescribeComponentResponse
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:
DescribeComponent
, describeComponentResponse_arn
- The
ARN
of the component version.
DescribeComponentResponse
, describeComponentResponse_componentName
- The name of the component.
DescribeComponentResponse
, describeComponentResponse_componentVersion
- The version of the component.
DescribeComponentResponse
, describeComponentResponse_creationTimestamp
- The time at which the component was created, expressed in ISO 8601
format.
DescribeComponentResponse
, describeComponentResponse_description
- The description of the component version.
DescribeComponentResponse
, describeComponentResponse_platforms
- The platforms that the component version supports.
DescribeComponentResponse
, describeComponentResponse_publisher
- The publisher of the component version.
DescribeComponentResponse
, describeComponentResponse_status
- The status of the component version in IoT Greengrass V2. This status is
different from the status of the component on a core device.
$sel:tags:DescribeComponentResponse'
, describeComponentResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
$sel:httpStatus:DescribeComponentResponse'
, describeComponentResponse_httpStatus
- The response's http status code.
DisassociateServiceRoleFromAccount
data DisassociateServiceRoleFromAccount Source #
See: newDisassociateServiceRoleFromAccount
smart constructor.
Instances
newDisassociateServiceRoleFromAccount :: DisassociateServiceRoleFromAccount Source #
Create a value of DisassociateServiceRoleFromAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisassociateServiceRoleFromAccountResponse Source #
See: newDisassociateServiceRoleFromAccountResponse
smart constructor.
Instances
Generic DisassociateServiceRoleFromAccountResponse Source # | |
Read DisassociateServiceRoleFromAccountResponse Source # | |
Show DisassociateServiceRoleFromAccountResponse Source # | |
NFData DisassociateServiceRoleFromAccountResponse Source # | |
Eq DisassociateServiceRoleFromAccountResponse Source # | |
type Rep DisassociateServiceRoleFromAccountResponse Source # | |
Defined in Amazonka.GreengrassV2.DisassociateServiceRoleFromAccount type Rep DisassociateServiceRoleFromAccountResponse = D1 ('MetaData "DisassociateServiceRoleFromAccountResponse" "Amazonka.GreengrassV2.DisassociateServiceRoleFromAccount" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "DisassociateServiceRoleFromAccountResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disassociatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateServiceRoleFromAccountResponse Source #
Create a value of DisassociateServiceRoleFromAccountResponse
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:disassociatedAt:DisassociateServiceRoleFromAccountResponse'
, disassociateServiceRoleFromAccountResponse_disassociatedAt
- The time when the service role was disassociated from IoT Greengrass for
your Amazon Web Services account in this Amazon Web Services Region.
$sel:httpStatus:DisassociateServiceRoleFromAccountResponse'
, disassociateServiceRoleFromAccountResponse_httpStatus
- The response's http status code.
GetComponent
data GetComponent Source #
See: newGetComponent
smart constructor.
Instances
Create a value of GetComponent
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:
GetComponent
, getComponent_recipeOutputFormat
- The format of the recipe.
GetComponent
, getComponent_arn
- The
ARN
of the component version.
data GetComponentResponse Source #
See: newGetComponentResponse
smart constructor.
Instances
newGetComponentResponse Source #
Create a value of GetComponentResponse
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:tags:GetComponentResponse'
, getComponentResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
$sel:httpStatus:GetComponentResponse'
, getComponentResponse_httpStatus
- The response's http status code.
GetComponent
, getComponentResponse_recipeOutputFormat
- The format of the recipe.
GetComponentResponse
, getComponentResponse_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.
GetComponentVersionArtifact
data GetComponentVersionArtifact Source #
See: newGetComponentVersionArtifact
smart constructor.
Instances
newGetComponentVersionArtifact Source #
:: Text | |
-> Text | |
-> GetComponentVersionArtifact |
Create a value of GetComponentVersionArtifact
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:
GetComponentVersionArtifact
, getComponentVersionArtifact_arn
- The
ARN
of the component version. Specify the ARN of a public or a Lambda
component version.
$sel:artifactName:GetComponentVersionArtifact'
, getComponentVersionArtifact_artifactName
- The name of the artifact.
You can use the
GetComponent
operation to download the component recipe, which includes the URI of
the artifact. The artifact name is the section of the URI after the
scheme. For example, in the artifact URI greengrass:SomeArtifact.zip
,
the artifact name is SomeArtifact.zip
.
data GetComponentVersionArtifactResponse Source #
See: newGetComponentVersionArtifactResponse
smart constructor.
Instances
newGetComponentVersionArtifactResponse Source #
Create a value of GetComponentVersionArtifactResponse
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:httpStatus:GetComponentVersionArtifactResponse'
, getComponentVersionArtifactResponse_httpStatus
- The response's http status code.
$sel:preSignedUrl:GetComponentVersionArtifactResponse'
, getComponentVersionArtifactResponse_preSignedUrl
- The URL of the artifact.
GetConnectivityInfo
data GetConnectivityInfo Source #
See: newGetConnectivityInfo
smart constructor.
Instances
newGetConnectivityInfo Source #
Create a value of GetConnectivityInfo
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:
GetConnectivityInfo
, getConnectivityInfo_thingName
- The name of the core device. This is also the name of the IoT thing.
data GetConnectivityInfoResponse Source #
See: newGetConnectivityInfoResponse
smart constructor.
Instances
newGetConnectivityInfoResponse Source #
Create a value of GetConnectivityInfoResponse
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:connectivityInfo:GetConnectivityInfoResponse'
, getConnectivityInfoResponse_connectivityInfo
- The connectivity information for the core device.
GetConnectivityInfoResponse
, getConnectivityInfoResponse_message
- A message about the connectivity information request.
$sel:httpStatus:GetConnectivityInfoResponse'
, getConnectivityInfoResponse_httpStatus
- The response's http status code.
GetCoreDevice
data GetCoreDevice Source #
See: newGetCoreDevice
smart constructor.
Instances
Create a value of GetCoreDevice
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:
GetCoreDevice
, getCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data GetCoreDeviceResponse Source #
See: newGetCoreDeviceResponse
smart constructor.
GetCoreDeviceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe CoreDeviceStatus) (Maybe (HashMap Text Text)) Int |
Instances
newGetCoreDeviceResponse Source #
Create a value of GetCoreDeviceResponse
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:architecture:GetCoreDeviceResponse'
, getCoreDeviceResponse_architecture
- The computer architecture of the core device.
GetCoreDevice
, getCoreDeviceResponse_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
$sel:coreVersion:GetCoreDeviceResponse'
, getCoreDeviceResponse_coreVersion
- The version of the IoT Greengrass Core software that the core device
runs. This version is equivalent to the version of the Greengrass
nucleus component that runs on the core device. For more information,
see the
Greengrass nucleus component
in the IoT Greengrass V2 Developer Guide.
GetCoreDeviceResponse
, getCoreDeviceResponse_lastStatusUpdateTimestamp
- The time at which the core device's status last updated, expressed in
ISO 8601 format.
$sel:platform:GetCoreDeviceResponse'
, getCoreDeviceResponse_platform
- The operating system platform that the core device runs.
GetCoreDeviceResponse
, getCoreDeviceResponse_status
- The status of the core device. The core device status can be:
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.
$sel:tags:GetCoreDeviceResponse'
, getCoreDeviceResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
$sel:httpStatus:GetCoreDeviceResponse'
, getCoreDeviceResponse_httpStatus
- The response's http status code.
GetDeployment
data GetDeployment Source #
See: newGetDeployment
smart constructor.
Instances
Create a value of GetDeployment
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:
GetDeployment
, getDeployment_deploymentId
- The ID of the deployment.
data GetDeploymentResponse Source #
See: newGetDeploymentResponse
smart constructor.
GetDeploymentResponse' (Maybe (HashMap Text ComponentDeploymentSpecification)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeploymentPolicies) (Maybe DeploymentStatus) (Maybe Text) (Maybe DeploymentIoTJobConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newGetDeploymentResponse Source #
Create a value of GetDeploymentResponse
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:components:GetDeploymentResponse'
, getDeploymentResponse_components
- The components to deploy. This is a dictionary, where each key is the
name of a component, and each key's value is the version and
configuration to deploy for that component.
GetDeploymentResponse
, getDeploymentResponse_creationTimestamp
- The time at which the deployment was created, expressed in ISO 8601
format.
GetDeployment
, getDeploymentResponse_deploymentId
- The ID of the deployment.
GetDeploymentResponse
, getDeploymentResponse_deploymentName
- The name of the deployment.
$sel:deploymentPolicies:GetDeploymentResponse'
, getDeploymentResponse_deploymentPolicies
- The deployment policies for the deployment. These policies define how
the deployment updates components and handles failure.
GetDeploymentResponse
, getDeploymentResponse_deploymentStatus
- The status of the deployment.
GetDeploymentResponse
, getDeploymentResponse_iotJobArn
- The
ARN
of the IoT job that applies the deployment to target devices.
$sel:iotJobConfiguration:GetDeploymentResponse'
, getDeploymentResponse_iotJobConfiguration
- The job configuration for the deployment configuration. The job
configuration specifies the rollout, timeout, and stop configurations
for the deployment configuration.
GetDeploymentResponse
, getDeploymentResponse_iotJobId
- The ID of the IoT job that applies the deployment to target devices.
GetDeploymentResponse
, getDeploymentResponse_isLatestForTarget
- Whether or not the deployment is the latest revision for its target.
GetDeploymentResponse
, getDeploymentResponse_parentTargetArn
- The parent deployment's target
ARN
within a subdeployment.
GetDeploymentResponse
, getDeploymentResponse_revisionId
- The revision number of the deployment.
$sel:tags:GetDeploymentResponse'
, getDeploymentResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
GetDeploymentResponse
, getDeploymentResponse_targetArn
- The
ARN
of the target IoT thing or thing group.
$sel:httpStatus:GetDeploymentResponse'
, getDeploymentResponse_httpStatus
- The response's http status code.
GetServiceRoleForAccount
data GetServiceRoleForAccount Source #
See: newGetServiceRoleForAccount
smart constructor.
Instances
newGetServiceRoleForAccount :: GetServiceRoleForAccount Source #
Create a value of GetServiceRoleForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetServiceRoleForAccountResponse Source #
See: newGetServiceRoleForAccountResponse
smart constructor.
Instances
newGetServiceRoleForAccountResponse Source #
Create a value of GetServiceRoleForAccountResponse
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:associatedAt:GetServiceRoleForAccountResponse'
, getServiceRoleForAccountResponse_associatedAt
- The time when the service role was associated with IoT Greengrass for
your Amazon Web Services account in this Amazon Web Services Region.
$sel:roleArn:GetServiceRoleForAccountResponse'
, getServiceRoleForAccountResponse_roleArn
- The ARN of the service role that is associated with IoT Greengrass for
your Amazon Web Services account in this Amazon Web Services Region.
$sel:httpStatus:GetServiceRoleForAccountResponse'
, getServiceRoleForAccountResponse_httpStatus
- The response's http status code.
ListClientDevicesAssociatedWithCoreDevice (Paginated)
data ListClientDevicesAssociatedWithCoreDevice Source #
See: newListClientDevicesAssociatedWithCoreDevice
smart constructor.
Instances
newListClientDevicesAssociatedWithCoreDevice Source #
Create a value of ListClientDevicesAssociatedWithCoreDevice
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:maxResults:ListClientDevicesAssociatedWithCoreDevice'
, listClientDevicesAssociatedWithCoreDevice_maxResults
- The maximum number of results to be returned per paginated request.
ListClientDevicesAssociatedWithCoreDevice
, listClientDevicesAssociatedWithCoreDevice_nextToken
- The token to be used for the next set of paginated results.
ListClientDevicesAssociatedWithCoreDevice
, listClientDevicesAssociatedWithCoreDevice_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data ListClientDevicesAssociatedWithCoreDeviceResponse Source #
See: newListClientDevicesAssociatedWithCoreDeviceResponse
smart constructor.
ListClientDevicesAssociatedWithCoreDeviceResponse' (Maybe (NonEmpty AssociatedClientDevice)) (Maybe Text) Int |
Instances
newListClientDevicesAssociatedWithCoreDeviceResponse Source #
:: Int |
|
-> ListClientDevicesAssociatedWithCoreDeviceResponse |
Create a value of ListClientDevicesAssociatedWithCoreDeviceResponse
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:associatedClientDevices:ListClientDevicesAssociatedWithCoreDeviceResponse'
, listClientDevicesAssociatedWithCoreDeviceResponse_associatedClientDevices
- A list that describes the client devices that are associated with the
core device.
ListClientDevicesAssociatedWithCoreDevice
, listClientDevicesAssociatedWithCoreDeviceResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListClientDevicesAssociatedWithCoreDeviceResponse'
, listClientDevicesAssociatedWithCoreDeviceResponse_httpStatus
- The response's http status code.
ListComponentVersions (Paginated)
data ListComponentVersions Source #
See: newListComponentVersions
smart constructor.
Instances
newListComponentVersions Source #
Create a value of ListComponentVersions
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:maxResults:ListComponentVersions'
, listComponentVersions_maxResults
- The maximum number of results to be returned per paginated request.
ListComponentVersions
, listComponentVersions_nextToken
- The token to be used for the next set of paginated results.
ListComponentVersions
, listComponentVersions_arn
- The
ARN
of the component.
data ListComponentVersionsResponse Source #
See: newListComponentVersionsResponse
smart constructor.
Instances
newListComponentVersionsResponse Source #
Create a value of ListComponentVersionsResponse
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:componentVersions:ListComponentVersionsResponse'
, listComponentVersionsResponse_componentVersions
- A list of versions that exist for the component.
ListComponentVersions
, listComponentVersionsResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListComponentVersionsResponse'
, listComponentVersionsResponse_httpStatus
- The response's http status code.
ListComponents (Paginated)
data ListComponents Source #
See: newListComponents
smart constructor.
Instances
newListComponents :: ListComponents Source #
Create a value of ListComponents
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:maxResults:ListComponents'
, listComponents_maxResults
- The maximum number of results to be returned per paginated request.
ListComponents
, listComponents_nextToken
- The token to be used for the next set of paginated results.
$sel:scope:ListComponents'
, listComponents_scope
- The scope of the components to list.
Default: PRIVATE
data ListComponentsResponse Source #
See: newListComponentsResponse
smart constructor.
Instances
newListComponentsResponse Source #
Create a value of ListComponentsResponse
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:components:ListComponentsResponse'
, listComponentsResponse_components
- A list that summarizes each component.
ListComponents
, listComponentsResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListComponentsResponse'
, listComponentsResponse_httpStatus
- The response's http status code.
ListCoreDevices (Paginated)
data ListCoreDevices Source #
See: newListCoreDevices
smart constructor.
Instances
newListCoreDevices :: ListCoreDevices Source #
Create a value of ListCoreDevices
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:maxResults:ListCoreDevices'
, listCoreDevices_maxResults
- The maximum number of results to be returned per paginated request.
ListCoreDevices
, listCoreDevices_nextToken
- The token to be used for the next set of paginated results.
ListCoreDevices
, listCoreDevices_status
- The core device status by which to filter. If you specify this
parameter, the list includes only core devices that have this status.
Choose one of the following options:
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.
$sel:thingGroupArn:ListCoreDevices'
, listCoreDevices_thingGroupArn
- The
ARN
of the IoT thing group by which to filter. If you specify this
parameter, the list includes only core devices that have successfully
deployed a deployment that targets the thing group. When you remove a
core device from a thing group, the list continues to include that core
device.
data ListCoreDevicesResponse Source #
See: newListCoreDevicesResponse
smart constructor.
Instances
newListCoreDevicesResponse Source #
Create a value of ListCoreDevicesResponse
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:coreDevices:ListCoreDevicesResponse'
, listCoreDevicesResponse_coreDevices
- A list that summarizes each core device.
ListCoreDevices
, listCoreDevicesResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListCoreDevicesResponse'
, listCoreDevicesResponse_httpStatus
- The response's http status code.
ListDeployments (Paginated)
data ListDeployments Source #
See: newListDeployments
smart constructor.
ListDeployments' (Maybe DeploymentHistoryFilter) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newListDeployments :: ListDeployments Source #
Create a value of ListDeployments
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:historyFilter:ListDeployments'
, listDeployments_historyFilter
- The filter for the list of deployments. Choose one of the following
options:
ALL
– The list includes all deployments.LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default: LATEST_ONLY
$sel:maxResults:ListDeployments'
, listDeployments_maxResults
- The maximum number of results to be returned per paginated request.
ListDeployments
, listDeployments_nextToken
- The token to be used for the next set of paginated results.
ListDeployments
, listDeployments_parentTargetArn
- The parent deployment's target
ARN
within a subdeployment.
ListDeployments
, listDeployments_targetArn
- The
ARN
of the target IoT thing or thing group.
data ListDeploymentsResponse Source #
See: newListDeploymentsResponse
smart constructor.
Instances
newListDeploymentsResponse Source #
Create a value of ListDeploymentsResponse
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:deployments:ListDeploymentsResponse'
, listDeploymentsResponse_deployments
- A list that summarizes each deployment.
ListDeployments
, listDeploymentsResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListDeploymentsResponse'
, listDeploymentsResponse_httpStatus
- The response's http status code.
ListEffectiveDeployments (Paginated)
data ListEffectiveDeployments Source #
See: newListEffectiveDeployments
smart constructor.
Instances
newListEffectiveDeployments Source #
Create a value of ListEffectiveDeployments
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:maxResults:ListEffectiveDeployments'
, listEffectiveDeployments_maxResults
- The maximum number of results to be returned per paginated request.
ListEffectiveDeployments
, listEffectiveDeployments_nextToken
- The token to be used for the next set of paginated results.
ListEffectiveDeployments
, listEffectiveDeployments_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data ListEffectiveDeploymentsResponse Source #
See: newListEffectiveDeploymentsResponse
smart constructor.
Instances
newListEffectiveDeploymentsResponse Source #
Create a value of ListEffectiveDeploymentsResponse
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:effectiveDeployments:ListEffectiveDeploymentsResponse'
, listEffectiveDeploymentsResponse_effectiveDeployments
- A list that summarizes each deployment on the core device.
ListEffectiveDeployments
, listEffectiveDeploymentsResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListEffectiveDeploymentsResponse'
, listEffectiveDeploymentsResponse_httpStatus
- The response's http status code.
ListInstalledComponents (Paginated)
data ListInstalledComponents Source #
See: newListInstalledComponents
smart constructor.
Instances
newListInstalledComponents Source #
Create a value of ListInstalledComponents
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:maxResults:ListInstalledComponents'
, listInstalledComponents_maxResults
- The maximum number of results to be returned per paginated request.
ListInstalledComponents
, listInstalledComponents_nextToken
- The token to be used for the next set of paginated results.
$sel:topologyFilter:ListInstalledComponents'
, listInstalledComponents_topologyFilter
- The filter for the list of components. Choose from the following
options:
ALL
– The list includes all components installed on the core device.ROOT
– The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn't include components that the core device installs as dependencies of other components.
Default: ROOT
ListInstalledComponents
, listInstalledComponents_coreDeviceThingName
- The name of the core device. This is also the name of the IoT thing.
data ListInstalledComponentsResponse Source #
See: newListInstalledComponentsResponse
smart constructor.
Instances
newListInstalledComponentsResponse Source #
Create a value of ListInstalledComponentsResponse
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:installedComponents:ListInstalledComponentsResponse'
, listInstalledComponentsResponse_installedComponents
- A list that summarizes each component on the core device.
Greengrass nucleus v2.7.0 or later is required to get an accurate
lastStatusChangeTimestamp
response. This response can be inaccurate in
earlier Greengrass nucleus versions.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lastInstallationSource
and lastReportedTimestamp
response. This
response can be inaccurate or null in earlier Greengrass nucleus
versions.
ListInstalledComponents
, listInstalledComponentsResponse_nextToken
- The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListInstalledComponentsResponse'
, listInstalledComponentsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The
ARN
of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ResolveComponentCandidates
data ResolveComponentCandidates Source #
See: newResolveComponentCandidates
smart constructor.
Instances
newResolveComponentCandidates :: ResolveComponentCandidates Source #
Create a value of ResolveComponentCandidates
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:componentCandidates:ResolveComponentCandidates'
, resolveComponentCandidates_componentCandidates
- The list of components to resolve.
$sel:platform:ResolveComponentCandidates'
, resolveComponentCandidates_platform
- The platform to use to resolve compatible components.
data ResolveComponentCandidatesResponse Source #
See: newResolveComponentCandidatesResponse
smart constructor.
Instances
newResolveComponentCandidatesResponse Source #
Create a value of ResolveComponentCandidatesResponse
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:resolvedComponentVersions:ResolveComponentCandidatesResponse'
, resolveComponentCandidatesResponse_resolvedComponentVersions
- A list of components that meet the requirements that you specify in the
request. This list includes each component's recipe that you can use to
install the component.
$sel:httpStatus:ResolveComponentCandidatesResponse'
, resolveComponentCandidatesResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The
ARN
of the resource to tag.
$sel:tags:TagResource'
, tagResource_tags
- A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The
ARN
of the resource to untag.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of keys for tags to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateConnectivityInfo
data UpdateConnectivityInfo Source #
See: newUpdateConnectivityInfo
smart constructor.
Instances
newUpdateConnectivityInfo Source #
Create a value of UpdateConnectivityInfo
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:
UpdateConnectivityInfo
, updateConnectivityInfo_thingName
- The name of the core device. This is also the name of the IoT thing.
$sel:connectivityInfo:UpdateConnectivityInfo'
, updateConnectivityInfo_connectivityInfo
- The connectivity information for the core device.
data UpdateConnectivityInfoResponse Source #
See: newUpdateConnectivityInfoResponse
smart constructor.
Instances
newUpdateConnectivityInfoResponse Source #
Create a value of UpdateConnectivityInfoResponse
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:
UpdateConnectivityInfoResponse
, updateConnectivityInfoResponse_message
- A message about the connectivity information update request.
$sel:version:UpdateConnectivityInfoResponse'
, updateConnectivityInfoResponse_version
- The new version of the connectivity information for the core device.
$sel:httpStatus:UpdateConnectivityInfoResponse'
, updateConnectivityInfoResponse_httpStatus
- The response's http status code.
Types
CloudComponentState
newtype CloudComponentState Source #
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 #
pattern ComponentDependencyType_HARD :: ComponentDependencyType | |
pattern ComponentDependencyType_SOFT :: ComponentDependencyType |
Instances
ComponentVisibilityScope
newtype ComponentVisibilityScope Source #
pattern ComponentVisibilityScope_PRIVATE :: ComponentVisibilityScope | |
pattern ComponentVisibilityScope_PUBLIC :: ComponentVisibilityScope |
Instances
CoreDeviceStatus
newtype CoreDeviceStatus Source #
pattern CoreDeviceStatus_HEALTHY :: CoreDeviceStatus | |
pattern CoreDeviceStatus_UNHEALTHY :: CoreDeviceStatus |
Instances
DeploymentComponentUpdatePolicyAction
newtype DeploymentComponentUpdatePolicyAction Source #
Instances
DeploymentFailureHandlingPolicy
newtype DeploymentFailureHandlingPolicy Source #
pattern DeploymentFailureHandlingPolicy_DO_NOTHING :: DeploymentFailureHandlingPolicy | |
pattern DeploymentFailureHandlingPolicy_ROLLBACK :: DeploymentFailureHandlingPolicy |
Instances
DeploymentHistoryFilter
newtype DeploymentHistoryFilter Source #
pattern DeploymentHistoryFilter_ALL :: DeploymentHistoryFilter | |
pattern DeploymentHistoryFilter_LATEST_ONLY :: DeploymentHistoryFilter |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
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 #
Instances
InstalledComponentLifecycleState
newtype InstalledComponentLifecycleState Source #
Instances
InstalledComponentTopologyFilter
newtype InstalledComponentTopologyFilter Source #
pattern InstalledComponentTopologyFilter_ALL :: InstalledComponentTopologyFilter | |
pattern InstalledComponentTopologyFilter_ROOT :: InstalledComponentTopologyFilter |
Instances
IoTJobAbortAction
newtype IoTJobAbortAction Source #
pattern IoTJobAbortAction_CANCEL :: IoTJobAbortAction |
Instances
IoTJobExecutionFailureType
newtype IoTJobExecutionFailureType Source #
Instances
LambdaEventSourceType
newtype LambdaEventSourceType Source #
pattern LambdaEventSourceType_IOT_CORE :: LambdaEventSourceType | |
pattern LambdaEventSourceType_PUB_SUB :: LambdaEventSourceType |
Instances
LambdaFilesystemPermission
newtype LambdaFilesystemPermission Source #
pattern LambdaFilesystemPermission_Ro :: LambdaFilesystemPermission | |
pattern LambdaFilesystemPermission_Rw :: LambdaFilesystemPermission |
Instances
LambdaInputPayloadEncodingType
newtype LambdaInputPayloadEncodingType Source #
pattern LambdaInputPayloadEncodingType_Binary :: LambdaInputPayloadEncodingType | |
pattern LambdaInputPayloadEncodingType_Json :: LambdaInputPayloadEncodingType |
Instances
LambdaIsolationMode
newtype LambdaIsolationMode Source #
pattern LambdaIsolationMode_GreengrassContainer :: LambdaIsolationMode | |
pattern LambdaIsolationMode_NoContainer :: LambdaIsolationMode |
Instances
RecipeOutputFormat
newtype RecipeOutputFormat Source #
pattern RecipeOutputFormat_JSON :: RecipeOutputFormat | |
pattern RecipeOutputFormat_YAML :: RecipeOutputFormat |
Instances
VendorGuidance
newtype VendorGuidance Source #
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.
Instances
ToJSON AssociateClientDeviceWithCoreDeviceEntry Source # | |
Generic AssociateClientDeviceWithCoreDeviceEntry Source # | |
Read AssociateClientDeviceWithCoreDeviceEntry Source # | |
Show AssociateClientDeviceWithCoreDeviceEntry Source # | |
NFData AssociateClientDeviceWithCoreDeviceEntry Source # | |
Eq AssociateClientDeviceWithCoreDeviceEntry Source # | |
Hashable AssociateClientDeviceWithCoreDeviceEntry Source # | |
type Rep AssociateClientDeviceWithCoreDeviceEntry Source # | |
Defined in Amazonka.GreengrassV2.Types.AssociateClientDeviceWithCoreDeviceEntry type Rep AssociateClientDeviceWithCoreDeviceEntry = D1 ('MetaData "AssociateClientDeviceWithCoreDeviceEntry" "Amazonka.GreengrassV2.Types.AssociateClientDeviceWithCoreDeviceEntry" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "AssociateClientDeviceWithCoreDeviceEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newAssociateClientDeviceWithCoreDeviceEntry Source #
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.
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.
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.
AssociatedClientDevice
data AssociatedClientDevice Source #
Contains information about a client device that is associated to a core device for cloud discovery.
See: newAssociatedClientDevice
smart constructor.
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.
CloudComponentStatus
data CloudComponentStatus Source #
Contains the status of a component version in the IoT Greengrass service.
See: newCloudComponentStatus
smart constructor.
CloudComponentStatus' (Maybe CloudComponentState) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VendorGuidance) (Maybe Text) |
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.
Component
Contains information about a component.
See: newComponent
smart constructor.
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.
ComponentCandidate
data ComponentCandidate Source #
Contains information about a component that is a candidate to deploy to a Greengrass core device.
See: newComponentCandidate
smart constructor.
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.
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.
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.
ComponentDependencyRequirement
data ComponentDependencyRequirement Source #
Contains information about a component dependency for a Lambda function component.
See: newComponentDependencyRequirement
smart constructor.
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.
ComponentDeploymentSpecification
data ComponentDeploymentSpecification Source #
Contains information about a component to deploy.
See: newComponentDeploymentSpecification
smart constructor.
ComponentDeploymentSpecification' (Maybe Text) (Maybe ComponentConfigurationUpdate) (Maybe ComponentRunWith) |
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.
ComponentLatestVersion
data ComponentLatestVersion Source #
Contains information about the latest version of a component.
See: newComponentLatestVersion
smart constructor.
ComponentLatestVersion' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text) |
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.
ComponentPlatform
data ComponentPlatform Source #
Contains information about a platform that a component supports.
See: newComponentPlatform
smart constructor.
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.
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.
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.
ComponentVersionListItem
data ComponentVersionListItem Source #
Contains information about a component version in a list.
See: newComponentVersionListItem
smart constructor.
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.
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.
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.
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.
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.
Deployment
data Deployment Source #
Contains information about a deployment.
See: newDeployment
smart constructor.
Deployment' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeploymentStatus) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
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.
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.
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
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.
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
DeploymentIoTJobConfiguration
data DeploymentIoTJobConfiguration Source #
Contains information about an IoT job configuration.
See: newDeploymentIoTJobConfiguration
smart constructor.
DeploymentIoTJobConfiguration' (Maybe IoTJobAbortConfig) (Maybe IoTJobExecutionsRolloutConfig) (Maybe IoTJobTimeoutConfig) |
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.
DeploymentPolicies
data DeploymentPolicies Source #
Contains information about policies that define how a deployment updates components and handles failure.
See: newDeploymentPolicies
smart constructor.
DeploymentPolicies' (Maybe DeploymentComponentUpdatePolicy) (Maybe DeploymentConfigurationValidationPolicy) (Maybe DeploymentFailureHandlingPolicy) |
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
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.
Instances
ToJSON DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Generic DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Read DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Show DisassociateClientDeviceFromCoreDeviceEntry Source # | |
NFData DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Eq DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Hashable DisassociateClientDeviceFromCoreDeviceEntry Source # | |
type Rep DisassociateClientDeviceFromCoreDeviceEntry Source # | |
Defined in Amazonka.GreengrassV2.Types.DisassociateClientDeviceFromCoreDeviceEntry type Rep DisassociateClientDeviceFromCoreDeviceEntry = D1 ('MetaData "DisassociateClientDeviceFromCoreDeviceEntry" "Amazonka.GreengrassV2.Types.DisassociateClientDeviceFromCoreDeviceEntry" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "DisassociateClientDeviceFromCoreDeviceEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newDisassociateClientDeviceFromCoreDeviceEntry Source #
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.
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.
EffectiveDeployment
data EffectiveDeployment Source #
Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
See: newEffectiveDeployment
smart constructor.
EffectiveDeployment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EffectiveDeploymentStatusDetails) Text Text Text EffectiveDeploymentExecutionStatus POSIX POSIX |
Instances
newEffectiveDeployment Source #
:: 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.
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.
Instances
FromJSON EffectiveDeploymentStatusDetails Source # | |
Generic EffectiveDeploymentStatusDetails Source # | |
Read EffectiveDeploymentStatusDetails Source # | |
Show EffectiveDeploymentStatusDetails Source # | |
NFData EffectiveDeploymentStatusDetails Source # | |
Eq EffectiveDeploymentStatusDetails Source # | |
Hashable EffectiveDeploymentStatusDetails Source # | |
type Rep EffectiveDeploymentStatusDetails Source # | |
Defined in Amazonka.GreengrassV2.Types.EffectiveDeploymentStatusDetails type Rep EffectiveDeploymentStatusDetails = D1 ('MetaData "EffectiveDeploymentStatusDetails" "Amazonka.GreengrassV2.Types.EffectiveDeploymentStatusDetails" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "EffectiveDeploymentStatusDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorStack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "errorTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) |
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.
InstalledComponent
data InstalledComponent Source #
Contains information about a component on a Greengrass core device.
See: newInstalledComponent
smart constructor.
InstalledComponent' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe InstalledComponentLifecycleState) (Maybe Text) (Maybe [Text]) |
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.
IoTJobAbortConfig
data IoTJobAbortConfig Source #
Contains a list of criteria that define when and how to cancel a configuration deployment.
See: newIoTJobAbortConfig
smart constructor.
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.
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
failureType
exceeds thethresholdPercentage
.
See: newIoTJobAbortCriteria
smart constructor.
Instances
newIoTJobAbortCriteria Source #
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.
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.
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.
IoTJobExponentialRolloutRate
data IoTJobExponentialRolloutRate Source #
Contains information about an exponential rollout rate for a configuration deployment job.
See: newIoTJobExponentialRolloutRate
smart constructor.
Instances
newIoTJobExponentialRolloutRate Source #
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.
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.
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.
IoTJobTimeoutConfig
data IoTJobTimeoutConfig Source #
Contains information about the timeout configuration for a job.
See: newIoTJobTimeoutConfig
smart constructor.
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).
LambdaContainerParams
data LambdaContainerParams Source #
Contains information about a container in which Lambda functions run on Greengrass core devices.
See: newLambdaContainerParams
smart constructor.
LambdaContainerParams' (Maybe [LambdaDeviceMount]) (Maybe Int) (Maybe Bool) (Maybe [LambdaVolumeMount]) |
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.
LambdaDeviceMount
data LambdaDeviceMount Source #
Contains information about a device that Linux processes in a container can access.
See: newLambdaDeviceMount
smart constructor.
Instances
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.
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.
Instances
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.
LambdaExecutionParameters
data LambdaExecutionParameters Source #
Contains parameters for a Lambda function that runs on IoT Greengrass.
See: newLambdaExecutionParameters
smart constructor.
LambdaExecutionParameters' (Maybe (HashMap Text Text)) (Maybe [LambdaEventSource]) (Maybe [Text]) (Maybe LambdaInputPayloadEncodingType) (Maybe LambdaLinuxProcessParams) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int) |
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.
LambdaFunctionRecipeSource
data LambdaFunctionRecipeSource Source #
Contains information about an Lambda function to import to create a component.
See: newLambdaFunctionRecipeSource
smart constructor.
LambdaFunctionRecipeSource' (Maybe (HashMap Text ComponentDependencyRequirement)) (Maybe LambdaExecutionParameters) (Maybe Text) (Maybe [ComponentPlatform]) (Maybe Text) Text |
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
.
LambdaLinuxProcessParams
data LambdaLinuxProcessParams Source #
Contains parameters for a Linux process that contains an Lambda function.
See: newLambdaLinuxProcessParams
smart constructor.
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
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.
Instances
:: 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.
ResolvedComponentVersion
data ResolvedComponentVersion Source #
Contains information about a component version that is compatible to run on a Greengrass core device.
See: newResolvedComponentVersion
smart constructor.
ResolvedComponentVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Base64) (Maybe VendorGuidance) |
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.
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.
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.