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 |
- Operations
- AssociateServiceRoleToAccount
- BatchAssociateClientDeviceWithCoreDevice
- BatchDisassociateClientDeviceFromCoreDevice
- CancelDeployment
- CreateComponentVersion
- CreateDeployment
- DeleteComponent
- DeleteCoreDevice
- DeleteDeployment
- DescribeComponent
- DisassociateServiceRoleFromAccount
- GetComponent
- GetComponentVersionArtifact
- GetConnectivityInfo
- GetCoreDevice
- GetDeployment
- GetServiceRoleForAccount
- ListClientDevicesAssociatedWithCoreDevice
- ListComponentVersions
- ListComponents
- ListCoreDevices
- ListDeployments
- ListEffectiveDeployments
- ListInstalledComponents
- ListTagsForResource
- ResolveComponentCandidates
- TagResource
- UntagResource
- UpdateConnectivityInfo
- Types
- 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
Synopsis
- associateServiceRoleToAccount_roleArn :: Lens' AssociateServiceRoleToAccount Text
- associateServiceRoleToAccountResponse_associatedAt :: Lens' AssociateServiceRoleToAccountResponse (Maybe Text)
- associateServiceRoleToAccountResponse_httpStatus :: Lens' AssociateServiceRoleToAccountResponse Int
- batchAssociateClientDeviceWithCoreDevice_entries :: Lens' BatchAssociateClientDeviceWithCoreDevice (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry))
- batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName :: Lens' BatchAssociateClientDeviceWithCoreDevice Text
- batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse (Maybe [AssociateClientDeviceWithCoreDeviceErrorEntry])
- batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse Int
- batchDisassociateClientDeviceFromCoreDevice_entries :: Lens' BatchDisassociateClientDeviceFromCoreDevice (Maybe (NonEmpty DisassociateClientDeviceFromCoreDeviceEntry))
- batchDisassociateClientDeviceFromCoreDevice_coreDeviceThingName :: Lens' BatchDisassociateClientDeviceFromCoreDevice Text
- batchDisassociateClientDeviceFromCoreDeviceResponse_errorEntries :: Lens' BatchDisassociateClientDeviceFromCoreDeviceResponse (Maybe [DisassociateClientDeviceFromCoreDeviceErrorEntry])
- batchDisassociateClientDeviceFromCoreDeviceResponse_httpStatus :: Lens' BatchDisassociateClientDeviceFromCoreDeviceResponse Int
- cancelDeployment_deploymentId :: Lens' CancelDeployment Text
- cancelDeploymentResponse_message :: Lens' CancelDeploymentResponse (Maybe Text)
- cancelDeploymentResponse_httpStatus :: Lens' CancelDeploymentResponse Int
- createComponentVersion_clientToken :: Lens' CreateComponentVersion (Maybe Text)
- createComponentVersion_inlineRecipe :: Lens' CreateComponentVersion (Maybe ByteString)
- createComponentVersion_lambdaFunction :: Lens' CreateComponentVersion (Maybe LambdaFunctionRecipeSource)
- createComponentVersion_tags :: Lens' CreateComponentVersion (Maybe (HashMap Text Text))
- createComponentVersionResponse_arn :: Lens' CreateComponentVersionResponse (Maybe Text)
- createComponentVersionResponse_httpStatus :: Lens' CreateComponentVersionResponse Int
- createComponentVersionResponse_componentName :: Lens' CreateComponentVersionResponse Text
- createComponentVersionResponse_componentVersion :: Lens' CreateComponentVersionResponse Text
- createComponentVersionResponse_creationTimestamp :: Lens' CreateComponentVersionResponse UTCTime
- createComponentVersionResponse_status :: Lens' CreateComponentVersionResponse CloudComponentStatus
- createDeployment_clientToken :: Lens' CreateDeployment (Maybe Text)
- createDeployment_components :: Lens' CreateDeployment (Maybe (HashMap Text ComponentDeploymentSpecification))
- createDeployment_deploymentName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_deploymentPolicies :: Lens' CreateDeployment (Maybe DeploymentPolicies)
- createDeployment_iotJobConfiguration :: Lens' CreateDeployment (Maybe DeploymentIoTJobConfiguration)
- createDeployment_parentTargetArn :: Lens' CreateDeployment (Maybe Text)
- createDeployment_tags :: Lens' CreateDeployment (Maybe (HashMap Text Text))
- createDeployment_targetArn :: Lens' CreateDeployment Text
- createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_iotJobArn :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_iotJobId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int
- deleteComponent_arn :: Lens' DeleteComponent Text
- deleteCoreDevice_coreDeviceThingName :: Lens' DeleteCoreDevice Text
- deleteDeployment_deploymentId :: Lens' DeleteDeployment Text
- describeComponent_arn :: Lens' DescribeComponent Text
- describeComponentResponse_arn :: Lens' DescribeComponentResponse (Maybe Text)
- describeComponentResponse_componentName :: Lens' DescribeComponentResponse (Maybe Text)
- describeComponentResponse_componentVersion :: Lens' DescribeComponentResponse (Maybe Text)
- describeComponentResponse_creationTimestamp :: Lens' DescribeComponentResponse (Maybe UTCTime)
- describeComponentResponse_description :: Lens' DescribeComponentResponse (Maybe Text)
- describeComponentResponse_platforms :: Lens' DescribeComponentResponse (Maybe [ComponentPlatform])
- describeComponentResponse_publisher :: Lens' DescribeComponentResponse (Maybe Text)
- describeComponentResponse_status :: Lens' DescribeComponentResponse (Maybe CloudComponentStatus)
- describeComponentResponse_tags :: Lens' DescribeComponentResponse (Maybe (HashMap Text Text))
- describeComponentResponse_httpStatus :: Lens' DescribeComponentResponse Int
- disassociateServiceRoleFromAccountResponse_disassociatedAt :: Lens' DisassociateServiceRoleFromAccountResponse (Maybe Text)
- disassociateServiceRoleFromAccountResponse_httpStatus :: Lens' DisassociateServiceRoleFromAccountResponse Int
- getComponent_recipeOutputFormat :: Lens' GetComponent (Maybe RecipeOutputFormat)
- getComponent_arn :: Lens' GetComponent Text
- getComponentResponse_tags :: Lens' GetComponentResponse (Maybe (HashMap Text Text))
- getComponentResponse_httpStatus :: Lens' GetComponentResponse Int
- getComponentResponse_recipeOutputFormat :: Lens' GetComponentResponse RecipeOutputFormat
- getComponentResponse_recipe :: Lens' GetComponentResponse ByteString
- getComponentVersionArtifact_arn :: Lens' GetComponentVersionArtifact Text
- getComponentVersionArtifact_artifactName :: Lens' GetComponentVersionArtifact Text
- getComponentVersionArtifactResponse_httpStatus :: Lens' GetComponentVersionArtifactResponse Int
- getComponentVersionArtifactResponse_preSignedUrl :: Lens' GetComponentVersionArtifactResponse Text
- getConnectivityInfo_thingName :: Lens' GetConnectivityInfo Text
- getConnectivityInfoResponse_connectivityInfo :: Lens' GetConnectivityInfoResponse (Maybe [ConnectivityInfo])
- getConnectivityInfoResponse_message :: Lens' GetConnectivityInfoResponse (Maybe Text)
- getConnectivityInfoResponse_httpStatus :: Lens' GetConnectivityInfoResponse Int
- getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text
- getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime)
- getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text)
- getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus)
- getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text))
- getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int
- getDeployment_deploymentId :: Lens' GetDeployment Text
- getDeploymentResponse_components :: Lens' GetDeploymentResponse (Maybe (HashMap Text ComponentDeploymentSpecification))
- getDeploymentResponse_creationTimestamp :: Lens' GetDeploymentResponse (Maybe UTCTime)
- getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_deploymentName :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_deploymentPolicies :: Lens' GetDeploymentResponse (Maybe DeploymentPolicies)
- getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus)
- getDeploymentResponse_iotJobArn :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_iotJobConfiguration :: Lens' GetDeploymentResponse (Maybe DeploymentIoTJobConfiguration)
- getDeploymentResponse_iotJobId :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_isLatestForTarget :: Lens' GetDeploymentResponse (Maybe Bool)
- getDeploymentResponse_parentTargetArn :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_revisionId :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_tags :: Lens' GetDeploymentResponse (Maybe (HashMap Text Text))
- getDeploymentResponse_targetArn :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int
- getServiceRoleForAccountResponse_associatedAt :: Lens' GetServiceRoleForAccountResponse (Maybe Text)
- getServiceRoleForAccountResponse_roleArn :: Lens' GetServiceRoleForAccountResponse (Maybe Text)
- getServiceRoleForAccountResponse_httpStatus :: Lens' GetServiceRoleForAccountResponse Int
- listClientDevicesAssociatedWithCoreDevice_maxResults :: Lens' ListClientDevicesAssociatedWithCoreDevice (Maybe Natural)
- listClientDevicesAssociatedWithCoreDevice_nextToken :: Lens' ListClientDevicesAssociatedWithCoreDevice (Maybe Text)
- listClientDevicesAssociatedWithCoreDevice_coreDeviceThingName :: Lens' ListClientDevicesAssociatedWithCoreDevice Text
- listClientDevicesAssociatedWithCoreDeviceResponse_associatedClientDevices :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse (Maybe (NonEmpty AssociatedClientDevice))
- listClientDevicesAssociatedWithCoreDeviceResponse_nextToken :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse (Maybe Text)
- listClientDevicesAssociatedWithCoreDeviceResponse_httpStatus :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse Int
- listComponentVersions_maxResults :: Lens' ListComponentVersions (Maybe Natural)
- listComponentVersions_nextToken :: Lens' ListComponentVersions (Maybe Text)
- listComponentVersions_arn :: Lens' ListComponentVersions Text
- listComponentVersionsResponse_componentVersions :: Lens' ListComponentVersionsResponse (Maybe [ComponentVersionListItem])
- listComponentVersionsResponse_nextToken :: Lens' ListComponentVersionsResponse (Maybe Text)
- listComponentVersionsResponse_httpStatus :: Lens' ListComponentVersionsResponse Int
- listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
- listComponents_nextToken :: Lens' ListComponents (Maybe Text)
- listComponents_scope :: Lens' ListComponents (Maybe ComponentVisibilityScope)
- listComponentsResponse_components :: Lens' ListComponentsResponse (Maybe [Component])
- listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
- listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int
- listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural)
- listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text)
- listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus)
- listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text)
- listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice])
- listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text)
- listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int
- listDeployments_historyFilter :: Lens' ListDeployments (Maybe DeploymentHistoryFilter)
- listDeployments_maxResults :: Lens' ListDeployments (Maybe Natural)
- listDeployments_nextToken :: Lens' ListDeployments (Maybe Text)
- listDeployments_parentTargetArn :: Lens' ListDeployments (Maybe Text)
- listDeployments_targetArn :: Lens' ListDeployments (Maybe Text)
- listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Deployment])
- listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text)
- listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int
- listEffectiveDeployments_maxResults :: Lens' ListEffectiveDeployments (Maybe Natural)
- listEffectiveDeployments_nextToken :: Lens' ListEffectiveDeployments (Maybe Text)
- listEffectiveDeployments_coreDeviceThingName :: Lens' ListEffectiveDeployments Text
- listEffectiveDeploymentsResponse_effectiveDeployments :: Lens' ListEffectiveDeploymentsResponse (Maybe [EffectiveDeployment])
- listEffectiveDeploymentsResponse_nextToken :: Lens' ListEffectiveDeploymentsResponse (Maybe Text)
- listEffectiveDeploymentsResponse_httpStatus :: Lens' ListEffectiveDeploymentsResponse Int
- listInstalledComponents_maxResults :: Lens' ListInstalledComponents (Maybe Natural)
- listInstalledComponents_nextToken :: Lens' ListInstalledComponents (Maybe Text)
- listInstalledComponents_topologyFilter :: Lens' ListInstalledComponents (Maybe InstalledComponentTopologyFilter)
- listInstalledComponents_coreDeviceThingName :: Lens' ListInstalledComponents Text
- listInstalledComponentsResponse_installedComponents :: Lens' ListInstalledComponentsResponse (Maybe [InstalledComponent])
- listInstalledComponentsResponse_nextToken :: Lens' ListInstalledComponentsResponse (Maybe Text)
- listInstalledComponentsResponse_httpStatus :: Lens' ListInstalledComponentsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- resolveComponentCandidates_componentCandidates :: Lens' ResolveComponentCandidates (Maybe [ComponentCandidate])
- resolveComponentCandidates_platform :: Lens' ResolveComponentCandidates (Maybe ComponentPlatform)
- resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens' ResolveComponentCandidatesResponse (Maybe [ResolvedComponentVersion])
- resolveComponentCandidatesResponse_httpStatus :: Lens' ResolveComponentCandidatesResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateConnectivityInfo_thingName :: Lens' UpdateConnectivityInfo Text
- updateConnectivityInfo_connectivityInfo :: Lens' UpdateConnectivityInfo [ConnectivityInfo]
- updateConnectivityInfoResponse_message :: Lens' UpdateConnectivityInfoResponse (Maybe Text)
- updateConnectivityInfoResponse_version :: Lens' UpdateConnectivityInfoResponse (Maybe Text)
- updateConnectivityInfoResponse_httpStatus :: Lens' UpdateConnectivityInfoResponse Int
- associateClientDeviceWithCoreDeviceEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceEntry Text
- associateClientDeviceWithCoreDeviceErrorEntry_code :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- associateClientDeviceWithCoreDeviceErrorEntry_message :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- associateClientDeviceWithCoreDeviceErrorEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text)
- associatedClientDevice_associationTimestamp :: Lens' AssociatedClientDevice (Maybe UTCTime)
- associatedClientDevice_thingName :: Lens' AssociatedClientDevice (Maybe Text)
- cloudComponentStatus_componentState :: Lens' CloudComponentStatus (Maybe CloudComponentState)
- cloudComponentStatus_errors :: Lens' CloudComponentStatus (Maybe (HashMap Text Text))
- cloudComponentStatus_message :: Lens' CloudComponentStatus (Maybe Text)
- cloudComponentStatus_vendorGuidance :: Lens' CloudComponentStatus (Maybe VendorGuidance)
- cloudComponentStatus_vendorGuidanceMessage :: Lens' CloudComponentStatus (Maybe Text)
- component_arn :: Lens' Component (Maybe Text)
- component_componentName :: Lens' Component (Maybe Text)
- component_latestVersion :: Lens' Component (Maybe ComponentLatestVersion)
- componentCandidate_componentName :: Lens' ComponentCandidate (Maybe Text)
- componentCandidate_componentVersion :: Lens' ComponentCandidate (Maybe Text)
- componentCandidate_versionRequirements :: Lens' ComponentCandidate (Maybe (HashMap Text Text))
- componentConfigurationUpdate_merge :: Lens' ComponentConfigurationUpdate (Maybe Text)
- componentConfigurationUpdate_reset :: Lens' ComponentConfigurationUpdate (Maybe [Text])
- componentDependencyRequirement_dependencyType :: Lens' ComponentDependencyRequirement (Maybe ComponentDependencyType)
- componentDependencyRequirement_versionRequirement :: Lens' ComponentDependencyRequirement (Maybe Text)
- componentDeploymentSpecification_componentVersion :: Lens' ComponentDeploymentSpecification (Maybe Text)
- componentDeploymentSpecification_configurationUpdate :: Lens' ComponentDeploymentSpecification (Maybe ComponentConfigurationUpdate)
- componentDeploymentSpecification_runWith :: Lens' ComponentDeploymentSpecification (Maybe ComponentRunWith)
- componentLatestVersion_arn :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_componentVersion :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_creationTimestamp :: Lens' ComponentLatestVersion (Maybe UTCTime)
- componentLatestVersion_description :: Lens' ComponentLatestVersion (Maybe Text)
- componentLatestVersion_platforms :: Lens' ComponentLatestVersion (Maybe [ComponentPlatform])
- componentLatestVersion_publisher :: Lens' ComponentLatestVersion (Maybe Text)
- componentPlatform_attributes :: Lens' ComponentPlatform (Maybe (HashMap Text Text))
- componentPlatform_name :: Lens' ComponentPlatform (Maybe Text)
- componentRunWith_posixUser :: Lens' ComponentRunWith (Maybe Text)
- componentRunWith_systemResourceLimits :: Lens' ComponentRunWith (Maybe SystemResourceLimits)
- componentRunWith_windowsUser :: Lens' ComponentRunWith (Maybe Text)
- componentVersionListItem_arn :: Lens' ComponentVersionListItem (Maybe Text)
- componentVersionListItem_componentName :: Lens' ComponentVersionListItem (Maybe Text)
- componentVersionListItem_componentVersion :: Lens' ComponentVersionListItem (Maybe Text)
- connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_metadata :: Lens' ConnectivityInfo (Maybe Text)
- connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Natural)
- coreDevice_coreDeviceThingName :: Lens' CoreDevice (Maybe Text)
- coreDevice_lastStatusUpdateTimestamp :: Lens' CoreDevice (Maybe UTCTime)
- coreDevice_status :: Lens' CoreDevice (Maybe CoreDeviceStatus)
- deployment_creationTimestamp :: Lens' Deployment (Maybe UTCTime)
- deployment_deploymentId :: Lens' Deployment (Maybe Text)
- deployment_deploymentName :: Lens' Deployment (Maybe Text)
- deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus)
- deployment_isLatestForTarget :: Lens' Deployment (Maybe Bool)
- deployment_parentTargetArn :: Lens' Deployment (Maybe Text)
- deployment_revisionId :: Lens' Deployment (Maybe Text)
- deployment_targetArn :: Lens' Deployment (Maybe Text)
- deploymentComponentUpdatePolicy_action :: Lens' DeploymentComponentUpdatePolicy (Maybe DeploymentComponentUpdatePolicyAction)
- deploymentComponentUpdatePolicy_timeoutInSeconds :: Lens' DeploymentComponentUpdatePolicy (Maybe Int)
- deploymentConfigurationValidationPolicy_timeoutInSeconds :: Lens' DeploymentConfigurationValidationPolicy (Maybe Int)
- deploymentIoTJobConfiguration_abortConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobAbortConfig)
- deploymentIoTJobConfiguration_jobExecutionsRolloutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobExecutionsRolloutConfig)
- deploymentIoTJobConfiguration_timeoutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobTimeoutConfig)
- deploymentPolicies_componentUpdatePolicy :: Lens' DeploymentPolicies (Maybe DeploymentComponentUpdatePolicy)
- deploymentPolicies_configurationValidationPolicy :: Lens' DeploymentPolicies (Maybe DeploymentConfigurationValidationPolicy)
- deploymentPolicies_failureHandlingPolicy :: Lens' DeploymentPolicies (Maybe DeploymentFailureHandlingPolicy)
- disassociateClientDeviceFromCoreDeviceEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceEntry Text
- disassociateClientDeviceFromCoreDeviceErrorEntry_code :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- disassociateClientDeviceFromCoreDeviceErrorEntry_message :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- disassociateClientDeviceFromCoreDeviceErrorEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text)
- effectiveDeployment_description :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_iotJobArn :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_iotJobId :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_reason :: Lens' EffectiveDeployment (Maybe Text)
- effectiveDeployment_statusDetails :: Lens' EffectiveDeployment (Maybe EffectiveDeploymentStatusDetails)
- effectiveDeployment_deploymentId :: Lens' EffectiveDeployment Text
- effectiveDeployment_deploymentName :: Lens' EffectiveDeployment Text
- effectiveDeployment_targetArn :: Lens' EffectiveDeployment Text
- effectiveDeployment_coreDeviceExecutionStatus :: Lens' EffectiveDeployment EffectiveDeploymentExecutionStatus
- effectiveDeployment_creationTimestamp :: Lens' EffectiveDeployment UTCTime
- effectiveDeployment_modifiedTimestamp :: Lens' EffectiveDeployment UTCTime
- effectiveDeploymentStatusDetails_errorStack :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text])
- effectiveDeploymentStatusDetails_errorTypes :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text])
- installedComponent_componentName :: Lens' InstalledComponent (Maybe Text)
- installedComponent_componentVersion :: Lens' InstalledComponent (Maybe Text)
- installedComponent_isRoot :: Lens' InstalledComponent (Maybe Bool)
- installedComponent_lastInstallationSource :: Lens' InstalledComponent (Maybe Text)
- installedComponent_lastReportedTimestamp :: Lens' InstalledComponent (Maybe UTCTime)
- installedComponent_lastStatusChangeTimestamp :: Lens' InstalledComponent (Maybe UTCTime)
- installedComponent_lifecycleState :: Lens' InstalledComponent (Maybe InstalledComponentLifecycleState)
- installedComponent_lifecycleStateDetails :: Lens' InstalledComponent (Maybe Text)
- installedComponent_lifecycleStatusCodes :: Lens' InstalledComponent (Maybe [Text])
- ioTJobAbortConfig_criteriaList :: Lens' IoTJobAbortConfig (NonEmpty IoTJobAbortCriteria)
- ioTJobAbortCriteria_failureType :: Lens' IoTJobAbortCriteria IoTJobExecutionFailureType
- ioTJobAbortCriteria_action :: Lens' IoTJobAbortCriteria IoTJobAbortAction
- ioTJobAbortCriteria_thresholdPercentage :: Lens' IoTJobAbortCriteria Double
- ioTJobAbortCriteria_minNumberOfExecutedThings :: Lens' IoTJobAbortCriteria Natural
- ioTJobExecutionsRolloutConfig_exponentialRate :: Lens' IoTJobExecutionsRolloutConfig (Maybe IoTJobExponentialRolloutRate)
- ioTJobExecutionsRolloutConfig_maximumPerMinute :: Lens' IoTJobExecutionsRolloutConfig (Maybe Natural)
- ioTJobExponentialRolloutRate_baseRatePerMinute :: Lens' IoTJobExponentialRolloutRate Natural
- ioTJobExponentialRolloutRate_incrementFactor :: Lens' IoTJobExponentialRolloutRate Double
- ioTJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' IoTJobExponentialRolloutRate IoTJobRateIncreaseCriteria
- ioTJobRateIncreaseCriteria_numberOfNotifiedThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural)
- ioTJobRateIncreaseCriteria_numberOfSucceededThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural)
- ioTJobTimeoutConfig_inProgressTimeoutInMinutes :: Lens' IoTJobTimeoutConfig (Maybe Integer)
- lambdaContainerParams_devices :: Lens' LambdaContainerParams (Maybe [LambdaDeviceMount])
- lambdaContainerParams_memorySizeInKB :: Lens' LambdaContainerParams (Maybe Int)
- lambdaContainerParams_mountROSysfs :: Lens' LambdaContainerParams (Maybe Bool)
- lambdaContainerParams_volumes :: Lens' LambdaContainerParams (Maybe [LambdaVolumeMount])
- lambdaDeviceMount_addGroupOwner :: Lens' LambdaDeviceMount (Maybe Bool)
- lambdaDeviceMount_permission :: Lens' LambdaDeviceMount (Maybe LambdaFilesystemPermission)
- lambdaDeviceMount_path :: Lens' LambdaDeviceMount Text
- lambdaEventSource_topic :: Lens' LambdaEventSource Text
- lambdaEventSource_type :: Lens' LambdaEventSource LambdaEventSourceType
- lambdaExecutionParameters_environmentVariables :: Lens' LambdaExecutionParameters (Maybe (HashMap Text Text))
- lambdaExecutionParameters_eventSources :: Lens' LambdaExecutionParameters (Maybe [LambdaEventSource])
- lambdaExecutionParameters_execArgs :: Lens' LambdaExecutionParameters (Maybe [Text])
- lambdaExecutionParameters_inputPayloadEncodingType :: Lens' LambdaExecutionParameters (Maybe LambdaInputPayloadEncodingType)
- lambdaExecutionParameters_linuxProcessParams :: Lens' LambdaExecutionParameters (Maybe LambdaLinuxProcessParams)
- lambdaExecutionParameters_maxIdleTimeInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_maxInstancesCount :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_maxQueueSize :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_pinned :: Lens' LambdaExecutionParameters (Maybe Bool)
- lambdaExecutionParameters_statusTimeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaExecutionParameters_timeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int)
- lambdaFunctionRecipeSource_componentDependencies :: Lens' LambdaFunctionRecipeSource (Maybe (HashMap Text ComponentDependencyRequirement))
- lambdaFunctionRecipeSource_componentLambdaParameters :: Lens' LambdaFunctionRecipeSource (Maybe LambdaExecutionParameters)
- lambdaFunctionRecipeSource_componentName :: Lens' LambdaFunctionRecipeSource (Maybe Text)
- lambdaFunctionRecipeSource_componentPlatforms :: Lens' LambdaFunctionRecipeSource (Maybe [ComponentPlatform])
- lambdaFunctionRecipeSource_componentVersion :: Lens' LambdaFunctionRecipeSource (Maybe Text)
- lambdaFunctionRecipeSource_lambdaArn :: Lens' LambdaFunctionRecipeSource Text
- lambdaLinuxProcessParams_containerParams :: Lens' LambdaLinuxProcessParams (Maybe LambdaContainerParams)
- lambdaLinuxProcessParams_isolationMode :: Lens' LambdaLinuxProcessParams (Maybe LambdaIsolationMode)
- lambdaVolumeMount_addGroupOwner :: Lens' LambdaVolumeMount (Maybe Bool)
- lambdaVolumeMount_permission :: Lens' LambdaVolumeMount (Maybe LambdaFilesystemPermission)
- lambdaVolumeMount_sourcePath :: Lens' LambdaVolumeMount Text
- lambdaVolumeMount_destinationPath :: Lens' LambdaVolumeMount Text
- resolvedComponentVersion_arn :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_componentName :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_componentVersion :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_message :: Lens' ResolvedComponentVersion (Maybe Text)
- resolvedComponentVersion_recipe :: Lens' ResolvedComponentVersion (Maybe ByteString)
- resolvedComponentVersion_vendorGuidance :: Lens' ResolvedComponentVersion (Maybe VendorGuidance)
- systemResourceLimits_cpus :: Lens' SystemResourceLimits (Maybe Double)
- systemResourceLimits_memory :: Lens' SystemResourceLimits (Maybe Natural)
Operations
AssociateServiceRoleToAccount
associateServiceRoleToAccount_roleArn :: Lens' AssociateServiceRoleToAccount Text Source #
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.
associateServiceRoleToAccountResponse_associatedAt :: Lens' AssociateServiceRoleToAccountResponse (Maybe Text) Source #
The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
associateServiceRoleToAccountResponse_httpStatus :: Lens' AssociateServiceRoleToAccountResponse Int Source #
The response's http status code.
BatchAssociateClientDeviceWithCoreDevice
batchAssociateClientDeviceWithCoreDevice_entries :: Lens' BatchAssociateClientDeviceWithCoreDevice (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry)) Source #
The list of client devices to associate.
batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName :: Lens' BatchAssociateClientDeviceWithCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse (Maybe [AssociateClientDeviceWithCoreDeviceErrorEntry]) Source #
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.
batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse Int Source #
The response's http status code.
BatchDisassociateClientDeviceFromCoreDevice
batchDisassociateClientDeviceFromCoreDevice_entries :: Lens' BatchDisassociateClientDeviceFromCoreDevice (Maybe (NonEmpty DisassociateClientDeviceFromCoreDeviceEntry)) Source #
The list of client devices to disassociate.
batchDisassociateClientDeviceFromCoreDevice_coreDeviceThingName :: Lens' BatchDisassociateClientDeviceFromCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
batchDisassociateClientDeviceFromCoreDeviceResponse_errorEntries :: Lens' BatchDisassociateClientDeviceFromCoreDeviceResponse (Maybe [DisassociateClientDeviceFromCoreDeviceErrorEntry]) Source #
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.
batchDisassociateClientDeviceFromCoreDeviceResponse_httpStatus :: Lens' BatchDisassociateClientDeviceFromCoreDeviceResponse Int Source #
The response's http status code.
CancelDeployment
cancelDeployment_deploymentId :: Lens' CancelDeployment Text Source #
The ID of the deployment.
cancelDeploymentResponse_message :: Lens' CancelDeploymentResponse (Maybe Text) Source #
A message that communicates if the cancel was successful.
cancelDeploymentResponse_httpStatus :: Lens' CancelDeploymentResponse Int Source #
The response's http status code.
CreateComponentVersion
createComponentVersion_clientToken :: Lens' CreateComponentVersion (Maybe Text) Source #
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.
createComponentVersion_inlineRecipe :: Lens' CreateComponentVersion (Maybe ByteString) Source #
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.
createComponentVersion_lambdaFunction :: Lens' CreateComponentVersion (Maybe LambdaFunctionRecipeSource) Source #
The parameters to create a component from a Lambda function.
You must specify either inlineRecipe
or lambdaFunction
.
createComponentVersion_tags :: Lens' CreateComponentVersion (Maybe (HashMap Text Text)) Source #
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.
createComponentVersionResponse_arn :: Lens' CreateComponentVersionResponse (Maybe Text) Source #
The ARN of the component version.
createComponentVersionResponse_httpStatus :: Lens' CreateComponentVersionResponse Int Source #
The response's http status code.
createComponentVersionResponse_componentName :: Lens' CreateComponentVersionResponse Text Source #
The name of the component.
createComponentVersionResponse_componentVersion :: Lens' CreateComponentVersionResponse Text Source #
The version of the component.
createComponentVersionResponse_creationTimestamp :: Lens' CreateComponentVersionResponse UTCTime Source #
The time at which the component was created, expressed in ISO 8601 format.
createComponentVersionResponse_status :: Lens' CreateComponentVersionResponse CloudComponentStatus Source #
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
createDeployment_clientToken :: Lens' CreateDeployment (Maybe Text) Source #
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.
createDeployment_components :: Lens' CreateDeployment (Maybe (HashMap Text ComponentDeploymentSpecification)) Source #
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_deploymentName :: Lens' CreateDeployment (Maybe Text) Source #
The name of the deployment.
createDeployment_deploymentPolicies :: Lens' CreateDeployment (Maybe DeploymentPolicies) Source #
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
createDeployment_iotJobConfiguration :: Lens' CreateDeployment (Maybe DeploymentIoTJobConfiguration) Source #
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
createDeployment_parentTargetArn :: Lens' CreateDeployment (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
createDeployment_tags :: Lens' CreateDeployment (Maybe (HashMap Text Text)) Source #
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_targetArn :: Lens' CreateDeployment Text Source #
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ID of the deployment.
createDeploymentResponse_iotJobArn :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ARN of the IoT job that applies the deployment to target devices.
createDeploymentResponse_iotJobId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ID of the IoT job that applies the deployment to target devices.
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #
The response's http status code.
DeleteComponent
deleteComponent_arn :: Lens' DeleteComponent Text Source #
The ARN of the component version.
DeleteCoreDevice
deleteCoreDevice_coreDeviceThingName :: Lens' DeleteCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
DeleteDeployment
deleteDeployment_deploymentId :: Lens' DeleteDeployment Text Source #
The ID of the deployment.
DescribeComponent
describeComponent_arn :: Lens' DescribeComponent Text Source #
The ARN of the component version.
describeComponentResponse_arn :: Lens' DescribeComponentResponse (Maybe Text) Source #
The ARN of the component version.
describeComponentResponse_componentName :: Lens' DescribeComponentResponse (Maybe Text) Source #
The name of the component.
describeComponentResponse_componentVersion :: Lens' DescribeComponentResponse (Maybe Text) Source #
The version of the component.
describeComponentResponse_creationTimestamp :: Lens' DescribeComponentResponse (Maybe UTCTime) Source #
The time at which the component was created, expressed in ISO 8601 format.
describeComponentResponse_description :: Lens' DescribeComponentResponse (Maybe Text) Source #
The description of the component version.
describeComponentResponse_platforms :: Lens' DescribeComponentResponse (Maybe [ComponentPlatform]) Source #
The platforms that the component version supports.
describeComponentResponse_publisher :: Lens' DescribeComponentResponse (Maybe Text) Source #
The publisher of the component version.
describeComponentResponse_status :: Lens' DescribeComponentResponse (Maybe CloudComponentStatus) Source #
The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
describeComponentResponse_tags :: Lens' DescribeComponentResponse (Maybe (HashMap Text Text)) Source #
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.
describeComponentResponse_httpStatus :: Lens' DescribeComponentResponse Int Source #
The response's http status code.
DisassociateServiceRoleFromAccount
disassociateServiceRoleFromAccountResponse_disassociatedAt :: Lens' DisassociateServiceRoleFromAccountResponse (Maybe Text) Source #
The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
disassociateServiceRoleFromAccountResponse_httpStatus :: Lens' DisassociateServiceRoleFromAccountResponse Int Source #
The response's http status code.
GetComponent
getComponent_recipeOutputFormat :: Lens' GetComponent (Maybe RecipeOutputFormat) Source #
The format of the recipe.
getComponent_arn :: Lens' GetComponent Text Source #
The ARN of the component version.
getComponentResponse_tags :: Lens' GetComponentResponse (Maybe (HashMap Text Text)) Source #
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.
getComponentResponse_httpStatus :: Lens' GetComponentResponse Int Source #
The response's http status code.
getComponentResponse_recipeOutputFormat :: Lens' GetComponentResponse RecipeOutputFormat Source #
The format of the recipe.
getComponentResponse_recipe :: Lens' GetComponentResponse ByteString Source #
The recipe of the component version.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
GetComponentVersionArtifact
getComponentVersionArtifact_arn :: Lens' GetComponentVersionArtifact Text Source #
The ARN of the component version. Specify the ARN of a public or a Lambda component version.
getComponentVersionArtifact_artifactName :: Lens' GetComponentVersionArtifact Text Source #
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
.
getComponentVersionArtifactResponse_httpStatus :: Lens' GetComponentVersionArtifactResponse Int Source #
The response's http status code.
getComponentVersionArtifactResponse_preSignedUrl :: Lens' GetComponentVersionArtifactResponse Text Source #
The URL of the artifact.
GetConnectivityInfo
getConnectivityInfo_thingName :: Lens' GetConnectivityInfo Text Source #
The name of the core device. This is also the name of the IoT thing.
getConnectivityInfoResponse_connectivityInfo :: Lens' GetConnectivityInfoResponse (Maybe [ConnectivityInfo]) Source #
The connectivity information for the core device.
getConnectivityInfoResponse_message :: Lens' GetConnectivityInfoResponse (Maybe Text) Source #
A message about the connectivity information request.
getConnectivityInfoResponse_httpStatus :: Lens' GetConnectivityInfoResponse Int Source #
The response's http status code.
GetCoreDevice
getCoreDevice_coreDeviceThingName :: Lens' GetCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
getCoreDeviceResponse_architecture :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The computer architecture of the core device.
getCoreDeviceResponse_coreDeviceThingName :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The name of the core device. This is also the name of the IoT thing.
getCoreDeviceResponse_coreVersion :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
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_lastStatusUpdateTimestamp :: Lens' GetCoreDeviceResponse (Maybe UTCTime) Source #
The time at which the core device's status last updated, expressed in ISO 8601 format.
getCoreDeviceResponse_platform :: Lens' GetCoreDeviceResponse (Maybe Text) Source #
The operating system platform that the core device runs.
getCoreDeviceResponse_status :: Lens' GetCoreDeviceResponse (Maybe CoreDeviceStatus) Source #
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.
getCoreDeviceResponse_tags :: Lens' GetCoreDeviceResponse (Maybe (HashMap Text Text)) Source #
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.
getCoreDeviceResponse_httpStatus :: Lens' GetCoreDeviceResponse Int Source #
The response's http status code.
GetDeployment
getDeployment_deploymentId :: Lens' GetDeployment Text Source #
The ID of the deployment.
getDeploymentResponse_components :: Lens' GetDeploymentResponse (Maybe (HashMap Text ComponentDeploymentSpecification)) Source #
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_creationTimestamp :: Lens' GetDeploymentResponse (Maybe UTCTime) Source #
The time at which the deployment was created, expressed in ISO 8601 format.
getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text) Source #
The ID of the deployment.
getDeploymentResponse_deploymentName :: Lens' GetDeploymentResponse (Maybe Text) Source #
The name of the deployment.
getDeploymentResponse_deploymentPolicies :: Lens' GetDeploymentResponse (Maybe DeploymentPolicies) Source #
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus) Source #
The status of the deployment.
getDeploymentResponse_iotJobArn :: Lens' GetDeploymentResponse (Maybe Text) Source #
The ARN of the IoT job that applies the deployment to target devices.
getDeploymentResponse_iotJobConfiguration :: Lens' GetDeploymentResponse (Maybe DeploymentIoTJobConfiguration) Source #
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
getDeploymentResponse_iotJobId :: Lens' GetDeploymentResponse (Maybe Text) Source #
The ID of the IoT job that applies the deployment to target devices.
getDeploymentResponse_isLatestForTarget :: Lens' GetDeploymentResponse (Maybe Bool) Source #
Whether or not the deployment is the latest revision for its target.
getDeploymentResponse_parentTargetArn :: Lens' GetDeploymentResponse (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
getDeploymentResponse_revisionId :: Lens' GetDeploymentResponse (Maybe Text) Source #
The revision number of the deployment.
getDeploymentResponse_tags :: Lens' GetDeploymentResponse (Maybe (HashMap Text Text)) Source #
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_targetArn :: Lens' GetDeploymentResponse (Maybe Text) Source #
The ARN of the target IoT thing or thing group.
getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int Source #
The response's http status code.
GetServiceRoleForAccount
getServiceRoleForAccountResponse_associatedAt :: Lens' GetServiceRoleForAccountResponse (Maybe Text) Source #
The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
getServiceRoleForAccountResponse_roleArn :: Lens' GetServiceRoleForAccountResponse (Maybe Text) Source #
The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
getServiceRoleForAccountResponse_httpStatus :: Lens' GetServiceRoleForAccountResponse Int Source #
The response's http status code.
ListClientDevicesAssociatedWithCoreDevice
listClientDevicesAssociatedWithCoreDevice_maxResults :: Lens' ListClientDevicesAssociatedWithCoreDevice (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listClientDevicesAssociatedWithCoreDevice_nextToken :: Lens' ListClientDevicesAssociatedWithCoreDevice (Maybe Text) Source #
The token to be used for the next set of paginated results.
listClientDevicesAssociatedWithCoreDevice_coreDeviceThingName :: Lens' ListClientDevicesAssociatedWithCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
listClientDevicesAssociatedWithCoreDeviceResponse_associatedClientDevices :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse (Maybe (NonEmpty AssociatedClientDevice)) Source #
A list that describes the client devices that are associated with the core device.
listClientDevicesAssociatedWithCoreDeviceResponse_nextToken :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listClientDevicesAssociatedWithCoreDeviceResponse_httpStatus :: Lens' ListClientDevicesAssociatedWithCoreDeviceResponse Int Source #
The response's http status code.
ListComponentVersions
listComponentVersions_maxResults :: Lens' ListComponentVersions (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listComponentVersions_nextToken :: Lens' ListComponentVersions (Maybe Text) Source #
The token to be used for the next set of paginated results.
listComponentVersions_arn :: Lens' ListComponentVersions Text Source #
The ARN of the component.
listComponentVersionsResponse_componentVersions :: Lens' ListComponentVersionsResponse (Maybe [ComponentVersionListItem]) Source #
A list of versions that exist for the component.
listComponentVersionsResponse_nextToken :: Lens' ListComponentVersionsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listComponentVersionsResponse_httpStatus :: Lens' ListComponentVersionsResponse Int Source #
The response's http status code.
ListComponents
listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #
The token to be used for the next set of paginated results.
listComponents_scope :: Lens' ListComponents (Maybe ComponentVisibilityScope) Source #
The scope of the components to list.
Default: PRIVATE
listComponentsResponse_components :: Lens' ListComponentsResponse (Maybe [Component]) Source #
A list that summarizes each component.
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #
The response's http status code.
ListCoreDevices
listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text) Source #
The token to be used for the next set of paginated results.
listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus) Source #
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.
listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text) Source #
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.
listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice]) Source #
A list that summarizes each core device.
listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int Source #
The response's http status code.
ListDeployments
listDeployments_historyFilter :: Lens' ListDeployments (Maybe DeploymentHistoryFilter) Source #
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
listDeployments_maxResults :: Lens' ListDeployments (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #
The token to be used for the next set of paginated results.
listDeployments_parentTargetArn :: Lens' ListDeployments (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
listDeployments_targetArn :: Lens' ListDeployments (Maybe Text) Source #
The ARN of the target IoT thing or thing group.
listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Deployment]) Source #
A list that summarizes each deployment.
listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int Source #
The response's http status code.
ListEffectiveDeployments
listEffectiveDeployments_maxResults :: Lens' ListEffectiveDeployments (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listEffectiveDeployments_nextToken :: Lens' ListEffectiveDeployments (Maybe Text) Source #
The token to be used for the next set of paginated results.
listEffectiveDeployments_coreDeviceThingName :: Lens' ListEffectiveDeployments Text Source #
The name of the core device. This is also the name of the IoT thing.
listEffectiveDeploymentsResponse_effectiveDeployments :: Lens' ListEffectiveDeploymentsResponse (Maybe [EffectiveDeployment]) Source #
A list that summarizes each deployment on the core device.
listEffectiveDeploymentsResponse_nextToken :: Lens' ListEffectiveDeploymentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listEffectiveDeploymentsResponse_httpStatus :: Lens' ListEffectiveDeploymentsResponse Int Source #
The response's http status code.
ListInstalledComponents
listInstalledComponents_maxResults :: Lens' ListInstalledComponents (Maybe Natural) Source #
The maximum number of results to be returned per paginated request.
listInstalledComponents_nextToken :: Lens' ListInstalledComponents (Maybe Text) Source #
The token to be used for the next set of paginated results.
listInstalledComponents_topologyFilter :: Lens' ListInstalledComponents (Maybe InstalledComponentTopologyFilter) Source #
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_coreDeviceThingName :: Lens' ListInstalledComponents Text Source #
The name of the core device. This is also the name of the IoT thing.
listInstalledComponentsResponse_installedComponents :: Lens' ListInstalledComponentsResponse (Maybe [InstalledComponent]) Source #
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.
listInstalledComponentsResponse_nextToken :: Lens' ListInstalledComponentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listInstalledComponentsResponse_httpStatus :: Lens' ListInstalledComponentsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
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.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ResolveComponentCandidates
resolveComponentCandidates_componentCandidates :: Lens' ResolveComponentCandidates (Maybe [ComponentCandidate]) Source #
The list of components to resolve.
resolveComponentCandidates_platform :: Lens' ResolveComponentCandidates (Maybe ComponentPlatform) Source #
The platform to use to resolve compatible components.
resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens' ResolveComponentCandidatesResponse (Maybe [ResolvedComponentVersion]) Source #
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.
resolveComponentCandidatesResponse_httpStatus :: Lens' ResolveComponentCandidatesResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the resource to tag.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the resource to untag.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
A list of keys for tags to remove from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateConnectivityInfo
updateConnectivityInfo_thingName :: Lens' UpdateConnectivityInfo Text Source #
The name of the core device. This is also the name of the IoT thing.
updateConnectivityInfo_connectivityInfo :: Lens' UpdateConnectivityInfo [ConnectivityInfo] Source #
The connectivity information for the core device.
updateConnectivityInfoResponse_message :: Lens' UpdateConnectivityInfoResponse (Maybe Text) Source #
A message about the connectivity information update request.
updateConnectivityInfoResponse_version :: Lens' UpdateConnectivityInfoResponse (Maybe Text) Source #
The new version of the connectivity information for the core device.
updateConnectivityInfoResponse_httpStatus :: Lens' UpdateConnectivityInfoResponse Int Source #
The response's http status code.
Types
AssociateClientDeviceWithCoreDeviceEntry
associateClientDeviceWithCoreDeviceEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceEntry Text Source #
The name of the IoT thing that represents the client device to associate.
AssociateClientDeviceWithCoreDeviceErrorEntry
associateClientDeviceWithCoreDeviceErrorEntry_code :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
The error code for the request.
associateClientDeviceWithCoreDeviceErrorEntry_message :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
A message that provides additional information about the error.
associateClientDeviceWithCoreDeviceErrorEntry_thingName :: Lens' AssociateClientDeviceWithCoreDeviceErrorEntry (Maybe Text) Source #
The name of the IoT thing whose associate request failed.
AssociatedClientDevice
associatedClientDevice_associationTimestamp :: Lens' AssociatedClientDevice (Maybe UTCTime) Source #
The time that the client device was associated, expressed in ISO 8601 format.
associatedClientDevice_thingName :: Lens' AssociatedClientDevice (Maybe Text) Source #
The name of the IoT thing that represents the associated client device.
CloudComponentStatus
cloudComponentStatus_componentState :: Lens' CloudComponentStatus (Maybe CloudComponentState) Source #
The state of the component version.
cloudComponentStatus_errors :: Lens' CloudComponentStatus (Maybe (HashMap Text Text)) Source #
A dictionary of errors that communicate why the component version is in
an error state. For example, if IoT Greengrass can't access an artifact
for the component version, then errors
contains the artifact's URI as
a key, and the error message as the value for that key.
cloudComponentStatus_message :: Lens' CloudComponentStatus (Maybe Text) Source #
A message that communicates details, such as errors, about the status of the component version.
cloudComponentStatus_vendorGuidance :: Lens' CloudComponentStatus (Maybe VendorGuidance) Source #
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE
– This component version is available and recommended for use.DISCONTINUED
– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED
– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
cloudComponentStatus_vendorGuidanceMessage :: Lens' CloudComponentStatus (Maybe Text) Source #
A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.
Component
component_latestVersion :: Lens' Component (Maybe ComponentLatestVersion) Source #
The latest version of the component and its details.
ComponentCandidate
componentCandidate_componentName :: Lens' ComponentCandidate (Maybe Text) Source #
The name of the component.
componentCandidate_componentVersion :: Lens' ComponentCandidate (Maybe Text) Source #
The version of the component.
componentCandidate_versionRequirements :: Lens' ComponentCandidate (Maybe (HashMap Text Text)) Source #
The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
ComponentConfigurationUpdate
componentConfigurationUpdate_merge :: Lens' ComponentConfigurationUpdate (Maybe Text) Source #
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the IoT Greengrass V2 Developer Guide.
componentConfigurationUpdate_reset :: Lens' ComponentConfigurationUpdate (Maybe [Text]) Source #
The list of configuration nodes to reset to default values on target
devices. Use JSON pointers to specify each node to reset. JSON pointers
start with a forward slash (/
) and use forward slashes to separate
the key for each level in the object. For more information, see the
JSON pointer specification and
Reset configuration updates
in the IoT Greengrass V2 Developer Guide.
ComponentDependencyRequirement
componentDependencyRequirement_dependencyType :: Lens' ComponentDependencyRequirement (Maybe ComponentDependencyType) Source #
The type of this dependency. Choose from the following options:
SOFT
– The component doesn't restart if the dependency changes state.HARD
– The component restarts if the dependency changes state.
Default: HARD
componentDependencyRequirement_versionRequirement :: Lens' ComponentDependencyRequirement (Maybe Text) Source #
The component version requirement for the component dependency.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
ComponentDeploymentSpecification
componentDeploymentSpecification_componentVersion :: Lens' ComponentDeploymentSpecification (Maybe Text) Source #
The version of the component.
componentDeploymentSpecification_configurationUpdate :: Lens' ComponentDeploymentSpecification (Maybe ComponentConfigurationUpdate) Source #
The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.
componentDeploymentSpecification_runWith :: Lens' ComponentDeploymentSpecification (Maybe ComponentRunWith) Source #
The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.
ComponentLatestVersion
componentLatestVersion_arn :: Lens' ComponentLatestVersion (Maybe Text) Source #
The ARN of the component version.
componentLatestVersion_componentVersion :: Lens' ComponentLatestVersion (Maybe Text) Source #
The version of the component.
componentLatestVersion_creationTimestamp :: Lens' ComponentLatestVersion (Maybe UTCTime) Source #
The time at which the component was created, expressed in ISO 8601 format.
componentLatestVersion_description :: Lens' ComponentLatestVersion (Maybe Text) Source #
The description of the component version.
componentLatestVersion_platforms :: Lens' ComponentLatestVersion (Maybe [ComponentPlatform]) Source #
The platforms that the component version supports.
componentLatestVersion_publisher :: Lens' ComponentLatestVersion (Maybe Text) Source #
The publisher of the component version.
ComponentPlatform
componentPlatform_attributes :: Lens' ComponentPlatform (Maybe (HashMap Text Text)) Source #
A dictionary of attributes for the platform. The IoT Greengrass Core
software defines the os
and architecture
by default. You can specify
additional platform attributes for a core device when you deploy the
Greengrass nucleus component. For more information, see the
Greengrass nucleus component
in the IoT Greengrass V2 Developer Guide.
componentPlatform_name :: Lens' ComponentPlatform (Maybe Text) Source #
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, IoT Greengrass creates a friendly name from
the os
and architecture
of the platform.
ComponentRunWith
componentRunWith_posixUser :: Lens' ComponentRunWith (Maybe Text) Source #
The POSIX system user and, optionally, group to use to run this
component on Linux core devices. The user, and group if specified, must
exist on each Linux core device. Specify the user and group separated by
a colon (:
) in the following format: user:group
. The group is
optional. If you don't specify a group, the IoT Greengrass Core
software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
componentRunWith_systemResourceLimits :: Lens' ComponentRunWith (Maybe SystemResourceLimits) Source #
The system resource limits to apply to this component's process on the core device. IoT Greengrass currently supports this feature on only Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
componentRunWith_windowsUser :: Lens' ComponentRunWith (Maybe Text) Source #
The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
ComponentVersionListItem
componentVersionListItem_arn :: Lens' ComponentVersionListItem (Maybe Text) Source #
The ARN of the component version.
componentVersionListItem_componentName :: Lens' ComponentVersionListItem (Maybe Text) Source #
The name of the component.
componentVersionListItem_componentVersion :: Lens' ComponentVersionListItem (Maybe Text) Source #
The version of the component.
ConnectivityInfo
connectivityInfo_hostAddress :: Lens' ConnectivityInfo (Maybe Text) Source #
The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device.
connectivityInfo_id :: Lens' ConnectivityInfo (Maybe Text) Source #
An ID for the connectivity information.
connectivityInfo_metadata :: Lens' ConnectivityInfo (Maybe Text) Source #
Additional metadata to provide to client devices that connect to this core device.
connectivityInfo_portNumber :: Lens' ConnectivityInfo (Maybe Natural) Source #
The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.
CoreDevice
coreDevice_coreDeviceThingName :: Lens' CoreDevice (Maybe Text) Source #
The name of the core device. This is also the name of the IoT thing.
coreDevice_lastStatusUpdateTimestamp :: Lens' CoreDevice (Maybe UTCTime) Source #
The time at which the core device's status last updated, expressed in ISO 8601 format.
coreDevice_status :: Lens' CoreDevice (Maybe CoreDeviceStatus) Source #
The status of the core device. Core devices can have the following statuses:
HEALTHY
– The IoT Greengrass Core software and all components run on the core device without issue.UNHEALTHY
– The IoT Greengrass Core software or a component is in a failed state on the core device.
Deployment
deployment_creationTimestamp :: Lens' Deployment (Maybe UTCTime) Source #
The time at which the deployment was created, expressed in ISO 8601 format.
deployment_deploymentId :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment.
deployment_deploymentName :: Lens' Deployment (Maybe Text) Source #
The name of the deployment.
deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus) Source #
The status of the deployment.
deployment_isLatestForTarget :: Lens' Deployment (Maybe Bool) Source #
Whether or not the deployment is the latest revision for its target.
deployment_parentTargetArn :: Lens' Deployment (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
deployment_revisionId :: Lens' Deployment (Maybe Text) Source #
The revision number of the deployment.
deployment_targetArn :: Lens' Deployment (Maybe Text) Source #
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
DeploymentComponentUpdatePolicy
deploymentComponentUpdatePolicy_action :: Lens' DeploymentComponentUpdatePolicy (Maybe DeploymentComponentUpdatePolicyAction) Source #
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS
– The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.SKIP_NOTIFY_COMPONENTS
– The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
deploymentComponentUpdatePolicy_timeoutInSeconds :: Lens' DeploymentComponentUpdatePolicy (Maybe Int) Source #
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
DeploymentConfigurationValidationPolicy
deploymentConfigurationValidationPolicy_timeoutInSeconds :: Lens' DeploymentConfigurationValidationPolicy (Maybe Int) Source #
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
DeploymentIoTJobConfiguration
deploymentIoTJobConfiguration_abortConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobAbortConfig) Source #
The stop configuration for the job. This configuration defines when and how to stop a job rollout.
deploymentIoTJobConfiguration_jobExecutionsRolloutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobExecutionsRolloutConfig) Source #
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
deploymentIoTJobConfiguration_timeoutConfig :: Lens' DeploymentIoTJobConfiguration (Maybe IoTJobTimeoutConfig) Source #
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
DeploymentPolicies
deploymentPolicies_componentUpdatePolicy :: Lens' DeploymentPolicies (Maybe DeploymentComponentUpdatePolicy) Source #
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.
deploymentPolicies_configurationValidationPolicy :: Lens' DeploymentPolicies (Maybe DeploymentConfigurationValidationPolicy) Source #
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
deploymentPolicies_failureHandlingPolicy :: Lens' DeploymentPolicies (Maybe DeploymentFailureHandlingPolicy) Source #
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
DisassociateClientDeviceFromCoreDeviceEntry
disassociateClientDeviceFromCoreDeviceEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceEntry Text Source #
The name of the IoT thing that represents the client device to disassociate.
DisassociateClientDeviceFromCoreDeviceErrorEntry
disassociateClientDeviceFromCoreDeviceErrorEntry_code :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
The error code for the request.
disassociateClientDeviceFromCoreDeviceErrorEntry_message :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
A message that provides additional information about the error.
disassociateClientDeviceFromCoreDeviceErrorEntry_thingName :: Lens' DisassociateClientDeviceFromCoreDeviceErrorEntry (Maybe Text) Source #
The name of the IoT thing whose disassociate request failed.
EffectiveDeployment
effectiveDeployment_description :: Lens' EffectiveDeployment (Maybe Text) Source #
The description of the deployment job.
effectiveDeployment_iotJobArn :: Lens' EffectiveDeployment (Maybe Text) Source #
The ARN of the IoT job that applies the deployment to target devices.
effectiveDeployment_iotJobId :: Lens' EffectiveDeployment (Maybe Text) Source #
The ID of the IoT job that applies the deployment to target devices.
effectiveDeployment_reason :: Lens' EffectiveDeployment (Maybe Text) Source #
The reason code for the update, if the job was updated.
effectiveDeployment_statusDetails :: Lens' EffectiveDeployment (Maybe EffectiveDeploymentStatusDetails) Source #
The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
effectiveDeployment_deploymentId :: Lens' EffectiveDeployment Text Source #
The ID of the deployment.
effectiveDeployment_deploymentName :: Lens' EffectiveDeployment Text Source #
The name of the deployment.
effectiveDeployment_targetArn :: Lens' EffectiveDeployment Text Source #
The ARN of the target IoT thing or thing group.
effectiveDeployment_coreDeviceExecutionStatus :: Lens' EffectiveDeployment EffectiveDeploymentExecutionStatus Source #
The status of the deployment job on the Greengrass core device.
effectiveDeployment_creationTimestamp :: Lens' EffectiveDeployment UTCTime Source #
The time at which the deployment was created, expressed in ISO 8601 format.
effectiveDeployment_modifiedTimestamp :: Lens' EffectiveDeployment UTCTime Source #
The time at which the deployment job was last modified, expressed in ISO 8601 format.
EffectiveDeploymentStatusDetails
effectiveDeploymentStatusDetails_errorStack :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text]) Source #
Contains an ordered list of short error codes that range from the most
generic error to the most specific one. The error codes describe the
reason for failure whenever the coreDeviceExecutionStatus
is in a
failed state. The response will be an empty list if there is no error.
effectiveDeploymentStatusDetails_errorTypes :: Lens' EffectiveDeploymentStatusDetails (Maybe [Text]) Source #
Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.
InstalledComponent
installedComponent_componentName :: Lens' InstalledComponent (Maybe Text) Source #
The name of the component.
installedComponent_componentVersion :: Lens' InstalledComponent (Maybe Text) Source #
The version of the component.
installedComponent_isRoot :: Lens' InstalledComponent (Maybe Bool) Source #
Whether or not the component is a root component.
installedComponent_lastInstallationSource :: Lens' InstalledComponent (Maybe Text) Source #
The most recent deployment source that brought the component to the
Greengrass core device. For a thing group deployment or thing
deployment, the source will be the The ID of the deployment. and for
local deployments it will be LOCAL
.
installedComponent_lastReportedTimestamp :: Lens' InstalledComponent (Maybe UTCTime) Source #
The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
installedComponent_lastStatusChangeTimestamp :: Lens' InstalledComponent (Maybe UTCTime) Source #
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
installedComponent_lifecycleState :: Lens' InstalledComponent (Maybe InstalledComponentLifecycleState) Source #
The lifecycle state of the component.
installedComponent_lifecycleStateDetails :: Lens' InstalledComponent (Maybe Text) Source #
A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
installedComponent_lifecycleStatusCodes :: Lens' InstalledComponent (Maybe [Text]) Source #
The status codes that indicate the reason for failure whenever the
lifecycleState
has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate
lifecycleStatusCodes
response. This response can be inaccurate in
earlier Greengrass nucleus versions.
IoTJobAbortConfig
ioTJobAbortConfig_criteriaList :: Lens' IoTJobAbortConfig (NonEmpty IoTJobAbortCriteria) Source #
The list of criteria that define when and how to cancel the configuration deployment.
IoTJobAbortCriteria
ioTJobAbortCriteria_failureType :: Lens' IoTJobAbortCriteria IoTJobExecutionFailureType Source #
The type of job deployment failure that can cancel a job.
ioTJobAbortCriteria_action :: Lens' IoTJobAbortCriteria IoTJobAbortAction Source #
The action to perform when the criteria are met.
ioTJobAbortCriteria_thresholdPercentage :: Lens' IoTJobAbortCriteria Double Source #
The minimum percentage of failureType
failures that occur before the
job can cancel.
This parameter supports up to two digits after the decimal (for example,
you can specify 10.9
or 10.99
, but not 10.999
).
ioTJobAbortCriteria_minNumberOfExecutedThings :: Lens' IoTJobAbortCriteria Natural Source #
The minimum number of things that receive the configuration before the job can cancel.
IoTJobExecutionsRolloutConfig
ioTJobExecutionsRolloutConfig_exponentialRate :: Lens' IoTJobExecutionsRolloutConfig (Maybe IoTJobExponentialRolloutRate) Source #
The exponential rate to increase the job rollout rate.
ioTJobExecutionsRolloutConfig_maximumPerMinute :: Lens' IoTJobExecutionsRolloutConfig (Maybe Natural) Source #
The maximum number of devices that receive a pending job notification, per minute.
IoTJobExponentialRolloutRate
ioTJobExponentialRolloutRate_baseRatePerMinute :: Lens' IoTJobExponentialRolloutRate Natural Source #
The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.
ioTJobExponentialRolloutRate_incrementFactor :: Lens' IoTJobExponentialRolloutRate Double Source #
The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example,
you can specify 1.5
, but not 1.55
).
ioTJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' IoTJobExponentialRolloutRate IoTJobRateIncreaseCriteria Source #
The criteria to increase the rollout rate for the job.
IoTJobRateIncreaseCriteria
ioTJobRateIncreaseCriteria_numberOfNotifiedThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural) Source #
The number of devices to receive the job notification before the rollout rate increases.
ioTJobRateIncreaseCriteria_numberOfSucceededThings :: Lens' IoTJobRateIncreaseCriteria (Maybe Natural) Source #
The number of devices to successfully run the configuration job before the rollout rate increases.
IoTJobTimeoutConfig
ioTJobTimeoutConfig_inProgressTimeoutInMinutes :: Lens' IoTJobTimeoutConfig (Maybe Integer) Source #
The amount of time, in minutes, that devices have to complete the job.
The timer starts when the job status is set to IN_PROGRESS
. If the job
status doesn't change to a terminal state before the time expires, then
the job status is set to TIMED_OUT
.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
LambdaContainerParams
lambdaContainerParams_devices :: Lens' LambdaContainerParams (Maybe [LambdaDeviceMount]) Source #
The list of system devices that the container can access.
lambdaContainerParams_memorySizeInKB :: Lens' LambdaContainerParams (Maybe Int) Source #
The memory size of the container, expressed in kilobytes.
Default: 16384
(16 MB)
lambdaContainerParams_mountROSysfs :: Lens' LambdaContainerParams (Maybe Bool) Source #
Whether or not the container can read information from the device's
/sys
folder.
Default: false
lambdaContainerParams_volumes :: Lens' LambdaContainerParams (Maybe [LambdaVolumeMount]) Source #
The list of volumes that the container can access.
LambdaDeviceMount
lambdaDeviceMount_addGroupOwner :: Lens' LambdaDeviceMount (Maybe Bool) Source #
Whether or not to add the component's system user as an owner of the device.
Default: false
lambdaDeviceMount_permission :: Lens' LambdaDeviceMount (Maybe LambdaFilesystemPermission) Source #
The permission to access the device: read/only (ro
) or read/write
(rw
).
Default: ro
lambdaDeviceMount_path :: Lens' LambdaDeviceMount Text Source #
The mount path for the device in the file system.
LambdaEventSource
lambdaEventSource_topic :: Lens' LambdaEventSource Text Source #
The topic to which to subscribe to receive event messages.
lambdaEventSource_type :: Lens' LambdaEventSource LambdaEventSourceType Source #
The type of event source. Choose from the following options:
PUB_SUB
– Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (+
and#
) in the event source topic.IOT_CORE
– Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type supports MQTT wildcards (+
and#
) in the event source topic.
LambdaExecutionParameters
lambdaExecutionParameters_environmentVariables :: Lens' LambdaExecutionParameters (Maybe (HashMap Text Text)) Source #
The map of environment variables that are available to the Lambda function when it runs.
lambdaExecutionParameters_eventSources :: Lens' LambdaExecutionParameters (Maybe [LambdaEventSource]) Source #
The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.
lambdaExecutionParameters_execArgs :: Lens' LambdaExecutionParameters (Maybe [Text]) Source #
The list of arguments to pass to the Lambda function when it runs.
lambdaExecutionParameters_inputPayloadEncodingType :: Lens' LambdaExecutionParameters (Maybe LambdaInputPayloadEncodingType) Source #
The encoding type that the Lambda function supports.
Default: json
lambdaExecutionParameters_linuxProcessParams :: Lens' LambdaExecutionParameters (Maybe LambdaLinuxProcessParams) Source #
The parameters for the Linux process that contains the Lambda function.
lambdaExecutionParameters_maxIdleTimeInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.
lambdaExecutionParameters_maxInstancesCount :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum number of instances that a non-pinned Lambda function can run at the same time.
lambdaExecutionParameters_maxQueueSize :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum size of the message queue for the Lambda function component. The IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
lambdaExecutionParameters_pinned :: Lens' LambdaExecutionParameters (Maybe Bool) Source #
Whether or not the Lambda function is pinned, or long-lived.
- A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.
- A non-pinned Lambda function starts only when it receives a work
item and exists after it idles for
maxIdleTimeInSeconds
. If the function has multiple work items, the IoT Greengrass Core software creates multiple instances of the function.
Default: true
lambdaExecutionParameters_statusTimeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
lambdaExecutionParameters_timeoutInSeconds :: Lens' LambdaExecutionParameters (Maybe Int) Source #
The maximum amount of time in seconds that the Lambda function can process a work item.
LambdaFunctionRecipeSource
lambdaFunctionRecipeSource_componentDependencies :: Lens' LambdaFunctionRecipeSource (Maybe (HashMap Text ComponentDependencyRequirement)) Source #
The component versions on which this Lambda function component depends.
lambdaFunctionRecipeSource_componentLambdaParameters :: Lens' LambdaFunctionRecipeSource (Maybe LambdaExecutionParameters) Source #
The system and runtime parameters for the Lambda function as it runs on the Greengrass core device.
lambdaFunctionRecipeSource_componentName :: Lens' LambdaFunctionRecipeSource (Maybe Text) Source #
The name of the component.
Defaults to the name of the Lambda function.
lambdaFunctionRecipeSource_componentPlatforms :: Lens' LambdaFunctionRecipeSource (Maybe [ComponentPlatform]) Source #
The platforms that the component version supports.
lambdaFunctionRecipeSource_componentVersion :: Lens' LambdaFunctionRecipeSource (Maybe Text) Source #
The version of the component.
Defaults to the version of the Lambda function as a semantic version.
For example, if your function version is 3
, the component version
becomes 3.0.0
.
lambdaFunctionRecipeSource_lambdaArn :: Lens' LambdaFunctionRecipeSource Text Source #
The
ARN
of the Lambda function. The ARN must include the version of the function
to import. You can't use version aliases like $LATEST
.
LambdaLinuxProcessParams
lambdaLinuxProcessParams_containerParams :: Lens' LambdaLinuxProcessParams (Maybe LambdaContainerParams) Source #
The parameters for the container in which the Lambda function runs.
lambdaLinuxProcessParams_isolationMode :: Lens' LambdaLinuxProcessParams (Maybe LambdaIsolationMode) Source #
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
LambdaVolumeMount
lambdaVolumeMount_addGroupOwner :: Lens' LambdaVolumeMount (Maybe Bool) Source #
Whether or not to add the IoT Greengrass user group as an owner of the volume.
Default: false
lambdaVolumeMount_permission :: Lens' LambdaVolumeMount (Maybe LambdaFilesystemPermission) Source #
The permission to access the volume: read/only (ro
) or read/write
(rw
).
Default: ro
lambdaVolumeMount_sourcePath :: Lens' LambdaVolumeMount Text Source #
The path to the physical volume in the file system.
lambdaVolumeMount_destinationPath :: Lens' LambdaVolumeMount Text Source #
The path to the logical volume in the file system.
ResolvedComponentVersion
resolvedComponentVersion_arn :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The ARN of the component version.
resolvedComponentVersion_componentName :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The name of the component.
resolvedComponentVersion_componentVersion :: Lens' ResolvedComponentVersion (Maybe Text) Source #
The version of the component.
resolvedComponentVersion_message :: Lens' ResolvedComponentVersion (Maybe Text) Source #
A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.
resolvedComponentVersion_recipe :: Lens' ResolvedComponentVersion (Maybe ByteString) Source #
The recipe of the component version.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
resolvedComponentVersion_vendorGuidance :: Lens' ResolvedComponentVersion (Maybe VendorGuidance) Source #
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE
– This component version is available and recommended for use.DISCONTINUED
– This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.DELETED
– This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
SystemResourceLimits
systemResourceLimits_cpus :: Lens' SystemResourceLimits (Maybe Double) Source #
The maximum amount of CPU time that a component's processes can use on
the core device. A core device's total CPU time is equivalent to the
device's number of CPU cores. For example, on a core device with 4 CPU
cores, you can set this value to 2
to limit the component's processes
to 50 percent usage of each CPU core. On a device with 1 CPU core, you
can set this value to 0.25
to limit the component's processes to 25
percent usage of the CPU. If you set this value to a number greater than
the number of CPU cores, the IoT Greengrass Core software doesn't limit
the component's CPU usage.
systemResourceLimits_memory :: Lens' SystemResourceLimits (Maybe Natural) Source #
The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.