| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IoTSiteWise.Types
Contents
- Service Configuration
- Errors
- AggregateType
- AssetErrorCode
- AssetModelState
- AssetRelationshipType
- AssetState
- AuthMode
- BatchPutAssetPropertyValueErrorCode
- CapabilitySyncStatus
- ComputeLocation
- ConfigurationState
- DetailedErrorCode
- EncryptionType
- ErrorCode
- ForwardingConfigState
- IdentityType
- ImageFileType
- ListAssetsFilter
- LoggingLevel
- MonitorErrorCode
- Permission
- PortalState
- PropertyDataType
- PropertyNotificationState
- Quality
- ResourceType
- StorageType
- TimeOrdering
- TraversalDirection
- TraversalType
- AccessPolicySummary
- AggregatedValue
- Aggregates
- Alarms
- AssetCompositeModel
- AssetErrorDetails
- AssetHierarchy
- AssetHierarchyInfo
- AssetModelCompositeModel
- AssetModelCompositeModelDefinition
- AssetModelHierarchy
- AssetModelHierarchyDefinition
- AssetModelProperty
- AssetModelPropertyDefinition
- AssetModelStatus
- AssetModelSummary
- AssetProperty
- AssetPropertyValue
- AssetRelationshipSummary
- AssetStatus
- AssetSummary
- AssociatedAssetsSummary
- Attribute
- BatchPutAssetPropertyError
- BatchPutAssetPropertyErrorEntry
- CompositeModelProperty
- ConfigurationErrorDetails
- ConfigurationStatus
- CustomerManagedS3Storage
- DashboardSummary
- DetailedError
- ErrorDetails
- ExpressionVariable
- ForwardingConfig
- GatewayCapabilitySummary
- GatewayPlatform
- GatewaySummary
- Greengrass
- GreengrassV2
- GroupIdentity
- IAMRoleIdentity
- IAMUserIdentity
- Identity
- Image
- ImageFile
- ImageLocation
- InterpolatedAssetPropertyValue
- LoggingOptions
- Measurement
- MeasurementProcessingConfig
- Metric
- MetricProcessingConfig
- MetricWindow
- MonitorErrorDetails
- MultiLayerStorage
- PortalResource
- PortalStatus
- PortalSummary
- ProjectResource
- ProjectSummary
- Property
- PropertyNotification
- PropertyType
- PutAssetPropertyValueEntry
- Resource
- TimeInNanos
- Transform
- TransformProcessingConfig
- TumblingWindow
- UserIdentity
- VariableValue
- Variant
Description
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AggregateType where
- AggregateType' { }
- pattern AggregateType_AVERAGE :: AggregateType
- pattern AggregateType_COUNT :: AggregateType
- pattern AggregateType_MAXIMUM :: AggregateType
- pattern AggregateType_MINIMUM :: AggregateType
- pattern AggregateType_STANDARD_DEVIATION :: AggregateType
- pattern AggregateType_SUM :: AggregateType
- newtype AssetErrorCode where
- AssetErrorCode' { }
- pattern AssetErrorCode_INTERNAL_FAILURE :: AssetErrorCode
- newtype AssetModelState where
- AssetModelState' { }
- pattern AssetModelState_ACTIVE :: AssetModelState
- pattern AssetModelState_CREATING :: AssetModelState
- pattern AssetModelState_DELETING :: AssetModelState
- pattern AssetModelState_FAILED :: AssetModelState
- pattern AssetModelState_PROPAGATING :: AssetModelState
- pattern AssetModelState_UPDATING :: AssetModelState
- newtype AssetRelationshipType where
- newtype AssetState where
- AssetState' { }
- pattern AssetState_ACTIVE :: AssetState
- pattern AssetState_CREATING :: AssetState
- pattern AssetState_DELETING :: AssetState
- pattern AssetState_FAILED :: AssetState
- pattern AssetState_UPDATING :: AssetState
- newtype AuthMode where
- AuthMode' {
- fromAuthMode :: Text
- pattern AuthMode_IAM :: AuthMode
- pattern AuthMode_SSO :: AuthMode
- AuthMode' {
- newtype BatchPutAssetPropertyValueErrorCode where
- BatchPutAssetPropertyValueErrorCode' { }
- pattern BatchPutAssetPropertyValueErrorCode_AccessDeniedException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_ConflictingOperationException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_InternalFailureException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_InvalidRequestException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_LimitExceededException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_ResourceNotFoundException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_ServiceUnavailableException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_ThrottlingException :: BatchPutAssetPropertyValueErrorCode
- pattern BatchPutAssetPropertyValueErrorCode_TimestampOutOfRangeException :: BatchPutAssetPropertyValueErrorCode
- newtype CapabilitySyncStatus where
- newtype ComputeLocation where
- ComputeLocation' { }
- pattern ComputeLocation_CLOUD :: ComputeLocation
- pattern ComputeLocation_EDGE :: ComputeLocation
- newtype ConfigurationState where
- newtype DetailedErrorCode where
- newtype EncryptionType where
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_INTERNAL_FAILURE :: ErrorCode
- pattern ErrorCode_VALIDATION_ERROR :: ErrorCode
- newtype ForwardingConfigState where
- newtype IdentityType where
- IdentityType' { }
- pattern IdentityType_GROUP :: IdentityType
- pattern IdentityType_IAM :: IdentityType
- pattern IdentityType_USER :: IdentityType
- newtype ImageFileType where
- ImageFileType' { }
- pattern ImageFileType_PNG :: ImageFileType
- newtype ListAssetsFilter where
- ListAssetsFilter' { }
- pattern ListAssetsFilter_ALL :: ListAssetsFilter
- pattern ListAssetsFilter_TOP_LEVEL :: ListAssetsFilter
- newtype LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_ERROR :: LoggingLevel
- pattern LoggingLevel_INFO :: LoggingLevel
- pattern LoggingLevel_OFF :: LoggingLevel
- newtype MonitorErrorCode where
- newtype Permission where
- Permission' { }
- pattern Permission_ADMINISTRATOR :: Permission
- pattern Permission_VIEWER :: Permission
- newtype PortalState where
- PortalState' { }
- pattern PortalState_ACTIVE :: PortalState
- pattern PortalState_CREATING :: PortalState
- pattern PortalState_DELETING :: PortalState
- pattern PortalState_FAILED :: PortalState
- pattern PortalState_UPDATING :: PortalState
- newtype PropertyDataType where
- PropertyDataType' { }
- pattern PropertyDataType_BOOLEAN :: PropertyDataType
- pattern PropertyDataType_DOUBLE :: PropertyDataType
- pattern PropertyDataType_INTEGER :: PropertyDataType
- pattern PropertyDataType_STRING :: PropertyDataType
- pattern PropertyDataType_STRUCT :: PropertyDataType
- newtype PropertyNotificationState where
- newtype Quality where
- Quality' {
- fromQuality :: Text
- pattern Quality_BAD :: Quality
- pattern Quality_GOOD :: Quality
- pattern Quality_UNCERTAIN :: Quality
- Quality' {
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_PORTAL :: ResourceType
- pattern ResourceType_PROJECT :: ResourceType
- newtype StorageType where
- StorageType' { }
- pattern StorageType_MULTI_LAYER_STORAGE :: StorageType
- pattern StorageType_SITEWISE_DEFAULT_STORAGE :: StorageType
- newtype TimeOrdering where
- TimeOrdering' { }
- pattern TimeOrdering_ASCENDING :: TimeOrdering
- pattern TimeOrdering_DESCENDING :: TimeOrdering
- newtype TraversalDirection where
- TraversalDirection' { }
- pattern TraversalDirection_CHILD :: TraversalDirection
- pattern TraversalDirection_PARENT :: TraversalDirection
- newtype TraversalType where
- TraversalType' { }
- pattern TraversalType_PATH_TO_ROOT :: TraversalType
- data AccessPolicySummary = AccessPolicySummary' {
- lastUpdateDate :: Maybe POSIX
- creationDate :: Maybe POSIX
- id :: Text
- identity :: Identity
- resource :: Resource
- permission :: Permission
- newAccessPolicySummary :: Text -> Identity -> Resource -> Permission -> AccessPolicySummary
- accessPolicySummary_lastUpdateDate :: Lens' AccessPolicySummary (Maybe UTCTime)
- accessPolicySummary_creationDate :: Lens' AccessPolicySummary (Maybe UTCTime)
- accessPolicySummary_id :: Lens' AccessPolicySummary Text
- accessPolicySummary_identity :: Lens' AccessPolicySummary Identity
- accessPolicySummary_resource :: Lens' AccessPolicySummary Resource
- accessPolicySummary_permission :: Lens' AccessPolicySummary Permission
- data AggregatedValue = AggregatedValue' {}
- newAggregatedValue :: UTCTime -> Aggregates -> AggregatedValue
- aggregatedValue_quality :: Lens' AggregatedValue (Maybe Quality)
- aggregatedValue_timestamp :: Lens' AggregatedValue UTCTime
- aggregatedValue_value :: Lens' AggregatedValue Aggregates
- data Aggregates = Aggregates' {}
- newAggregates :: Aggregates
- aggregates_maximum :: Lens' Aggregates (Maybe Double)
- aggregates_average :: Lens' Aggregates (Maybe Double)
- aggregates_count :: Lens' Aggregates (Maybe Double)
- aggregates_minimum :: Lens' Aggregates (Maybe Double)
- aggregates_standardDeviation :: Lens' Aggregates (Maybe Double)
- aggregates_sum :: Lens' Aggregates (Maybe Double)
- data Alarms = Alarms' {}
- newAlarms :: Text -> Alarms
- alarms_notificationLambdaArn :: Lens' Alarms (Maybe Text)
- alarms_alarmRoleArn :: Lens' Alarms Text
- data AssetCompositeModel = AssetCompositeModel' {
- description :: Maybe Text
- name :: Text
- type' :: Text
- properties :: [AssetProperty]
- newAssetCompositeModel :: Text -> Text -> AssetCompositeModel
- assetCompositeModel_description :: Lens' AssetCompositeModel (Maybe Text)
- assetCompositeModel_name :: Lens' AssetCompositeModel Text
- assetCompositeModel_type :: Lens' AssetCompositeModel Text
- assetCompositeModel_properties :: Lens' AssetCompositeModel [AssetProperty]
- data AssetErrorDetails = AssetErrorDetails' {}
- newAssetErrorDetails :: Text -> AssetErrorCode -> Text -> AssetErrorDetails
- assetErrorDetails_assetId :: Lens' AssetErrorDetails Text
- assetErrorDetails_code :: Lens' AssetErrorDetails AssetErrorCode
- assetErrorDetails_message :: Lens' AssetErrorDetails Text
- data AssetHierarchy = AssetHierarchy' {}
- newAssetHierarchy :: Text -> AssetHierarchy
- assetHierarchy_id :: Lens' AssetHierarchy (Maybe Text)
- assetHierarchy_name :: Lens' AssetHierarchy Text
- data AssetHierarchyInfo = AssetHierarchyInfo' {}
- newAssetHierarchyInfo :: AssetHierarchyInfo
- assetHierarchyInfo_childAssetId :: Lens' AssetHierarchyInfo (Maybe Text)
- assetHierarchyInfo_parentAssetId :: Lens' AssetHierarchyInfo (Maybe Text)
- data AssetModelCompositeModel = AssetModelCompositeModel' {
- description :: Maybe Text
- properties :: Maybe [AssetModelProperty]
- name :: Text
- type' :: Text
- newAssetModelCompositeModel :: Text -> Text -> AssetModelCompositeModel
- assetModelCompositeModel_description :: Lens' AssetModelCompositeModel (Maybe Text)
- assetModelCompositeModel_properties :: Lens' AssetModelCompositeModel (Maybe [AssetModelProperty])
- assetModelCompositeModel_name :: Lens' AssetModelCompositeModel Text
- assetModelCompositeModel_type :: Lens' AssetModelCompositeModel Text
- data AssetModelCompositeModelDefinition = AssetModelCompositeModelDefinition' {
- description :: Maybe Text
- properties :: Maybe [AssetModelPropertyDefinition]
- name :: Text
- type' :: Text
- newAssetModelCompositeModelDefinition :: Text -> Text -> AssetModelCompositeModelDefinition
- assetModelCompositeModelDefinition_description :: Lens' AssetModelCompositeModelDefinition (Maybe Text)
- assetModelCompositeModelDefinition_properties :: Lens' AssetModelCompositeModelDefinition (Maybe [AssetModelPropertyDefinition])
- assetModelCompositeModelDefinition_name :: Lens' AssetModelCompositeModelDefinition Text
- assetModelCompositeModelDefinition_type :: Lens' AssetModelCompositeModelDefinition Text
- data AssetModelHierarchy = AssetModelHierarchy' {}
- newAssetModelHierarchy :: Text -> Text -> AssetModelHierarchy
- assetModelHierarchy_id :: Lens' AssetModelHierarchy (Maybe Text)
- assetModelHierarchy_name :: Lens' AssetModelHierarchy Text
- assetModelHierarchy_childAssetModelId :: Lens' AssetModelHierarchy Text
- data AssetModelHierarchyDefinition = AssetModelHierarchyDefinition' {
- name :: Text
- childAssetModelId :: Text
- newAssetModelHierarchyDefinition :: Text -> Text -> AssetModelHierarchyDefinition
- assetModelHierarchyDefinition_name :: Lens' AssetModelHierarchyDefinition Text
- assetModelHierarchyDefinition_childAssetModelId :: Lens' AssetModelHierarchyDefinition Text
- data AssetModelProperty = AssetModelProperty' {
- dataTypeSpec :: Maybe Text
- id :: Maybe Text
- unit :: Maybe Text
- name :: Text
- dataType :: PropertyDataType
- type' :: PropertyType
- newAssetModelProperty :: Text -> PropertyDataType -> PropertyType -> AssetModelProperty
- assetModelProperty_dataTypeSpec :: Lens' AssetModelProperty (Maybe Text)
- assetModelProperty_id :: Lens' AssetModelProperty (Maybe Text)
- assetModelProperty_unit :: Lens' AssetModelProperty (Maybe Text)
- assetModelProperty_name :: Lens' AssetModelProperty Text
- assetModelProperty_dataType :: Lens' AssetModelProperty PropertyDataType
- assetModelProperty_type :: Lens' AssetModelProperty PropertyType
- data AssetModelPropertyDefinition = AssetModelPropertyDefinition' {
- dataTypeSpec :: Maybe Text
- unit :: Maybe Text
- name :: Text
- dataType :: PropertyDataType
- type' :: PropertyType
- newAssetModelPropertyDefinition :: Text -> PropertyDataType -> PropertyType -> AssetModelPropertyDefinition
- assetModelPropertyDefinition_dataTypeSpec :: Lens' AssetModelPropertyDefinition (Maybe Text)
- assetModelPropertyDefinition_unit :: Lens' AssetModelPropertyDefinition (Maybe Text)
- assetModelPropertyDefinition_name :: Lens' AssetModelPropertyDefinition Text
- assetModelPropertyDefinition_dataType :: Lens' AssetModelPropertyDefinition PropertyDataType
- assetModelPropertyDefinition_type :: Lens' AssetModelPropertyDefinition PropertyType
- data AssetModelStatus = AssetModelStatus' {}
- newAssetModelStatus :: AssetModelState -> AssetModelStatus
- assetModelStatus_error :: Lens' AssetModelStatus (Maybe ErrorDetails)
- assetModelStatus_state :: Lens' AssetModelStatus AssetModelState
- data AssetModelSummary = AssetModelSummary' {
- id :: Text
- arn :: Text
- name :: Text
- description :: Text
- creationDate :: POSIX
- lastUpdateDate :: POSIX
- status :: AssetModelStatus
- newAssetModelSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetModelStatus -> AssetModelSummary
- assetModelSummary_id :: Lens' AssetModelSummary Text
- assetModelSummary_arn :: Lens' AssetModelSummary Text
- assetModelSummary_name :: Lens' AssetModelSummary Text
- assetModelSummary_description :: Lens' AssetModelSummary Text
- assetModelSummary_creationDate :: Lens' AssetModelSummary UTCTime
- assetModelSummary_lastUpdateDate :: Lens' AssetModelSummary UTCTime
- assetModelSummary_status :: Lens' AssetModelSummary AssetModelStatus
- data AssetProperty = AssetProperty' {
- dataTypeSpec :: Maybe Text
- notification :: Maybe PropertyNotification
- alias :: Maybe Text
- unit :: Maybe Text
- id :: Text
- name :: Text
- dataType :: PropertyDataType
- newAssetProperty :: Text -> Text -> PropertyDataType -> AssetProperty
- assetProperty_dataTypeSpec :: Lens' AssetProperty (Maybe Text)
- assetProperty_notification :: Lens' AssetProperty (Maybe PropertyNotification)
- assetProperty_alias :: Lens' AssetProperty (Maybe Text)
- assetProperty_unit :: Lens' AssetProperty (Maybe Text)
- assetProperty_id :: Lens' AssetProperty Text
- assetProperty_name :: Lens' AssetProperty Text
- assetProperty_dataType :: Lens' AssetProperty PropertyDataType
- data AssetPropertyValue = AssetPropertyValue' {}
- newAssetPropertyValue :: Variant -> TimeInNanos -> AssetPropertyValue
- assetPropertyValue_quality :: Lens' AssetPropertyValue (Maybe Quality)
- assetPropertyValue_value :: Lens' AssetPropertyValue Variant
- assetPropertyValue_timestamp :: Lens' AssetPropertyValue TimeInNanos
- data AssetRelationshipSummary = AssetRelationshipSummary' {}
- newAssetRelationshipSummary :: AssetRelationshipType -> AssetRelationshipSummary
- assetRelationshipSummary_hierarchyInfo :: Lens' AssetRelationshipSummary (Maybe AssetHierarchyInfo)
- assetRelationshipSummary_relationshipType :: Lens' AssetRelationshipSummary AssetRelationshipType
- data AssetStatus = AssetStatus' {}
- newAssetStatus :: AssetState -> AssetStatus
- assetStatus_error :: Lens' AssetStatus (Maybe ErrorDetails)
- assetStatus_state :: Lens' AssetStatus AssetState
- data AssetSummary = AssetSummary' {
- id :: Text
- arn :: Text
- name :: Text
- assetModelId :: Text
- creationDate :: POSIX
- lastUpdateDate :: POSIX
- status :: AssetStatus
- hierarchies :: [AssetHierarchy]
- newAssetSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> AssetSummary
- assetSummary_id :: Lens' AssetSummary Text
- assetSummary_arn :: Lens' AssetSummary Text
- assetSummary_name :: Lens' AssetSummary Text
- assetSummary_assetModelId :: Lens' AssetSummary Text
- assetSummary_creationDate :: Lens' AssetSummary UTCTime
- assetSummary_lastUpdateDate :: Lens' AssetSummary UTCTime
- assetSummary_status :: Lens' AssetSummary AssetStatus
- assetSummary_hierarchies :: Lens' AssetSummary [AssetHierarchy]
- data AssociatedAssetsSummary = AssociatedAssetsSummary' {
- id :: Text
- arn :: Text
- name :: Text
- assetModelId :: Text
- creationDate :: POSIX
- lastUpdateDate :: POSIX
- status :: AssetStatus
- hierarchies :: [AssetHierarchy]
- newAssociatedAssetsSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> AssociatedAssetsSummary
- associatedAssetsSummary_id :: Lens' AssociatedAssetsSummary Text
- associatedAssetsSummary_arn :: Lens' AssociatedAssetsSummary Text
- associatedAssetsSummary_name :: Lens' AssociatedAssetsSummary Text
- associatedAssetsSummary_assetModelId :: Lens' AssociatedAssetsSummary Text
- associatedAssetsSummary_creationDate :: Lens' AssociatedAssetsSummary UTCTime
- associatedAssetsSummary_lastUpdateDate :: Lens' AssociatedAssetsSummary UTCTime
- associatedAssetsSummary_status :: Lens' AssociatedAssetsSummary AssetStatus
- associatedAssetsSummary_hierarchies :: Lens' AssociatedAssetsSummary [AssetHierarchy]
- data Attribute = Attribute' {}
- newAttribute :: Attribute
- attribute_defaultValue :: Lens' Attribute (Maybe Text)
- data BatchPutAssetPropertyError = BatchPutAssetPropertyError' {}
- newBatchPutAssetPropertyError :: BatchPutAssetPropertyValueErrorCode -> Text -> BatchPutAssetPropertyError
- batchPutAssetPropertyError_errorCode :: Lens' BatchPutAssetPropertyError BatchPutAssetPropertyValueErrorCode
- batchPutAssetPropertyError_errorMessage :: Lens' BatchPutAssetPropertyError Text
- batchPutAssetPropertyError_timestamps :: Lens' BatchPutAssetPropertyError [TimeInNanos]
- data BatchPutAssetPropertyErrorEntry = BatchPutAssetPropertyErrorEntry' {}
- newBatchPutAssetPropertyErrorEntry :: Text -> BatchPutAssetPropertyErrorEntry
- batchPutAssetPropertyErrorEntry_entryId :: Lens' BatchPutAssetPropertyErrorEntry Text
- batchPutAssetPropertyErrorEntry_errors :: Lens' BatchPutAssetPropertyErrorEntry [BatchPutAssetPropertyError]
- data CompositeModelProperty = CompositeModelProperty' {}
- newCompositeModelProperty :: Text -> Text -> Property -> CompositeModelProperty
- compositeModelProperty_name :: Lens' CompositeModelProperty Text
- compositeModelProperty_type :: Lens' CompositeModelProperty Text
- compositeModelProperty_assetProperty :: Lens' CompositeModelProperty Property
- data ConfigurationErrorDetails = ConfigurationErrorDetails' {}
- newConfigurationErrorDetails :: ErrorCode -> Text -> ConfigurationErrorDetails
- configurationErrorDetails_code :: Lens' ConfigurationErrorDetails ErrorCode
- configurationErrorDetails_message :: Lens' ConfigurationErrorDetails Text
- data ConfigurationStatus = ConfigurationStatus' {}
- newConfigurationStatus :: ConfigurationState -> ConfigurationStatus
- configurationStatus_error :: Lens' ConfigurationStatus (Maybe ConfigurationErrorDetails)
- configurationStatus_state :: Lens' ConfigurationStatus ConfigurationState
- data CustomerManagedS3Storage = CustomerManagedS3Storage' {
- s3ResourceArn :: Text
- roleArn :: Text
- newCustomerManagedS3Storage :: Text -> Text -> CustomerManagedS3Storage
- customerManagedS3Storage_s3ResourceArn :: Lens' CustomerManagedS3Storage Text
- customerManagedS3Storage_roleArn :: Lens' CustomerManagedS3Storage Text
- data DashboardSummary = DashboardSummary' {
- lastUpdateDate :: Maybe POSIX
- creationDate :: Maybe POSIX
- description :: Maybe Text
- id :: Text
- name :: Text
- newDashboardSummary :: Text -> Text -> DashboardSummary
- dashboardSummary_lastUpdateDate :: Lens' DashboardSummary (Maybe UTCTime)
- dashboardSummary_creationDate :: Lens' DashboardSummary (Maybe UTCTime)
- dashboardSummary_description :: Lens' DashboardSummary (Maybe Text)
- dashboardSummary_id :: Lens' DashboardSummary Text
- dashboardSummary_name :: Lens' DashboardSummary Text
- data DetailedError = DetailedError' {
- code :: DetailedErrorCode
- message :: Text
- newDetailedError :: DetailedErrorCode -> Text -> DetailedError
- detailedError_code :: Lens' DetailedError DetailedErrorCode
- detailedError_message :: Lens' DetailedError Text
- data ErrorDetails = ErrorDetails' {}
- newErrorDetails :: ErrorCode -> Text -> ErrorDetails
- errorDetails_details :: Lens' ErrorDetails (Maybe [DetailedError])
- errorDetails_code :: Lens' ErrorDetails ErrorCode
- errorDetails_message :: Lens' ErrorDetails Text
- data ExpressionVariable = ExpressionVariable' {
- name :: Text
- value :: VariableValue
- newExpressionVariable :: Text -> VariableValue -> ExpressionVariable
- expressionVariable_name :: Lens' ExpressionVariable Text
- expressionVariable_value :: Lens' ExpressionVariable VariableValue
- data ForwardingConfig = ForwardingConfig' {}
- newForwardingConfig :: ForwardingConfigState -> ForwardingConfig
- forwardingConfig_state :: Lens' ForwardingConfig ForwardingConfigState
- data GatewayCapabilitySummary = GatewayCapabilitySummary' {}
- newGatewayCapabilitySummary :: Text -> CapabilitySyncStatus -> GatewayCapabilitySummary
- gatewayCapabilitySummary_capabilityNamespace :: Lens' GatewayCapabilitySummary Text
- gatewayCapabilitySummary_capabilitySyncStatus :: Lens' GatewayCapabilitySummary CapabilitySyncStatus
- data GatewayPlatform = GatewayPlatform' {}
- newGatewayPlatform :: GatewayPlatform
- gatewayPlatform_greengrass :: Lens' GatewayPlatform (Maybe Greengrass)
- gatewayPlatform_greengrassV2 :: Lens' GatewayPlatform (Maybe GreengrassV2)
- data GatewaySummary = GatewaySummary' {}
- newGatewaySummary :: Text -> Text -> UTCTime -> UTCTime -> GatewaySummary
- gatewaySummary_gatewayPlatform :: Lens' GatewaySummary (Maybe GatewayPlatform)
- gatewaySummary_gatewayCapabilitySummaries :: Lens' GatewaySummary (Maybe [GatewayCapabilitySummary])
- gatewaySummary_gatewayId :: Lens' GatewaySummary Text
- gatewaySummary_gatewayName :: Lens' GatewaySummary Text
- gatewaySummary_creationDate :: Lens' GatewaySummary UTCTime
- gatewaySummary_lastUpdateDate :: Lens' GatewaySummary UTCTime
- data Greengrass = Greengrass' {}
- newGreengrass :: Text -> Greengrass
- greengrass_groupArn :: Lens' Greengrass Text
- data GreengrassV2 = GreengrassV2' {}
- newGreengrassV2 :: Text -> GreengrassV2
- greengrassV2_coreDeviceThingName :: Lens' GreengrassV2 Text
- data GroupIdentity = GroupIdentity' {}
- newGroupIdentity :: Text -> GroupIdentity
- groupIdentity_id :: Lens' GroupIdentity Text
- data IAMRoleIdentity = IAMRoleIdentity' {}
- newIAMRoleIdentity :: Text -> IAMRoleIdentity
- iAMRoleIdentity_arn :: Lens' IAMRoleIdentity Text
- data IAMUserIdentity = IAMUserIdentity' {}
- newIAMUserIdentity :: Text -> IAMUserIdentity
- iAMUserIdentity_arn :: Lens' IAMUserIdentity Text
- data Identity = Identity' {}
- newIdentity :: Identity
- identity_iamUser :: Lens' Identity (Maybe IAMUserIdentity)
- identity_group :: Lens' Identity (Maybe GroupIdentity)
- identity_user :: Lens' Identity (Maybe UserIdentity)
- identity_iamRole :: Lens' Identity (Maybe IAMRoleIdentity)
- data Image = Image' {}
- newImage :: Image
- image_id :: Lens' Image (Maybe Text)
- image_file :: Lens' Image (Maybe ImageFile)
- data ImageFile = ImageFile' {
- data' :: Base64
- type' :: ImageFileType
- newImageFile :: ByteString -> ImageFileType -> ImageFile
- imageFile_data :: Lens' ImageFile ByteString
- imageFile_type :: Lens' ImageFile ImageFileType
- data ImageLocation = ImageLocation' {}
- newImageLocation :: Text -> Text -> ImageLocation
- imageLocation_id :: Lens' ImageLocation Text
- imageLocation_url :: Lens' ImageLocation Text
- data InterpolatedAssetPropertyValue = InterpolatedAssetPropertyValue' {
- timestamp :: TimeInNanos
- value :: Variant
- newInterpolatedAssetPropertyValue :: TimeInNanos -> Variant -> InterpolatedAssetPropertyValue
- interpolatedAssetPropertyValue_timestamp :: Lens' InterpolatedAssetPropertyValue TimeInNanos
- interpolatedAssetPropertyValue_value :: Lens' InterpolatedAssetPropertyValue Variant
- data LoggingOptions = LoggingOptions' {}
- newLoggingOptions :: LoggingLevel -> LoggingOptions
- loggingOptions_level :: Lens' LoggingOptions LoggingLevel
- data Measurement = Measurement' {}
- newMeasurement :: Measurement
- measurement_processingConfig :: Lens' Measurement (Maybe MeasurementProcessingConfig)
- data MeasurementProcessingConfig = MeasurementProcessingConfig' {}
- newMeasurementProcessingConfig :: ForwardingConfig -> MeasurementProcessingConfig
- measurementProcessingConfig_forwardingConfig :: Lens' MeasurementProcessingConfig ForwardingConfig
- data Metric = Metric' {}
- newMetric :: Text -> MetricWindow -> Metric
- metric_processingConfig :: Lens' Metric (Maybe MetricProcessingConfig)
- metric_expression :: Lens' Metric Text
- metric_variables :: Lens' Metric [ExpressionVariable]
- metric_window :: Lens' Metric MetricWindow
- data MetricProcessingConfig = MetricProcessingConfig' {}
- newMetricProcessingConfig :: ComputeLocation -> MetricProcessingConfig
- metricProcessingConfig_computeLocation :: Lens' MetricProcessingConfig ComputeLocation
- data MetricWindow = MetricWindow' {}
- newMetricWindow :: MetricWindow
- metricWindow_tumbling :: Lens' MetricWindow (Maybe TumblingWindow)
- data MonitorErrorDetails = MonitorErrorDetails' {}
- newMonitorErrorDetails :: MonitorErrorDetails
- monitorErrorDetails_code :: Lens' MonitorErrorDetails (Maybe MonitorErrorCode)
- monitorErrorDetails_message :: Lens' MonitorErrorDetails (Maybe Text)
- data MultiLayerStorage = MultiLayerStorage' {}
- newMultiLayerStorage :: CustomerManagedS3Storage -> MultiLayerStorage
- multiLayerStorage_customerManagedS3Storage :: Lens' MultiLayerStorage CustomerManagedS3Storage
- data PortalResource = PortalResource' {}
- newPortalResource :: Text -> PortalResource
- portalResource_id :: Lens' PortalResource Text
- data PortalStatus = PortalStatus' {}
- newPortalStatus :: PortalState -> PortalStatus
- portalStatus_error :: Lens' PortalStatus (Maybe MonitorErrorDetails)
- portalStatus_state :: Lens' PortalStatus PortalState
- data PortalSummary = PortalSummary' {
- lastUpdateDate :: Maybe POSIX
- creationDate :: Maybe POSIX
- description :: Maybe Text
- roleArn :: Maybe Text
- id :: Text
- name :: Text
- startUrl :: Text
- status :: PortalStatus
- newPortalSummary :: Text -> Text -> Text -> PortalStatus -> PortalSummary
- portalSummary_lastUpdateDate :: Lens' PortalSummary (Maybe UTCTime)
- portalSummary_creationDate :: Lens' PortalSummary (Maybe UTCTime)
- portalSummary_description :: Lens' PortalSummary (Maybe Text)
- portalSummary_roleArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_id :: Lens' PortalSummary Text
- portalSummary_name :: Lens' PortalSummary Text
- portalSummary_startUrl :: Lens' PortalSummary Text
- portalSummary_status :: Lens' PortalSummary PortalStatus
- data ProjectResource = ProjectResource' {}
- newProjectResource :: Text -> ProjectResource
- projectResource_id :: Lens' ProjectResource Text
- data ProjectSummary = ProjectSummary' {
- lastUpdateDate :: Maybe POSIX
- creationDate :: Maybe POSIX
- description :: Maybe Text
- id :: Text
- name :: Text
- newProjectSummary :: Text -> Text -> ProjectSummary
- projectSummary_lastUpdateDate :: Lens' ProjectSummary (Maybe UTCTime)
- projectSummary_creationDate :: Lens' ProjectSummary (Maybe UTCTime)
- projectSummary_description :: Lens' ProjectSummary (Maybe Text)
- projectSummary_id :: Lens' ProjectSummary Text
- projectSummary_name :: Lens' ProjectSummary Text
- data Property = Property' {
- notification :: Maybe PropertyNotification
- alias :: Maybe Text
- type' :: Maybe PropertyType
- unit :: Maybe Text
- id :: Text
- name :: Text
- dataType :: PropertyDataType
- newProperty :: Text -> Text -> PropertyDataType -> Property
- property_notification :: Lens' Property (Maybe PropertyNotification)
- property_alias :: Lens' Property (Maybe Text)
- property_type :: Lens' Property (Maybe PropertyType)
- property_unit :: Lens' Property (Maybe Text)
- property_id :: Lens' Property Text
- property_name :: Lens' Property Text
- property_dataType :: Lens' Property PropertyDataType
- data PropertyNotification = PropertyNotification' {}
- newPropertyNotification :: Text -> PropertyNotificationState -> PropertyNotification
- propertyNotification_topic :: Lens' PropertyNotification Text
- propertyNotification_state :: Lens' PropertyNotification PropertyNotificationState
- data PropertyType = PropertyType' {}
- newPropertyType :: PropertyType
- propertyType_attribute :: Lens' PropertyType (Maybe Attribute)
- propertyType_transform :: Lens' PropertyType (Maybe Transform)
- propertyType_metric :: Lens' PropertyType (Maybe Metric)
- propertyType_measurement :: Lens' PropertyType (Maybe Measurement)
- data PutAssetPropertyValueEntry = PutAssetPropertyValueEntry' {
- propertyAlias :: Maybe Text
- propertyId :: Maybe Text
- assetId :: Maybe Text
- entryId :: Text
- propertyValues :: [AssetPropertyValue]
- newPutAssetPropertyValueEntry :: Text -> PutAssetPropertyValueEntry
- putAssetPropertyValueEntry_propertyAlias :: Lens' PutAssetPropertyValueEntry (Maybe Text)
- putAssetPropertyValueEntry_propertyId :: Lens' PutAssetPropertyValueEntry (Maybe Text)
- putAssetPropertyValueEntry_assetId :: Lens' PutAssetPropertyValueEntry (Maybe Text)
- putAssetPropertyValueEntry_entryId :: Lens' PutAssetPropertyValueEntry Text
- putAssetPropertyValueEntry_propertyValues :: Lens' PutAssetPropertyValueEntry [AssetPropertyValue]
- data Resource = Resource' {}
- newResource :: Resource
- resource_portal :: Lens' Resource (Maybe PortalResource)
- resource_project :: Lens' Resource (Maybe ProjectResource)
- data TimeInNanos = TimeInNanos' {}
- newTimeInNanos :: Natural -> TimeInNanos
- timeInNanos_offsetInNanos :: Lens' TimeInNanos (Maybe Natural)
- timeInNanos_timeInSeconds :: Lens' TimeInNanos Natural
- data Transform = Transform' {}
- newTransform :: Text -> Transform
- transform_processingConfig :: Lens' Transform (Maybe TransformProcessingConfig)
- transform_expression :: Lens' Transform Text
- transform_variables :: Lens' Transform [ExpressionVariable]
- data TransformProcessingConfig = TransformProcessingConfig' {}
- newTransformProcessingConfig :: ComputeLocation -> TransformProcessingConfig
- transformProcessingConfig_forwardingConfig :: Lens' TransformProcessingConfig (Maybe ForwardingConfig)
- transformProcessingConfig_computeLocation :: Lens' TransformProcessingConfig ComputeLocation
- data TumblingWindow = TumblingWindow' {}
- newTumblingWindow :: Text -> TumblingWindow
- tumblingWindow_offset :: Lens' TumblingWindow (Maybe Text)
- tumblingWindow_interval :: Lens' TumblingWindow Text
- data UserIdentity = UserIdentity' {}
- newUserIdentity :: Text -> UserIdentity
- userIdentity_id :: Lens' UserIdentity Text
- data VariableValue = VariableValue' {
- hierarchyId :: Maybe Text
- propertyId :: Text
- newVariableValue :: Text -> VariableValue
- variableValue_hierarchyId :: Lens' VariableValue (Maybe Text)
- variableValue_propertyId :: Lens' VariableValue Text
- data Variant = Variant' {}
- newVariant :: Variant
- variant_integerValue :: Lens' Variant (Maybe Int)
- variant_doubleValue :: Lens' Variant (Maybe Double)
- variant_stringValue :: Lens' Variant (Maybe Text)
- variant_booleanValue :: Lens' Variant (Maybe Bool)
Service Configuration
defaultService :: Service Source #
API version 2019-12-02 of the Amazon IoT SiteWise SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.
_ConflictingOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
IoT SiteWise can't process your request right now. Try again later.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested service is unavailable.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource can't be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
AggregateType
newtype AggregateType Source #
Constructors
| AggregateType' | |
Fields | |
Bundled Patterns
| pattern AggregateType_AVERAGE :: AggregateType | |
| pattern AggregateType_COUNT :: AggregateType | |
| pattern AggregateType_MAXIMUM :: AggregateType | |
| pattern AggregateType_MINIMUM :: AggregateType | |
| pattern AggregateType_STANDARD_DEVIATION :: AggregateType | |
| pattern AggregateType_SUM :: AggregateType |
Instances
AssetErrorCode
newtype AssetErrorCode Source #
Constructors
| AssetErrorCode' | |
Fields | |
Bundled Patterns
| pattern AssetErrorCode_INTERNAL_FAILURE :: AssetErrorCode |
Instances
AssetModelState
newtype AssetModelState Source #
Constructors
| AssetModelState' | |
Fields | |
Bundled Patterns
| pattern AssetModelState_ACTIVE :: AssetModelState | |
| pattern AssetModelState_CREATING :: AssetModelState | |
| pattern AssetModelState_DELETING :: AssetModelState | |
| pattern AssetModelState_FAILED :: AssetModelState | |
| pattern AssetModelState_PROPAGATING :: AssetModelState | |
| pattern AssetModelState_UPDATING :: AssetModelState |
Instances
AssetRelationshipType
newtype AssetRelationshipType Source #
Constructors
| AssetRelationshipType' | |
Fields | |
Bundled Patterns
| pattern AssetRelationshipType_HIERARCHY :: AssetRelationshipType |
Instances
AssetState
newtype AssetState Source #
Constructors
| AssetState' | |
Fields | |
Bundled Patterns
| pattern AssetState_ACTIVE :: AssetState | |
| pattern AssetState_CREATING :: AssetState | |
| pattern AssetState_DELETING :: AssetState | |
| pattern AssetState_FAILED :: AssetState | |
| pattern AssetState_UPDATING :: AssetState |
Instances
AuthMode
Constructors
| AuthMode' | |
Fields
| |
Bundled Patterns
| pattern AuthMode_IAM :: AuthMode | |
| pattern AuthMode_SSO :: AuthMode |
Instances
BatchPutAssetPropertyValueErrorCode
newtype BatchPutAssetPropertyValueErrorCode Source #
Constructors
| BatchPutAssetPropertyValueErrorCode' | |
Bundled Patterns
Instances
CapabilitySyncStatus
newtype CapabilitySyncStatus Source #
Constructors
| CapabilitySyncStatus' | |
Fields | |
Bundled Patterns
| pattern CapabilitySyncStatus_IN_SYNC :: CapabilitySyncStatus | |
| pattern CapabilitySyncStatus_OUT_OF_SYNC :: CapabilitySyncStatus | |
| pattern CapabilitySyncStatus_SYNC_FAILED :: CapabilitySyncStatus | |
| pattern CapabilitySyncStatus_UNKNOWN :: CapabilitySyncStatus |
Instances
ComputeLocation
newtype ComputeLocation Source #
Constructors
| ComputeLocation' | |
Fields | |
Bundled Patterns
| pattern ComputeLocation_CLOUD :: ComputeLocation | |
| pattern ComputeLocation_EDGE :: ComputeLocation |
Instances
ConfigurationState
newtype ConfigurationState Source #
Constructors
| ConfigurationState' | |
Fields | |
Bundled Patterns
| pattern ConfigurationState_ACTIVE :: ConfigurationState | |
| pattern ConfigurationState_UPDATE_FAILED :: ConfigurationState | |
| pattern ConfigurationState_UPDATE_IN_PROGRESS :: ConfigurationState |
Instances
DetailedErrorCode
newtype DetailedErrorCode Source #
Constructors
| DetailedErrorCode' | |
Fields | |
Bundled Patterns
| pattern DetailedErrorCode_INCOMPATIBLE_COMPUTE_LOCATION :: DetailedErrorCode | |
| pattern DetailedErrorCode_INCOMPATIBLE_FORWARDING_CONFIGURATION :: DetailedErrorCode |
Instances
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_KMS_BASED_ENCRYPTION :: EncryptionType | |
| pattern EncryptionType_SITEWISE_DEFAULT_ENCRYPTION :: EncryptionType |
Instances
ErrorCode
Constructors
| ErrorCode' | |
Fields | |
Bundled Patterns
| pattern ErrorCode_INTERNAL_FAILURE :: ErrorCode | |
| pattern ErrorCode_VALIDATION_ERROR :: ErrorCode |
Instances
ForwardingConfigState
newtype ForwardingConfigState Source #
Constructors
| ForwardingConfigState' | |
Fields | |
Bundled Patterns
| pattern ForwardingConfigState_DISABLED :: ForwardingConfigState | |
| pattern ForwardingConfigState_ENABLED :: ForwardingConfigState |
Instances
IdentityType
newtype IdentityType Source #
Constructors
| IdentityType' | |
Fields | |
Bundled Patterns
| pattern IdentityType_GROUP :: IdentityType | |
| pattern IdentityType_IAM :: IdentityType | |
| pattern IdentityType_USER :: IdentityType |
Instances
ImageFileType
newtype ImageFileType Source #
Constructors
| ImageFileType' | |
Fields | |
Bundled Patterns
| pattern ImageFileType_PNG :: ImageFileType |
Instances
ListAssetsFilter
newtype ListAssetsFilter Source #
Constructors
| ListAssetsFilter' | |
Fields | |
Bundled Patterns
| pattern ListAssetsFilter_ALL :: ListAssetsFilter | |
| pattern ListAssetsFilter_TOP_LEVEL :: ListAssetsFilter |
Instances
LoggingLevel
newtype LoggingLevel Source #
Constructors
| LoggingLevel' | |
Fields | |
Bundled Patterns
| pattern LoggingLevel_ERROR :: LoggingLevel | |
| pattern LoggingLevel_INFO :: LoggingLevel | |
| pattern LoggingLevel_OFF :: LoggingLevel |
Instances
MonitorErrorCode
newtype MonitorErrorCode Source #
Constructors
| MonitorErrorCode' | |
Fields | |
Bundled Patterns
| pattern MonitorErrorCode_INTERNAL_FAILURE :: MonitorErrorCode | |
| pattern MonitorErrorCode_LIMIT_EXCEEDED :: MonitorErrorCode | |
| pattern MonitorErrorCode_VALIDATION_ERROR :: MonitorErrorCode |
Instances
Permission
newtype Permission Source #
Constructors
| Permission' | |
Fields | |
Bundled Patterns
| pattern Permission_ADMINISTRATOR :: Permission | |
| pattern Permission_VIEWER :: Permission |
Instances
PortalState
newtype PortalState Source #
Constructors
| PortalState' | |
Fields | |
Bundled Patterns
| pattern PortalState_ACTIVE :: PortalState | |
| pattern PortalState_CREATING :: PortalState | |
| pattern PortalState_DELETING :: PortalState | |
| pattern PortalState_FAILED :: PortalState | |
| pattern PortalState_UPDATING :: PortalState |
Instances
PropertyDataType
newtype PropertyDataType Source #
Constructors
| PropertyDataType' | |
Fields | |
Bundled Patterns
| pattern PropertyDataType_BOOLEAN :: PropertyDataType | |
| pattern PropertyDataType_DOUBLE :: PropertyDataType | |
| pattern PropertyDataType_INTEGER :: PropertyDataType | |
| pattern PropertyDataType_STRING :: PropertyDataType | |
| pattern PropertyDataType_STRUCT :: PropertyDataType |
Instances
PropertyNotificationState
newtype PropertyNotificationState Source #
Constructors
| PropertyNotificationState' | |
Fields | |
Bundled Patterns
| pattern PropertyNotificationState_DISABLED :: PropertyNotificationState | |
| pattern PropertyNotificationState_ENABLED :: PropertyNotificationState |
Instances
Quality
Constructors
| Quality' | |
Fields
| |
Bundled Patterns
| pattern Quality_BAD :: Quality | |
| pattern Quality_GOOD :: Quality | |
| pattern Quality_UNCERTAIN :: Quality |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_PORTAL :: ResourceType | |
| pattern ResourceType_PROJECT :: ResourceType |
Instances
StorageType
newtype StorageType Source #
Constructors
| StorageType' | |
Fields | |
Bundled Patterns
| pattern StorageType_MULTI_LAYER_STORAGE :: StorageType | |
| pattern StorageType_SITEWISE_DEFAULT_STORAGE :: StorageType |
Instances
TimeOrdering
newtype TimeOrdering Source #
Constructors
| TimeOrdering' | |
Fields | |
Bundled Patterns
| pattern TimeOrdering_ASCENDING :: TimeOrdering | |
| pattern TimeOrdering_DESCENDING :: TimeOrdering |
Instances
TraversalDirection
newtype TraversalDirection Source #
Constructors
| TraversalDirection' | |
Fields | |
Bundled Patterns
| pattern TraversalDirection_CHILD :: TraversalDirection | |
| pattern TraversalDirection_PARENT :: TraversalDirection |
Instances
TraversalType
newtype TraversalType Source #
Constructors
| TraversalType' | |
Fields | |
Bundled Patterns
| pattern TraversalType_PATH_TO_ROOT :: TraversalType |
Instances
AccessPolicySummary
data AccessPolicySummary Source #
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
See: newAccessPolicySummary smart constructor.
Constructors
| AccessPolicySummary' | |
Fields
| |
Instances
newAccessPolicySummary Source #
Arguments
| :: Text | |
| -> Identity | |
| -> Resource | |
| -> Permission | |
| -> AccessPolicySummary |
Create a value of AccessPolicySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdateDate:AccessPolicySummary', accessPolicySummary_lastUpdateDate - The date the access policy was last updated, in Unix epoch time.
$sel:creationDate:AccessPolicySummary', accessPolicySummary_creationDate - The date the access policy was created, in Unix epoch time.
$sel:id:AccessPolicySummary', accessPolicySummary_id - The ID of the access policy.
$sel:identity:AccessPolicySummary', accessPolicySummary_identity - The identity (an Amazon Web Services SSO user, an Amazon Web Services
SSO group, or an IAM user).
$sel:resource:AccessPolicySummary', accessPolicySummary_resource - The IoT SiteWise Monitor resource (a portal or project).
$sel:permission:AccessPolicySummary', accessPolicySummary_permission - The permissions for the access policy. Note that a project
ADMINISTRATOR is also known as a project owner.
accessPolicySummary_lastUpdateDate :: Lens' AccessPolicySummary (Maybe UTCTime) Source #
The date the access policy was last updated, in Unix epoch time.
accessPolicySummary_creationDate :: Lens' AccessPolicySummary (Maybe UTCTime) Source #
The date the access policy was created, in Unix epoch time.
accessPolicySummary_id :: Lens' AccessPolicySummary Text Source #
The ID of the access policy.
accessPolicySummary_identity :: Lens' AccessPolicySummary Identity Source #
The identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user).
accessPolicySummary_resource :: Lens' AccessPolicySummary Resource Source #
The IoT SiteWise Monitor resource (a portal or project).
accessPolicySummary_permission :: Lens' AccessPolicySummary Permission Source #
The permissions for the access policy. Note that a project
ADMINISTRATOR is also known as a project owner.
AggregatedValue
data AggregatedValue Source #
Contains aggregated asset property values (for example, average, minimum, and maximum).
See: newAggregatedValue smart constructor.
Constructors
| AggregatedValue' | |
Instances
Arguments
| :: UTCTime | |
| -> Aggregates | |
| -> AggregatedValue |
Create a value of AggregatedValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:quality:AggregatedValue', aggregatedValue_quality - The quality of the aggregated data.
$sel:timestamp:AggregatedValue', aggregatedValue_timestamp - The date the aggregating computations occurred, in Unix epoch time.
$sel:value:AggregatedValue', aggregatedValue_value - The value of the aggregates.
aggregatedValue_quality :: Lens' AggregatedValue (Maybe Quality) Source #
The quality of the aggregated data.
aggregatedValue_timestamp :: Lens' AggregatedValue UTCTime Source #
The date the aggregating computations occurred, in Unix epoch time.
aggregatedValue_value :: Lens' AggregatedValue Aggregates Source #
The value of the aggregates.
Aggregates
data Aggregates Source #
Contains the (pre-calculated) aggregate values for an asset property.
See: newAggregates smart constructor.
Constructors
| Aggregates' | |
Fields
| |
Instances
newAggregates :: Aggregates Source #
Create a value of Aggregates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximum:Aggregates', aggregates_maximum - The maximum value of the time series over a time interval window.
$sel:average:Aggregates', aggregates_average - The average (mean) value of the time series over a time interval window.
$sel:count:Aggregates', aggregates_count - The count of data points in the time series over a time interval window.
$sel:minimum:Aggregates', aggregates_minimum - The minimum value of the time series over a time interval window.
$sel:standardDeviation:Aggregates', aggregates_standardDeviation - The standard deviation of the time series over a time interval window.
$sel:sum:Aggregates', aggregates_sum - The sum of the time series over a time interval window.
aggregates_maximum :: Lens' Aggregates (Maybe Double) Source #
The maximum value of the time series over a time interval window.
aggregates_average :: Lens' Aggregates (Maybe Double) Source #
The average (mean) value of the time series over a time interval window.
aggregates_count :: Lens' Aggregates (Maybe Double) Source #
The count of data points in the time series over a time interval window.
aggregates_minimum :: Lens' Aggregates (Maybe Double) Source #
The minimum value of the time series over a time interval window.
aggregates_standardDeviation :: Lens' Aggregates (Maybe Double) Source #
The standard deviation of the time series over a time interval window.
aggregates_sum :: Lens' Aggregates (Maybe Double) Source #
The sum of the time series over a time interval window.
Alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
See: newAlarms smart constructor.
Constructors
| Alarms' | |
Fields
| |
Instances
| Eq Alarms Source # | |
| Read Alarms Source # | |
| Show Alarms Source # | |
| Generic Alarms Source # | |
| NFData Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| Hashable Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| ToJSON Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| FromJSON Alarms Source # | |
| type Rep Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms type Rep Alarms = D1 ('MetaData "Alarms" "Amazonka.IoTSiteWise.Types.Alarms" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Alarms'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notificationLambdaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Alarms with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notificationLambdaArn:Alarms', alarms_notificationLambdaArn - The
ARN
of the Lambda function that manages alarm notifications. For more
information, see
Managing alarm notifications
in the IoT Events Developer Guide.
$sel:alarmRoleArn:Alarms', alarms_alarmRoleArn - The
ARN
of the IAM role that allows the alarm to perform actions and access
Amazon Web Services resources and services, such as IoT Events.
alarms_notificationLambdaArn :: Lens' Alarms (Maybe Text) Source #
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.
alarms_alarmRoleArn :: Lens' Alarms Text Source #
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
AssetCompositeModel
data AssetCompositeModel Source #
Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
See: newAssetCompositeModel smart constructor.
Constructors
| AssetCompositeModel' | |
Fields
| |
Instances
newAssetCompositeModel Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssetCompositeModel |
Create a value of AssetCompositeModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssetCompositeModel', assetCompositeModel_description - The description of the composite model.
$sel:name:AssetCompositeModel', assetCompositeModel_name - The name of the composite model.
$sel:type':AssetCompositeModel', assetCompositeModel_type - The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
$sel:properties:AssetCompositeModel', assetCompositeModel_properties - The asset properties that this composite model defines.
assetCompositeModel_description :: Lens' AssetCompositeModel (Maybe Text) Source #
The description of the composite model.
assetCompositeModel_name :: Lens' AssetCompositeModel Text Source #
The name of the composite model.
assetCompositeModel_type :: Lens' AssetCompositeModel Text Source #
The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
assetCompositeModel_properties :: Lens' AssetCompositeModel [AssetProperty] Source #
The asset properties that this composite model defines.
AssetErrorDetails
data AssetErrorDetails Source #
Contains error details for the requested associate project asset action.
See: newAssetErrorDetails smart constructor.
Constructors
| AssetErrorDetails' | |
Instances
Arguments
| :: Text | |
| -> AssetErrorCode | |
| -> Text | |
| -> AssetErrorDetails |
Create a value of AssetErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assetId:AssetErrorDetails', assetErrorDetails_assetId - The ID of the asset.
$sel:code:AssetErrorDetails', assetErrorDetails_code - The error code.
$sel:message:AssetErrorDetails', assetErrorDetails_message - The error message.
assetErrorDetails_assetId :: Lens' AssetErrorDetails Text Source #
The ID of the asset.
assetErrorDetails_code :: Lens' AssetErrorDetails AssetErrorCode Source #
The error code.
assetErrorDetails_message :: Lens' AssetErrorDetails Text Source #
The error message.
AssetHierarchy
data AssetHierarchy Source #
Describes an asset hierarchy that contains a hierarchy's name and ID.
See: newAssetHierarchy smart constructor.
Constructors
| AssetHierarchy' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AssetHierarchy |
Create a value of AssetHierarchy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AssetHierarchy', assetHierarchy_id - The ID of the hierarchy. This ID is a hierarchyId.
$sel:name:AssetHierarchy', assetHierarchy_name - The hierarchy name provided in the
CreateAssetModel
or
UpdateAssetModel
API operation.
assetHierarchy_id :: Lens' AssetHierarchy (Maybe Text) Source #
The ID of the hierarchy. This ID is a hierarchyId.
assetHierarchy_name :: Lens' AssetHierarchy Text Source #
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
AssetHierarchyInfo
data AssetHierarchyInfo Source #
Contains information about a parent asset and a child asset that are related through an asset hierarchy.
See: newAssetHierarchyInfo smart constructor.
Constructors
| AssetHierarchyInfo' | |
Fields
| |
Instances
newAssetHierarchyInfo :: AssetHierarchyInfo Source #
Create a value of AssetHierarchyInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:childAssetId:AssetHierarchyInfo', assetHierarchyInfo_childAssetId - The ID of the child asset in this asset relationship.
$sel:parentAssetId:AssetHierarchyInfo', assetHierarchyInfo_parentAssetId - The ID of the parent asset in this asset relationship.
assetHierarchyInfo_childAssetId :: Lens' AssetHierarchyInfo (Maybe Text) Source #
The ID of the child asset in this asset relationship.
assetHierarchyInfo_parentAssetId :: Lens' AssetHierarchyInfo (Maybe Text) Source #
The ID of the parent asset in this asset relationship.
AssetModelCompositeModel
data AssetModelCompositeModel Source #
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
See: newAssetModelCompositeModel smart constructor.
Constructors
| AssetModelCompositeModel' | |
Fields
| |
Instances
newAssetModelCompositeModel Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssetModelCompositeModel |
Create a value of AssetModelCompositeModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssetModelCompositeModel', assetModelCompositeModel_description - The description of the composite model.
$sel:properties:AssetModelCompositeModel', assetModelCompositeModel_properties - The asset property definitions for this composite model.
$sel:name:AssetModelCompositeModel', assetModelCompositeModel_name - The name of the composite model.
$sel:type':AssetModelCompositeModel', assetModelCompositeModel_type - The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
assetModelCompositeModel_description :: Lens' AssetModelCompositeModel (Maybe Text) Source #
The description of the composite model.
assetModelCompositeModel_properties :: Lens' AssetModelCompositeModel (Maybe [AssetModelProperty]) Source #
The asset property definitions for this composite model.
assetModelCompositeModel_name :: Lens' AssetModelCompositeModel Text Source #
The name of the composite model.
assetModelCompositeModel_type :: Lens' AssetModelCompositeModel Text Source #
The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
AssetModelCompositeModelDefinition
data AssetModelCompositeModelDefinition Source #
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
See: newAssetModelCompositeModelDefinition smart constructor.
Constructors
| AssetModelCompositeModelDefinition' | |
Fields
| |
Instances
newAssetModelCompositeModelDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssetModelCompositeModelDefinition |
Create a value of AssetModelCompositeModelDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssetModelCompositeModelDefinition', assetModelCompositeModelDefinition_description - The description of the composite model.
$sel:properties:AssetModelCompositeModelDefinition', assetModelCompositeModelDefinition_properties - The asset property definitions for this composite model.
$sel:name:AssetModelCompositeModelDefinition', assetModelCompositeModelDefinition_name - The name of the composite model.
$sel:type':AssetModelCompositeModelDefinition', assetModelCompositeModelDefinition_type - The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
assetModelCompositeModelDefinition_description :: Lens' AssetModelCompositeModelDefinition (Maybe Text) Source #
The description of the composite model.
assetModelCompositeModelDefinition_properties :: Lens' AssetModelCompositeModelDefinition (Maybe [AssetModelPropertyDefinition]) Source #
The asset property definitions for this composite model.
assetModelCompositeModelDefinition_name :: Lens' AssetModelCompositeModelDefinition Text Source #
The name of the composite model.
assetModelCompositeModelDefinition_type :: Lens' AssetModelCompositeModelDefinition Text Source #
The type of the composite model. For alarm composite models, this type
is AWS/ALARM.
AssetModelHierarchy
data AssetModelHierarchy Source #
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
See: newAssetModelHierarchy smart constructor.
Constructors
| AssetModelHierarchy' | |
Fields
| |
Instances
newAssetModelHierarchy Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssetModelHierarchy |
Create a value of AssetModelHierarchy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AssetModelHierarchy', assetModelHierarchy_id - The ID of the asset model hierarchy. This ID is a hierarchyId.
$sel:name:AssetModelHierarchy', assetModelHierarchy_name - The name of the asset model hierarchy that you specify by using the
CreateAssetModel
or
UpdateAssetModel
API operation.
$sel:childAssetModelId:AssetModelHierarchy', assetModelHierarchy_childAssetModelId - The ID of the asset model. All assets in this hierarchy must be
instances of the childAssetModelId asset model.
assetModelHierarchy_id :: Lens' AssetModelHierarchy (Maybe Text) Source #
The ID of the asset model hierarchy. This ID is a hierarchyId.
assetModelHierarchy_name :: Lens' AssetModelHierarchy Text Source #
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
assetModelHierarchy_childAssetModelId :: Lens' AssetModelHierarchy Text Source #
The ID of the asset model. All assets in this hierarchy must be
instances of the childAssetModelId asset model.
AssetModelHierarchyDefinition
data AssetModelHierarchyDefinition Source #
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
See: newAssetModelHierarchyDefinition smart constructor.
Constructors
| AssetModelHierarchyDefinition' | |
Fields
| |
Instances
newAssetModelHierarchyDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssetModelHierarchyDefinition |
Create a value of AssetModelHierarchyDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AssetModelHierarchyDefinition', assetModelHierarchyDefinition_name - The name of the asset model hierarchy definition (as specified in the
CreateAssetModel
or
UpdateAssetModel
API operation).
$sel:childAssetModelId:AssetModelHierarchyDefinition', assetModelHierarchyDefinition_childAssetModelId - The ID of an asset model for this hierarchy.
assetModelHierarchyDefinition_name :: Lens' AssetModelHierarchyDefinition Text Source #
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
assetModelHierarchyDefinition_childAssetModelId :: Lens' AssetModelHierarchyDefinition Text Source #
The ID of an asset model for this hierarchy.
AssetModelProperty
data AssetModelProperty Source #
Contains information about an asset model property.
See: newAssetModelProperty smart constructor.
Constructors
| AssetModelProperty' | |
Fields
| |
Instances
newAssetModelProperty Source #
Arguments
| :: Text | |
| -> PropertyDataType | |
| -> PropertyType | |
| -> AssetModelProperty |
Create a value of AssetModelProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataTypeSpec:AssetModelProperty', assetModelProperty_dataTypeSpec - The data type of the structure for this property. This parameter exists
on properties that have the STRUCT data type.
$sel:id:AssetModelProperty', assetModelProperty_id - The ID of the asset model property.
$sel:unit:AssetModelProperty', assetModelProperty_unit - The unit of the asset model property, such as Newtons or RPM.
$sel:name:AssetModelProperty', assetModelProperty_name - The name of the asset model property.
$sel:dataType:AssetModelProperty', assetModelProperty_dataType - The data type of the asset model property.
$sel:type':AssetModelProperty', assetModelProperty_type - The property type (see PropertyType).
assetModelProperty_dataTypeSpec :: Lens' AssetModelProperty (Maybe Text) Source #
The data type of the structure for this property. This parameter exists
on properties that have the STRUCT data type.
assetModelProperty_id :: Lens' AssetModelProperty (Maybe Text) Source #
The ID of the asset model property.
assetModelProperty_unit :: Lens' AssetModelProperty (Maybe Text) Source #
The unit of the asset model property, such as Newtons or RPM.
assetModelProperty_name :: Lens' AssetModelProperty Text Source #
The name of the asset model property.
assetModelProperty_dataType :: Lens' AssetModelProperty PropertyDataType Source #
The data type of the asset model property.
assetModelProperty_type :: Lens' AssetModelProperty PropertyType Source #
The property type (see PropertyType).
AssetModelPropertyDefinition
data AssetModelPropertyDefinition Source #
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
See: newAssetModelPropertyDefinition smart constructor.
Constructors
| AssetModelPropertyDefinition' | |
Fields
| |
Instances
newAssetModelPropertyDefinition Source #
Arguments
| :: Text | |
| -> PropertyDataType | |
| -> PropertyType | |
| -> AssetModelPropertyDefinition |
Create a value of AssetModelPropertyDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataTypeSpec:AssetModelPropertyDefinition', assetModelPropertyDefinition_dataTypeSpec - The data type of the structure for this property. This parameter is
required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model
in which you define this property. Use AWS/ALARM_STATE for alarm
state in alarm composite models.
$sel:unit:AssetModelPropertyDefinition', assetModelPropertyDefinition_unit - The unit of the property definition, such as Newtons or RPM.
$sel:name:AssetModelPropertyDefinition', assetModelPropertyDefinition_name - The name of the property definition.
$sel:dataType:AssetModelPropertyDefinition', assetModelPropertyDefinition_dataType - The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to
identify the type of the structure for this property.
$sel:type':AssetModelPropertyDefinition', assetModelPropertyDefinition_type - The property definition type (see PropertyType). You can only specify
one type in a property definition.
assetModelPropertyDefinition_dataTypeSpec :: Lens' AssetModelPropertyDefinition (Maybe Text) Source #
The data type of the structure for this property. This parameter is
required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model
in which you define this property. Use AWS/ALARM_STATE for alarm
state in alarm composite models.
assetModelPropertyDefinition_unit :: Lens' AssetModelPropertyDefinition (Maybe Text) Source #
The unit of the property definition, such as Newtons or RPM.
assetModelPropertyDefinition_name :: Lens' AssetModelPropertyDefinition Text Source #
The name of the property definition.
assetModelPropertyDefinition_dataType :: Lens' AssetModelPropertyDefinition PropertyDataType Source #
The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to
identify the type of the structure for this property.
assetModelPropertyDefinition_type :: Lens' AssetModelPropertyDefinition PropertyType Source #
The property definition type (see PropertyType). You can only specify
one type in a property definition.
AssetModelStatus
data AssetModelStatus Source #
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
See: newAssetModelStatus smart constructor.
Constructors
| AssetModelStatus' | |
Fields
| |
Instances
Arguments
| :: AssetModelState | |
| -> AssetModelStatus |
Create a value of AssetModelStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:AssetModelStatus', assetModelStatus_error - Contains associated error information, if any.
$sel:state:AssetModelStatus', assetModelStatus_state - The current state of the asset model.
assetModelStatus_error :: Lens' AssetModelStatus (Maybe ErrorDetails) Source #
Contains associated error information, if any.
assetModelStatus_state :: Lens' AssetModelStatus AssetModelState Source #
The current state of the asset model.
AssetModelSummary
data AssetModelSummary Source #
Contains a summary of an asset model.
See: newAssetModelSummary smart constructor.
Constructors
| AssetModelSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetModelStatus | |
| -> AssetModelSummary |
Create a value of AssetModelSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AssetModelSummary', assetModelSummary_id - The ID of the asset model (used with IoT SiteWise APIs).
$sel:arn:AssetModelSummary', assetModelSummary_arn - The
ARN
of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}$sel:name:AssetModelSummary', assetModelSummary_name - The name of the asset model.
$sel:description:AssetModelSummary', assetModelSummary_description - The asset model description.
$sel:creationDate:AssetModelSummary', assetModelSummary_creationDate - The date the asset model was created, in Unix epoch time.
$sel:lastUpdateDate:AssetModelSummary', assetModelSummary_lastUpdateDate - The date the asset model was last updated, in Unix epoch time.
$sel:status:AssetModelSummary', assetModelSummary_status - The current status of the asset model.
assetModelSummary_id :: Lens' AssetModelSummary Text Source #
The ID of the asset model (used with IoT SiteWise APIs).
assetModelSummary_arn :: Lens' AssetModelSummary Text Source #
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}assetModelSummary_name :: Lens' AssetModelSummary Text Source #
The name of the asset model.
assetModelSummary_description :: Lens' AssetModelSummary Text Source #
The asset model description.
assetModelSummary_creationDate :: Lens' AssetModelSummary UTCTime Source #
The date the asset model was created, in Unix epoch time.
assetModelSummary_lastUpdateDate :: Lens' AssetModelSummary UTCTime Source #
The date the asset model was last updated, in Unix epoch time.
assetModelSummary_status :: Lens' AssetModelSummary AssetModelStatus Source #
The current status of the asset model.
AssetProperty
data AssetProperty Source #
Contains asset property information.
See: newAssetProperty smart constructor.
Constructors
| AssetProperty' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PropertyDataType | |
| -> AssetProperty |
Create a value of AssetProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataTypeSpec:AssetProperty', assetProperty_dataTypeSpec - The data type of the structure for this property. This parameter exists
on properties that have the STRUCT data type.
$sel:notification:AssetProperty', assetProperty_notification - The asset property's notification topic and state. For more
information, see
UpdateAssetProperty.
$sel:alias:AssetProperty', assetProperty_alias - The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
$sel:unit:AssetProperty', assetProperty_unit - The unit (such as Newtons or RPM) of the asset property.
$sel:id:AssetProperty', assetProperty_id - The ID of the asset property.
$sel:name:AssetProperty', assetProperty_name - The name of the property.
$sel:dataType:AssetProperty', assetProperty_dataType - The data type of the asset property.
assetProperty_dataTypeSpec :: Lens' AssetProperty (Maybe Text) Source #
The data type of the structure for this property. This parameter exists
on properties that have the STRUCT data type.
assetProperty_notification :: Lens' AssetProperty (Maybe PropertyNotification) Source #
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
assetProperty_alias :: Lens' AssetProperty (Maybe Text) Source #
The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
assetProperty_unit :: Lens' AssetProperty (Maybe Text) Source #
The unit (such as Newtons or RPM) of the asset property.
assetProperty_id :: Lens' AssetProperty Text Source #
The ID of the asset property.
assetProperty_name :: Lens' AssetProperty Text Source #
The name of the property.
assetProperty_dataType :: Lens' AssetProperty PropertyDataType Source #
The data type of the asset property.
AssetPropertyValue
data AssetPropertyValue Source #
Contains asset property value information.
See: newAssetPropertyValue smart constructor.
Constructors
| AssetPropertyValue' | |
Instances
newAssetPropertyValue Source #
Arguments
| :: Variant | |
| -> TimeInNanos | |
| -> AssetPropertyValue |
Create a value of AssetPropertyValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:quality:AssetPropertyValue', assetPropertyValue_quality - The quality of the asset property value.
$sel:value:AssetPropertyValue', assetPropertyValue_value - The value of the asset property (see Variant).
$sel:timestamp:AssetPropertyValue', assetPropertyValue_timestamp - The timestamp of the asset property value.
assetPropertyValue_quality :: Lens' AssetPropertyValue (Maybe Quality) Source #
The quality of the asset property value.
assetPropertyValue_value :: Lens' AssetPropertyValue Variant Source #
The value of the asset property (see Variant).
assetPropertyValue_timestamp :: Lens' AssetPropertyValue TimeInNanos Source #
The timestamp of the asset property value.
AssetRelationshipSummary
data AssetRelationshipSummary Source #
Contains information about assets that are related to one another.
See: newAssetRelationshipSummary smart constructor.
Constructors
| AssetRelationshipSummary' | |
Fields
| |
Instances
newAssetRelationshipSummary Source #
Arguments
| :: AssetRelationshipType | |
| -> AssetRelationshipSummary |
Create a value of AssetRelationshipSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hierarchyInfo:AssetRelationshipSummary', assetRelationshipSummary_hierarchyInfo - The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY.
$sel:relationshipType:AssetRelationshipSummary', assetRelationshipSummary_relationshipType - The relationship type of the assets in this relationship. This value is
one of the following:
HIERARCHY– The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes thehierarchyInfoobject.
assetRelationshipSummary_hierarchyInfo :: Lens' AssetRelationshipSummary (Maybe AssetHierarchyInfo) Source #
The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY.
assetRelationshipSummary_relationshipType :: Lens' AssetRelationshipSummary AssetRelationshipType Source #
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY– The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes thehierarchyInfoobject.
AssetStatus
data AssetStatus Source #
Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide.
See: newAssetStatus smart constructor.
Constructors
| AssetStatus' | |
Fields
| |
Instances
Arguments
| :: AssetState | |
| -> AssetStatus |
Create a value of AssetStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:AssetStatus', assetStatus_error - Contains associated error information, if any.
$sel:state:AssetStatus', assetStatus_state - The current status of the asset.
assetStatus_error :: Lens' AssetStatus (Maybe ErrorDetails) Source #
Contains associated error information, if any.
assetStatus_state :: Lens' AssetStatus AssetState Source #
The current status of the asset.
AssetSummary
data AssetSummary Source #
Contains a summary of an asset.
See: newAssetSummary smart constructor.
Constructors
| AssetSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetStatus | |
| -> AssetSummary |
Create a value of AssetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AssetSummary', assetSummary_id - The ID of the asset.
$sel:arn:AssetSummary', assetSummary_arn - The
ARN
of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}$sel:name:AssetSummary', assetSummary_name - The name of the asset.
$sel:assetModelId:AssetSummary', assetSummary_assetModelId - The ID of the asset model used to create this asset.
$sel:creationDate:AssetSummary', assetSummary_creationDate - The date the asset was created, in Unix epoch time.
$sel:lastUpdateDate:AssetSummary', assetSummary_lastUpdateDate - The date the asset was last updated, in Unix epoch time.
$sel:status:AssetSummary', assetSummary_status - The current status of the asset.
$sel:hierarchies:AssetSummary', assetSummary_hierarchies - A list of asset hierarchies that each contain a hierarchyId. A
hierarchy specifies allowed parent/child asset relationships.
assetSummary_id :: Lens' AssetSummary Text Source #
The ID of the asset.
assetSummary_arn :: Lens' AssetSummary Text Source #
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}assetSummary_name :: Lens' AssetSummary Text Source #
The name of the asset.
assetSummary_assetModelId :: Lens' AssetSummary Text Source #
The ID of the asset model used to create this asset.
assetSummary_creationDate :: Lens' AssetSummary UTCTime Source #
The date the asset was created, in Unix epoch time.
assetSummary_lastUpdateDate :: Lens' AssetSummary UTCTime Source #
The date the asset was last updated, in Unix epoch time.
assetSummary_status :: Lens' AssetSummary AssetStatus Source #
The current status of the asset.
assetSummary_hierarchies :: Lens' AssetSummary [AssetHierarchy] Source #
A list of asset hierarchies that each contain a hierarchyId. A
hierarchy specifies allowed parent/child asset relationships.
AssociatedAssetsSummary
data AssociatedAssetsSummary Source #
Contains a summary of an associated asset.
See: newAssociatedAssetsSummary smart constructor.
Constructors
| AssociatedAssetsSummary' | |
Fields
| |
Instances
newAssociatedAssetsSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetStatus | |
| -> AssociatedAssetsSummary |
Create a value of AssociatedAssetsSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AssociatedAssetsSummary', associatedAssetsSummary_id - The ID of the asset.
$sel:arn:AssociatedAssetsSummary', associatedAssetsSummary_arn - The
ARN
of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}$sel:name:AssociatedAssetsSummary', associatedAssetsSummary_name - The name of the asset.
$sel:assetModelId:AssociatedAssetsSummary', associatedAssetsSummary_assetModelId - The ID of the asset model used to create the asset.
$sel:creationDate:AssociatedAssetsSummary', associatedAssetsSummary_creationDate - The date the asset was created, in Unix epoch time.
$sel:lastUpdateDate:AssociatedAssetsSummary', associatedAssetsSummary_lastUpdateDate - The date the asset was last updated, in Unix epoch time.
$sel:status:AssociatedAssetsSummary', associatedAssetsSummary_status - The current status of the asset.
$sel:hierarchies:AssociatedAssetsSummary', associatedAssetsSummary_hierarchies - A list of asset hierarchies that each contain a hierarchyId. A
hierarchy specifies allowed parent/child asset relationships.
associatedAssetsSummary_id :: Lens' AssociatedAssetsSummary Text Source #
The ID of the asset.
associatedAssetsSummary_arn :: Lens' AssociatedAssetsSummary Text Source #
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}associatedAssetsSummary_name :: Lens' AssociatedAssetsSummary Text Source #
The name of the asset.
associatedAssetsSummary_assetModelId :: Lens' AssociatedAssetsSummary Text Source #
The ID of the asset model used to create the asset.
associatedAssetsSummary_creationDate :: Lens' AssociatedAssetsSummary UTCTime Source #
The date the asset was created, in Unix epoch time.
associatedAssetsSummary_lastUpdateDate :: Lens' AssociatedAssetsSummary UTCTime Source #
The date the asset was last updated, in Unix epoch time.
associatedAssetsSummary_status :: Lens' AssociatedAssetsSummary AssetStatus Source #
The current status of the asset.
associatedAssetsSummary_hierarchies :: Lens' AssociatedAssetsSummary [AssetHierarchy] Source #
A list of asset hierarchies that each contain a hierarchyId. A
hierarchy specifies allowed parent/child asset relationships.
Attribute
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.
See: newAttribute smart constructor.
Constructors
| Attribute' | |
Fields
| |
Instances
| Eq Attribute Source # | |
| Read Attribute Source # | |
| Show Attribute Source # | |
| Generic Attribute Source # | |
| NFData Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| Hashable Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| ToJSON Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| FromJSON Attribute Source # | |
| type Rep Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute type Rep Attribute = D1 ('MetaData "Attribute" "Amazonka.IoTSiteWise.Types.Attribute" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Attribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newAttribute :: Attribute Source #
Create a value of Attribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:Attribute', attribute_defaultValue - The default value of the asset model property attribute. All assets that
you create from the asset model contain this attribute value. You can
update an attribute's value after you create an asset. For more
information, see
Updating attribute values
in the IoT SiteWise User Guide.
attribute_defaultValue :: Lens' Attribute (Maybe Text) Source #
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
BatchPutAssetPropertyError
data BatchPutAssetPropertyError Source #
Contains error information from updating a batch of asset property values.
See: newBatchPutAssetPropertyError smart constructor.
Constructors
| BatchPutAssetPropertyError' | |
Fields
| |
Instances
newBatchPutAssetPropertyError Source #
Arguments
| :: BatchPutAssetPropertyValueErrorCode | |
| -> Text | |
| -> BatchPutAssetPropertyError |
Create a value of BatchPutAssetPropertyError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchPutAssetPropertyError', batchPutAssetPropertyError_errorCode - The error code.
$sel:errorMessage:BatchPutAssetPropertyError', batchPutAssetPropertyError_errorMessage - The associated error message.
$sel:timestamps:BatchPutAssetPropertyError', batchPutAssetPropertyError_timestamps - A list of timestamps for each error, if any.
batchPutAssetPropertyError_errorCode :: Lens' BatchPutAssetPropertyError BatchPutAssetPropertyValueErrorCode Source #
The error code.
batchPutAssetPropertyError_errorMessage :: Lens' BatchPutAssetPropertyError Text Source #
The associated error message.
batchPutAssetPropertyError_timestamps :: Lens' BatchPutAssetPropertyError [TimeInNanos] Source #
A list of timestamps for each error, if any.
BatchPutAssetPropertyErrorEntry
data BatchPutAssetPropertyErrorEntry Source #
Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
See: newBatchPutAssetPropertyErrorEntry smart constructor.
Constructors
| BatchPutAssetPropertyErrorEntry' | |
Fields
| |
Instances
newBatchPutAssetPropertyErrorEntry Source #
Create a value of BatchPutAssetPropertyErrorEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entryId:BatchPutAssetPropertyErrorEntry', batchPutAssetPropertyErrorEntry_entryId - The ID of the failed entry.
$sel:errors:BatchPutAssetPropertyErrorEntry', batchPutAssetPropertyErrorEntry_errors - The list of update property value errors.
batchPutAssetPropertyErrorEntry_entryId :: Lens' BatchPutAssetPropertyErrorEntry Text Source #
The ID of the failed entry.
batchPutAssetPropertyErrorEntry_errors :: Lens' BatchPutAssetPropertyErrorEntry [BatchPutAssetPropertyError] Source #
The list of update property value errors.
CompositeModelProperty
data CompositeModelProperty Source #
Contains information about a composite model property on an asset.
See: newCompositeModelProperty smart constructor.
Constructors
| CompositeModelProperty' | |
Instances
newCompositeModelProperty Source #
Arguments
| :: Text | |
| -> Text | |
| -> Property | |
| -> CompositeModelProperty |
Create a value of CompositeModelProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:CompositeModelProperty', compositeModelProperty_name - The name of the property.
$sel:type':CompositeModelProperty', compositeModelProperty_type - The type of the composite model that defines this property.
$sel:assetProperty:CompositeModelProperty', compositeModelProperty_assetProperty - Undocumented member.
compositeModelProperty_name :: Lens' CompositeModelProperty Text Source #
The name of the property.
compositeModelProperty_type :: Lens' CompositeModelProperty Text Source #
The type of the composite model that defines this property.
compositeModelProperty_assetProperty :: Lens' CompositeModelProperty Property Source #
Undocumented member.
ConfigurationErrorDetails
data ConfigurationErrorDetails Source #
Contains the details of an IoT SiteWise configuration error.
See: newConfigurationErrorDetails smart constructor.
Constructors
| ConfigurationErrorDetails' | |
Instances
newConfigurationErrorDetails Source #
Arguments
| :: ErrorCode | |
| -> Text | |
| -> ConfigurationErrorDetails |
Create a value of ConfigurationErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:ConfigurationErrorDetails', configurationErrorDetails_code - The error code.
$sel:message:ConfigurationErrorDetails', configurationErrorDetails_message - The error message.
configurationErrorDetails_code :: Lens' ConfigurationErrorDetails ErrorCode Source #
The error code.
configurationErrorDetails_message :: Lens' ConfigurationErrorDetails Text Source #
The error message.
ConfigurationStatus
data ConfigurationStatus Source #
Contains current status information for the configuration.
See: newConfigurationStatus smart constructor.
Constructors
| ConfigurationStatus' | |
Fields
| |
Instances
newConfigurationStatus Source #
Create a value of ConfigurationStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:ConfigurationStatus', configurationStatus_error - Contains associated error information, if any.
$sel:state:ConfigurationStatus', configurationStatus_state - The current state of the configuration.
configurationStatus_error :: Lens' ConfigurationStatus (Maybe ConfigurationErrorDetails) Source #
Contains associated error information, if any.
configurationStatus_state :: Lens' ConfigurationStatus ConfigurationState Source #
The current state of the configuration.
CustomerManagedS3Storage
data CustomerManagedS3Storage Source #
Contains information about a customer managed Amazon S3 bucket.
See: newCustomerManagedS3Storage smart constructor.
Constructors
| CustomerManagedS3Storage' | |
Fields
| |
Instances
newCustomerManagedS3Storage Source #
Arguments
| :: Text | |
| -> Text | |
| -> CustomerManagedS3Storage |
Create a value of CustomerManagedS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3ResourceArn:CustomerManagedS3Storage', customerManagedS3Storage_s3ResourceArn - The
ARN
of the Amazon S3 object. For more information about how to find the ARN
for an Amazon S3 object, see
Amazon S3 resources
in the Amazon Simple Storage Service User Guide.
$sel:roleArn:CustomerManagedS3Storage', customerManagedS3Storage_roleArn - The
ARN
of the Identity and Access Management role that allows IoT SiteWise to
send data to Amazon S3.
customerManagedS3Storage_s3ResourceArn :: Lens' CustomerManagedS3Storage Text Source #
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
customerManagedS3Storage_roleArn :: Lens' CustomerManagedS3Storage Text Source #
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
DashboardSummary
data DashboardSummary Source #
Contains a dashboard summary.
See: newDashboardSummary smart constructor.
Constructors
| DashboardSummary' | |
Fields
| |
Instances
Create a value of DashboardSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdateDate:DashboardSummary', dashboardSummary_lastUpdateDate - The date the dashboard was last updated, in Unix epoch time.
$sel:creationDate:DashboardSummary', dashboardSummary_creationDate - The date the dashboard was created, in Unix epoch time.
$sel:description:DashboardSummary', dashboardSummary_description - The dashboard's description.
$sel:id:DashboardSummary', dashboardSummary_id - The ID of the dashboard.
$sel:name:DashboardSummary', dashboardSummary_name - The name of the dashboard
dashboardSummary_lastUpdateDate :: Lens' DashboardSummary (Maybe UTCTime) Source #
The date the dashboard was last updated, in Unix epoch time.
dashboardSummary_creationDate :: Lens' DashboardSummary (Maybe UTCTime) Source #
The date the dashboard was created, in Unix epoch time.
dashboardSummary_description :: Lens' DashboardSummary (Maybe Text) Source #
The dashboard's description.
dashboardSummary_id :: Lens' DashboardSummary Text Source #
The ID of the dashboard.
dashboardSummary_name :: Lens' DashboardSummary Text Source #
The name of the dashboard
DetailedError
data DetailedError Source #
Contains detailed error information.
See: newDetailedError smart constructor.
Constructors
| DetailedError' | |
Fields
| |
Instances
Arguments
| :: DetailedErrorCode | |
| -> Text | |
| -> DetailedError |
Create a value of DetailedError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:DetailedError', detailedError_code - The error code.
$sel:message:DetailedError', detailedError_message - The error message.
detailedError_code :: Lens' DetailedError DetailedErrorCode Source #
The error code.
detailedError_message :: Lens' DetailedError Text Source #
The error message.
ErrorDetails
data ErrorDetails Source #
Contains the details of an IoT SiteWise error.
See: newErrorDetails smart constructor.
Constructors
| ErrorDetails' | |
Instances
Create a value of ErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:ErrorDetails', errorDetails_details - A list of detailed errors.
$sel:code:ErrorDetails', errorDetails_code - The error code.
$sel:message:ErrorDetails', errorDetails_message - The error message.
errorDetails_details :: Lens' ErrorDetails (Maybe [DetailedError]) Source #
A list of detailed errors.
errorDetails_code :: Lens' ErrorDetails ErrorCode Source #
The error code.
errorDetails_message :: Lens' ErrorDetails Text Source #
The error message.
ExpressionVariable
data ExpressionVariable Source #
Contains expression variable information.
See: newExpressionVariable smart constructor.
Constructors
| ExpressionVariable' | |
Fields
| |
Instances
newExpressionVariable Source #
Arguments
| :: Text | |
| -> VariableValue | |
| -> ExpressionVariable |
Create a value of ExpressionVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ExpressionVariable', expressionVariable_name - The friendly name of the variable to be used in the expression.
$sel:value:ExpressionVariable', expressionVariable_value - The variable that identifies an asset property from which to use values.
expressionVariable_name :: Lens' ExpressionVariable Text Source #
The friendly name of the variable to be used in the expression.
expressionVariable_value :: Lens' ExpressionVariable VariableValue Source #
The variable that identifies an asset property from which to use values.
ForwardingConfig
data ForwardingConfig Source #
The forwarding configuration for a given property.
See: newForwardingConfig smart constructor.
Constructors
| ForwardingConfig' | |
Fields
| |
Instances
Create a value of ForwardingConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:ForwardingConfig', forwardingConfig_state - The forwarding state for the given property.
forwardingConfig_state :: Lens' ForwardingConfig ForwardingConfigState Source #
The forwarding state for the given property.
GatewayCapabilitySummary
data GatewayCapabilitySummary Source #
Contains a summary of a gateway capability configuration.
See: newGatewayCapabilitySummary smart constructor.
Constructors
| GatewayCapabilitySummary' | |
Fields
| |
Instances
newGatewayCapabilitySummary Source #
Arguments
| :: Text | |
| -> CapabilitySyncStatus | |
| -> GatewayCapabilitySummary |
Create a value of GatewayCapabilitySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilityNamespace:GatewayCapabilitySummary', gatewayCapabilitySummary_capabilityNamespace - The namespace of the capability configuration. For example, if you
configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
capability configuration has the namespace
iotsitewise:opcuacollector:version, where version is a number such
as 1.
$sel:capabilitySyncStatus:GatewayCapabilitySummary', gatewayCapabilitySummary_capabilitySyncStatus - The synchronization status of the capability configuration. The sync
status can be one of the following:
IN_SYNC– The gateway is running the capability configuration.OUT_OF_SYNC– The gateway hasn't received the capability configuration.SYNC_FAILED– The gateway rejected the capability configuration.
gatewayCapabilitySummary_capabilityNamespace :: Lens' GatewayCapabilitySummary Text Source #
The namespace of the capability configuration. For example, if you
configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
capability configuration has the namespace
iotsitewise:opcuacollector:version, where version is a number such
as 1.
gatewayCapabilitySummary_capabilitySyncStatus :: Lens' GatewayCapabilitySummary CapabilitySyncStatus Source #
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC– The gateway is running the capability configuration.OUT_OF_SYNC– The gateway hasn't received the capability configuration.SYNC_FAILED– The gateway rejected the capability configuration.
GatewayPlatform
data GatewayPlatform Source #
Contains a gateway's platform information.
See: newGatewayPlatform smart constructor.
Constructors
| GatewayPlatform' | |
Fields
| |
Instances
newGatewayPlatform :: GatewayPlatform Source #
Create a value of GatewayPlatform with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:greengrass:GatewayPlatform', gatewayPlatform_greengrass - A gateway that runs on IoT Greengrass.
$sel:greengrassV2:GatewayPlatform', gatewayPlatform_greengrassV2 - A gateway that runs on IoT Greengrass V2.
gatewayPlatform_greengrass :: Lens' GatewayPlatform (Maybe Greengrass) Source #
A gateway that runs on IoT Greengrass.
gatewayPlatform_greengrassV2 :: Lens' GatewayPlatform (Maybe GreengrassV2) Source #
A gateway that runs on IoT Greengrass V2.
GatewaySummary
data GatewaySummary Source #
Contains a summary of a gateway.
See: newGatewaySummary smart constructor.
Constructors
| GatewaySummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> GatewaySummary |
Create a value of GatewaySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayPlatform:GatewaySummary', gatewaySummary_gatewayPlatform - Undocumented member.
$sel:gatewayCapabilitySummaries:GatewaySummary', gatewaySummary_gatewayCapabilitySummaries - A list of gateway capability summaries that each contain a namespace and
status. Each gateway capability defines data sources for the gateway. To
retrieve a capability configuration's definition, use
DescribeGatewayCapabilityConfiguration.
$sel:gatewayId:GatewaySummary', gatewaySummary_gatewayId - The ID of the gateway device.
$sel:gatewayName:GatewaySummary', gatewaySummary_gatewayName - The name of the asset.
$sel:creationDate:GatewaySummary', gatewaySummary_creationDate - The date the gateway was created, in Unix epoch time.
$sel:lastUpdateDate:GatewaySummary', gatewaySummary_lastUpdateDate - The date the gateway was last updated, in Unix epoch time.
gatewaySummary_gatewayPlatform :: Lens' GatewaySummary (Maybe GatewayPlatform) Source #
Undocumented member.
gatewaySummary_gatewayCapabilitySummaries :: Lens' GatewaySummary (Maybe [GatewayCapabilitySummary]) Source #
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
gatewaySummary_gatewayId :: Lens' GatewaySummary Text Source #
The ID of the gateway device.
gatewaySummary_gatewayName :: Lens' GatewaySummary Text Source #
The name of the asset.
gatewaySummary_creationDate :: Lens' GatewaySummary UTCTime Source #
The date the gateway was created, in Unix epoch time.
gatewaySummary_lastUpdateDate :: Lens' GatewaySummary UTCTime Source #
The date the gateway was last updated, in Unix epoch time.
Greengrass
data Greengrass Source #
Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
See: newGreengrass smart constructor.
Constructors
| Greengrass' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Greengrass |
Create a value of Greengrass with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupArn:Greengrass', greengrass_groupArn - The
ARN
of the Greengrass group. For more information about how to find a
group's ARN, see
ListGroups
and
GetGroup
in the IoT Greengrass API Reference.
greengrass_groupArn :: Lens' Greengrass Text Source #
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference.
GreengrassV2
data GreengrassV2 Source #
Contains details for a gateway that runs on IoT Greengrass V2. To create
a gateway that runs on IoT Greengrass V2, you must deploy the IoT
SiteWise Edge component to your gateway device. Your
Greengrass device role
must use the AWSIoTSiteWiseEdgeAccess policy. For more information,
see
Using IoT SiteWise at the edge
in the IoT SiteWise User Guide.
See: newGreengrassV2 smart constructor.
Constructors
| GreengrassV2' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GreengrassV2 |
Create a value of GreengrassV2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:coreDeviceThingName:GreengrassV2', greengrassV2_coreDeviceThingName - The name of the IoT thing for your IoT Greengrass V2 core device.
greengrassV2_coreDeviceThingName :: Lens' GreengrassV2 Text Source #
The name of the IoT thing for your IoT Greengrass V2 core device.
GroupIdentity
data GroupIdentity Source #
Contains information for a group identity in an access policy.
See: newGroupIdentity smart constructor.
Constructors
| GroupIdentity' | |
Instances
Arguments
| :: Text | |
| -> GroupIdentity |
Create a value of GroupIdentity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:GroupIdentity', groupIdentity_id - The Amazon Web Services SSO ID of the group.
groupIdentity_id :: Lens' GroupIdentity Text Source #
The Amazon Web Services SSO ID of the group.
IAMRoleIdentity
data IAMRoleIdentity Source #
Contains information about an Identity and Access Management role. For more information, see IAM roles in the IAM User Guide.
See: newIAMRoleIdentity smart constructor.
Constructors
| IAMRoleIdentity' | |
Instances
Arguments
| :: Text | |
| -> IAMRoleIdentity |
Create a value of IAMRoleIdentity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:IAMRoleIdentity', iAMRoleIdentity_arn - The ARN of the IAM role. For more information, see
IAM ARNs
in the IAM User Guide.
iAMRoleIdentity_arn :: Lens' IAMRoleIdentity Text Source #
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide.
IAMUserIdentity
data IAMUserIdentity Source #
Contains information about an Identity and Access Management user.
See: newIAMUserIdentity smart constructor.
Constructors
| IAMUserIdentity' | |
Instances
Arguments
| :: Text | |
| -> IAMUserIdentity |
Create a value of IAMUserIdentity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:IAMUserIdentity', iAMUserIdentity_arn - The ARN of the IAM user. For more information, see
IAM ARNs
in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity
include an empty arn. You can delete the access policy for the IAM
user that no longer exists.
iAMUserIdentity_arn :: Lens' IAMUserIdentity Text Source #
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity
include an empty arn. You can delete the access policy for the IAM
user that no longer exists.
Identity
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve Amazon Web Services SSO identity IDs. You can find the Amazon Web Services SSO identity IDs in the URL of user and group pages in the Amazon Web Services SSO console.
See: newIdentity smart constructor.
Constructors
| Identity' | |
Fields
| |
Instances
newIdentity :: Identity Source #
Create a value of Identity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamUser:Identity', identity_iamUser - An IAM user identity.
$sel:group':Identity', identity_group - An Amazon Web Services SSO group identity.
$sel:user:Identity', identity_user - An Amazon Web Services SSO user identity.
$sel:iamRole:Identity', identity_iamRole - An IAM role identity.
identity_iamUser :: Lens' Identity (Maybe IAMUserIdentity) Source #
An IAM user identity.
identity_group :: Lens' Identity (Maybe GroupIdentity) Source #
An Amazon Web Services SSO group identity.
identity_user :: Lens' Identity (Maybe UserIdentity) Source #
An Amazon Web Services SSO user identity.
identity_iamRole :: Lens' Identity (Maybe IAMRoleIdentity) Source #
An IAM role identity.
Image
Contains an image that is one of the following:
- An image file. Choose this option to upload a new image.
- The ID of an existing image. Choose this option to keep an existing image.
See: newImage smart constructor.
Constructors
| Image' | |
Instances
| Eq Image Source # | |
| Read Image Source # | |
| Show Image Source # | |
| Generic Image Source # | |
| NFData Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image | |
| Hashable Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image | |
| ToJSON Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image | |
| type Rep Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image type Rep Image = D1 ('MetaData "Image" "Amazonka.IoTSiteWise.Types.Image" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Image'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageFile)))) | |
Create a value of Image with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Image', image_id - The ID of an existing image. Specify this parameter to keep an existing
image.
$sel:file:Image', image_file - Undocumented member.
image_id :: Lens' Image (Maybe Text) Source #
The ID of an existing image. Specify this parameter to keep an existing image.
ImageFile
Contains an image file.
See: newImageFile smart constructor.
Constructors
| ImageFile' | |
Fields
| |
Instances
| Eq ImageFile Source # | |
| Read ImageFile Source # | |
| Show ImageFile Source # | |
| Generic ImageFile Source # | |
| NFData ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile | |
| Hashable ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile | |
| ToJSON ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile | |
| type Rep ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile type Rep ImageFile = D1 ('MetaData "ImageFile" "Amazonka.IoTSiteWise.Types.ImageFile" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "ImageFile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageFileType))) | |
Create a value of ImageFile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':ImageFile', imageFile_data - The image file contents, represented as a base64-encoded string. The
file size must be less than 1 MB.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:type':ImageFile', imageFile_type - The file type of the image.
imageFile_data :: Lens' ImageFile ByteString Source #
The image file contents, represented as a base64-encoded string. The
file size must be less than 1 MB.--
-- 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.
imageFile_type :: Lens' ImageFile ImageFileType Source #
The file type of the image.
ImageLocation
data ImageLocation Source #
Contains an image that is uploaded to IoT SiteWise and available at a URL.
See: newImageLocation smart constructor.
Constructors
| ImageLocation' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ImageLocation |
Create a value of ImageLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:ImageLocation', imageLocation_id - The ID of the image.
$sel:url:ImageLocation', imageLocation_url - The URL where the image is available. The URL is valid for 15 minutes so
that you can view and download the image
imageLocation_id :: Lens' ImageLocation Text Source #
The ID of the image.
imageLocation_url :: Lens' ImageLocation Text Source #
The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
InterpolatedAssetPropertyValue
data InterpolatedAssetPropertyValue Source #
Contains information about an interpolated asset property value.
See: newInterpolatedAssetPropertyValue smart constructor.
Constructors
| InterpolatedAssetPropertyValue' | |
Fields
| |
Instances
newInterpolatedAssetPropertyValue Source #
Arguments
| :: TimeInNanos | |
| -> Variant | |
| -> InterpolatedAssetPropertyValue |
Create a value of InterpolatedAssetPropertyValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestamp:InterpolatedAssetPropertyValue', interpolatedAssetPropertyValue_timestamp - Undocumented member.
$sel:value:InterpolatedAssetPropertyValue', interpolatedAssetPropertyValue_value - Undocumented member.
interpolatedAssetPropertyValue_timestamp :: Lens' InterpolatedAssetPropertyValue TimeInNanos Source #
Undocumented member.
interpolatedAssetPropertyValue_value :: Lens' InterpolatedAssetPropertyValue Variant Source #
Undocumented member.
LoggingOptions
data LoggingOptions Source #
Contains logging options.
See: newLoggingOptions smart constructor.
Constructors
| LoggingOptions' | |
Fields
| |
Instances
Arguments
| :: LoggingLevel | |
| -> LoggingOptions |
Create a value of LoggingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:level:LoggingOptions', loggingOptions_level - The IoT SiteWise logging verbosity level.
loggingOptions_level :: Lens' LoggingOptions LoggingLevel Source #
The IoT SiteWise logging verbosity level.
Measurement
data Measurement Source #
Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide.
See: newMeasurement smart constructor.
Constructors
| Measurement' | |
Fields
| |
Instances
newMeasurement :: Measurement Source #
Create a value of Measurement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:processingConfig:Measurement', measurement_processingConfig - The processing configuration for the given measurement property. You can
configure measurements to be kept at the edge or forwarded to the Amazon
Web Services Cloud. By default, measurements are forwarded to the cloud.
measurement_processingConfig :: Lens' Measurement (Maybe MeasurementProcessingConfig) Source #
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
MeasurementProcessingConfig
data MeasurementProcessingConfig Source #
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
See: newMeasurementProcessingConfig smart constructor.
Constructors
| MeasurementProcessingConfig' | |
Fields
| |
Instances
newMeasurementProcessingConfig Source #
Arguments
| :: ForwardingConfig | |
| -> MeasurementProcessingConfig |
Create a value of MeasurementProcessingConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forwardingConfig:MeasurementProcessingConfig', measurementProcessingConfig_forwardingConfig - The forwarding configuration for the given measurement property.
measurementProcessingConfig_forwardingConfig :: Lens' MeasurementProcessingConfig ForwardingConfig Source #
The forwarding configuration for the given measurement property.
Metric
Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).
The maximum number of dependent/cascading variables used in any one
metric calculation is 10. Therefore, a root metric can have up to 10
cascading metrics in its computational dependency tree. Additionally, a
metric can only have a data type of DOUBLE and consume properties with
data types of INTEGER or DOUBLE.
For more information, see Metrics in the IoT SiteWise User Guide.
See: newMetric smart constructor.
Constructors
| Metric' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MetricWindow | |
| -> Metric |
Create a value of Metric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:processingConfig:Metric', metric_processingConfig - The processing configuration for the given metric property. You can
configure metrics to be computed at the edge or in the Amazon Web
Services Cloud. By default, metrics are forwarded to the cloud.
$sel:expression:Metric', metric_expression - The mathematical expression that defines the metric aggregation
function. You can specify up to 10 variables per expression. You can
specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
$sel:variables:Metric', metric_variables - The list of variables used in the expression.
$sel:window:Metric', metric_window - The window (time interval) over which IoT SiteWise computes the
metric's aggregation expression. IoT SiteWise computes one data point
per window.
metric_processingConfig :: Lens' Metric (Maybe MetricProcessingConfig) Source #
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
metric_expression :: Lens' Metric Text Source #
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
metric_variables :: Lens' Metric [ExpressionVariable] Source #
The list of variables used in the expression.
metric_window :: Lens' Metric MetricWindow Source #
The window (time interval) over which IoT SiteWise computes the
metric's aggregation expression. IoT SiteWise computes one data point
per window.
MetricProcessingConfig
data MetricProcessingConfig Source #
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
See: newMetricProcessingConfig smart constructor.
Constructors
| MetricProcessingConfig' | |
Fields
| |
Instances
newMetricProcessingConfig Source #
Create a value of MetricProcessingConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeLocation:MetricProcessingConfig', metricProcessingConfig_computeLocation - The compute location for the given metric property.
metricProcessingConfig_computeLocation :: Lens' MetricProcessingConfig ComputeLocation Source #
The compute location for the given metric property.
MetricWindow
data MetricWindow Source #
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
See: newMetricWindow smart constructor.
Constructors
| MetricWindow' | |
Fields
| |
Instances
newMetricWindow :: MetricWindow Source #
Create a value of MetricWindow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tumbling:MetricWindow', metricWindow_tumbling - The tumbling time interval window.
metricWindow_tumbling :: Lens' MetricWindow (Maybe TumblingWindow) Source #
The tumbling time interval window.
MonitorErrorDetails
data MonitorErrorDetails Source #
Contains IoT SiteWise Monitor error details.
See: newMonitorErrorDetails smart constructor.
Constructors
| MonitorErrorDetails' | |
Instances
newMonitorErrorDetails :: MonitorErrorDetails Source #
Create a value of MonitorErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:MonitorErrorDetails', monitorErrorDetails_code - The error code.
$sel:message:MonitorErrorDetails', monitorErrorDetails_message - The error message.
monitorErrorDetails_code :: Lens' MonitorErrorDetails (Maybe MonitorErrorCode) Source #
The error code.
monitorErrorDetails_message :: Lens' MonitorErrorDetails (Maybe Text) Source #
The error message.
MultiLayerStorage
data MultiLayerStorage Source #
Contains information about the storage destination.
See: newMultiLayerStorage smart constructor.
Constructors
| MultiLayerStorage' | |
Fields
| |
Instances
Arguments
| :: CustomerManagedS3Storage | |
| -> MultiLayerStorage |
Create a value of MultiLayerStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customerManagedS3Storage:MultiLayerStorage', multiLayerStorage_customerManagedS3Storage - Contains information about a customer managed Amazon S3 bucket.
multiLayerStorage_customerManagedS3Storage :: Lens' MultiLayerStorage CustomerManagedS3Storage Source #
Contains information about a customer managed Amazon S3 bucket.
PortalResource
data PortalResource Source #
Identifies an IoT SiteWise Monitor portal.
See: newPortalResource smart constructor.
Constructors
| PortalResource' | |
Instances
Arguments
| :: Text | |
| -> PortalResource |
Create a value of PortalResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:PortalResource', portalResource_id - The ID of the portal.
portalResource_id :: Lens' PortalResource Text Source #
The ID of the portal.
PortalStatus
data PortalStatus Source #
Contains information about the current status of a portal.
See: newPortalStatus smart constructor.
Constructors
| PortalStatus' | |
Fields
| |
Instances
Arguments
| :: PortalState | |
| -> PortalStatus |
Create a value of PortalStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:PortalStatus', portalStatus_error - Contains associated error information, if any.
$sel:state:PortalStatus', portalStatus_state - The current state of the portal.
portalStatus_error :: Lens' PortalStatus (Maybe MonitorErrorDetails) Source #
Contains associated error information, if any.
portalStatus_state :: Lens' PortalStatus PortalState Source #
The current state of the portal.
PortalSummary
data PortalSummary Source #
Contains a portal summary.
See: newPortalSummary smart constructor.
Constructors
| PortalSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> PortalStatus | |
| -> PortalSummary |
Create a value of PortalSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdateDate:PortalSummary', portalSummary_lastUpdateDate - The date the portal was last updated, in Unix epoch time.
$sel:creationDate:PortalSummary', portalSummary_creationDate - The date the portal was created, in Unix epoch time.
$sel:description:PortalSummary', portalSummary_description - The portal's description.
$sel:roleArn:PortalSummary', portalSummary_roleArn - The
ARN
of the service role that allows the portal's users to access your IoT
SiteWise resources on your behalf. For more information, see
Using service roles for IoT SiteWise Monitor
in the IoT SiteWise User Guide.
$sel:id:PortalSummary', portalSummary_id - The ID of the portal.
$sel:name:PortalSummary', portalSummary_name - The name of the portal.
$sel:startUrl:PortalSummary', portalSummary_startUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to
access portals that use Amazon Web Services SSO for authentication. For
portals that use IAM for authentication, you must use the IoT SiteWise
console to get a URL that you can use to access the portal.
$sel:status:PortalSummary', portalSummary_status - Undocumented member.
portalSummary_lastUpdateDate :: Lens' PortalSummary (Maybe UTCTime) Source #
The date the portal was last updated, in Unix epoch time.
portalSummary_creationDate :: Lens' PortalSummary (Maybe UTCTime) Source #
The date the portal was created, in Unix epoch time.
portalSummary_description :: Lens' PortalSummary (Maybe Text) Source #
The portal's description.
portalSummary_roleArn :: Lens' PortalSummary (Maybe Text) Source #
The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
portalSummary_id :: Lens' PortalSummary Text Source #
The ID of the portal.
portalSummary_name :: Lens' PortalSummary Text Source #
The name of the portal.
portalSummary_startUrl :: Lens' PortalSummary Text Source #
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
portalSummary_status :: Lens' PortalSummary PortalStatus Source #
Undocumented member.
ProjectResource
data ProjectResource Source #
Identifies a specific IoT SiteWise Monitor project.
See: newProjectResource smart constructor.
Constructors
| ProjectResource' | |
Instances
Arguments
| :: Text | |
| -> ProjectResource |
Create a value of ProjectResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:ProjectResource', projectResource_id - The ID of the project.
projectResource_id :: Lens' ProjectResource Text Source #
The ID of the project.
ProjectSummary
data ProjectSummary Source #
Contains project summary information.
See: newProjectSummary smart constructor.
Constructors
| ProjectSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ProjectSummary |
Create a value of ProjectSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdateDate:ProjectSummary', projectSummary_lastUpdateDate - The date the project was last updated, in Unix epoch time.
$sel:creationDate:ProjectSummary', projectSummary_creationDate - The date the project was created, in Unix epoch time.
$sel:description:ProjectSummary', projectSummary_description - The project's description.
$sel:id:ProjectSummary', projectSummary_id - The ID of the project.
$sel:name:ProjectSummary', projectSummary_name - The name of the project.
projectSummary_lastUpdateDate :: Lens' ProjectSummary (Maybe UTCTime) Source #
The date the project was last updated, in Unix epoch time.
projectSummary_creationDate :: Lens' ProjectSummary (Maybe UTCTime) Source #
The date the project was created, in Unix epoch time.
projectSummary_description :: Lens' ProjectSummary (Maybe Text) Source #
The project's description.
projectSummary_id :: Lens' ProjectSummary Text Source #
The ID of the project.
projectSummary_name :: Lens' ProjectSummary Text Source #
The name of the project.
Property
Contains asset property information.
See: newProperty smart constructor.
Constructors
| Property' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PropertyDataType | |
| -> Property |
Create a value of Property with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notification:Property', property_notification - The asset property's notification topic and state. For more
information, see
UpdateAssetProperty.
$sel:alias:Property', property_alias - The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
$sel:type':Property', property_type - The property type (see PropertyType). A property contains one type.
$sel:unit:Property', property_unit - The unit (such as Newtons or RPM) of the asset property.
$sel:id:Property', property_id - The ID of the asset property.
$sel:name:Property', property_name - The name of the property.
$sel:dataType:Property', property_dataType - The property data type.
property_notification :: Lens' Property (Maybe PropertyNotification) Source #
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
property_alias :: Lens' Property (Maybe Text) Source #
The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
property_type :: Lens' Property (Maybe PropertyType) Source #
The property type (see PropertyType). A property contains one type.
property_unit :: Lens' Property (Maybe Text) Source #
The unit (such as Newtons or RPM) of the asset property.
property_dataType :: Lens' Property PropertyDataType Source #
The property data type.
PropertyNotification
data PropertyNotification Source #
Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
See: newPropertyNotification smart constructor.
Constructors
| PropertyNotification' | |
Fields
| |
Instances
newPropertyNotification Source #
Arguments
| :: Text | |
| -> PropertyNotificationState | |
| -> PropertyNotification |
Create a value of PropertyNotification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topic:PropertyNotification', propertyNotification_topic - The MQTT topic to which IoT SiteWise publishes property value update
notifications.
$sel:state:PropertyNotification', propertyNotification_state - The current notification state.
propertyNotification_topic :: Lens' PropertyNotification Text Source #
The MQTT topic to which IoT SiteWise publishes property value update notifications.
propertyNotification_state :: Lens' PropertyNotification PropertyNotificationState Source #
The current notification state.
PropertyType
data PropertyType Source #
Contains a property type, which can be one of attribute,
measurement, metric, or transform.
See: newPropertyType smart constructor.
Constructors
| PropertyType' | |
Fields
| |
Instances
newPropertyType :: PropertyType Source #
Create a value of PropertyType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attribute:PropertyType', propertyType_attribute - Specifies an asset attribute property. An attribute generally contains
static information, such as the serial number of an
IIoT
wind turbine.
$sel:transform:PropertyType', propertyType_transform - Specifies an asset transform property. A transform contains a
mathematical expression that maps a property's data points from one
form to another, such as a unit conversion from Celsius to Fahrenheit.
$sel:metric:PropertyType', propertyType_metric - Specifies an asset metric property. A metric contains a mathematical
expression that uses aggregate functions to process all input data
points over a time interval and output a single data point, such as to
calculate the average hourly temperature.
$sel:measurement:PropertyType', propertyType_measurement - Specifies an asset measurement property. A measurement represents a
device's raw sensor data stream, such as timestamped temperature values
or timestamped power values.
propertyType_attribute :: Lens' PropertyType (Maybe Attribute) Source #
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
propertyType_transform :: Lens' PropertyType (Maybe Transform) Source #
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
propertyType_metric :: Lens' PropertyType (Maybe Metric) Source #
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
propertyType_measurement :: Lens' PropertyType (Maybe Measurement) Source #
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
PutAssetPropertyValueEntry
data PutAssetPropertyValueEntry Source #
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
See: newPutAssetPropertyValueEntry smart constructor.
Constructors
| PutAssetPropertyValueEntry' | |
Fields
| |
Instances
newPutAssetPropertyValueEntry Source #
Create a value of PutAssetPropertyValueEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:propertyAlias:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_propertyAlias - The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
$sel:propertyId:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_propertyId - The ID of the asset property for this entry.
$sel:assetId:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_assetId - The ID of the asset to update.
$sel:entryId:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_entryId - The user specified ID for the entry. You can use this ID to identify
which entries failed.
$sel:propertyValues:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_propertyValues - The list of property values to upload. You can specify up to 10
propertyValues array elements.
putAssetPropertyValueEntry_propertyAlias :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #
The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
putAssetPropertyValueEntry_propertyId :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #
The ID of the asset property for this entry.
putAssetPropertyValueEntry_assetId :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #
The ID of the asset to update.
putAssetPropertyValueEntry_entryId :: Lens' PutAssetPropertyValueEntry Text Source #
The user specified ID for the entry. You can use this ID to identify which entries failed.
putAssetPropertyValueEntry_propertyValues :: Lens' PutAssetPropertyValueEntry [AssetPropertyValue] Source #
The list of property values to upload. You can specify up to 10
propertyValues array elements.
Resource
Contains an IoT SiteWise Monitor resource ID for a portal or project.
See: newResource smart constructor.
Constructors
| Resource' | |
Fields
| |
Instances
| Eq Resource Source # | |
| Read Resource Source # | |
| Show Resource Source # | |
| Generic Resource Source # | |
| NFData Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| Hashable Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| ToJSON Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| FromJSON Resource Source # | |
| type Rep Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.IoTSiteWise.Types.Resource" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "portal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PortalResource)) :*: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectResource)))) | |
newResource :: Resource Source #
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:portal:Resource', resource_portal - A portal resource.
$sel:project:Resource', resource_project - A project resource.
resource_portal :: Lens' Resource (Maybe PortalResource) Source #
A portal resource.
resource_project :: Lens' Resource (Maybe ProjectResource) Source #
A project resource.
TimeInNanos
data TimeInNanos Source #
Contains a timestamp with optional nanosecond granularity.
See: newTimeInNanos smart constructor.
Constructors
| TimeInNanos' | |
Fields
| |
Instances
Arguments
| :: Natural | |
| -> TimeInNanos |
Create a value of TimeInNanos with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:offsetInNanos:TimeInNanos', timeInNanos_offsetInNanos - The nanosecond offset from timeInSeconds.
$sel:timeInSeconds:TimeInNanos', timeInNanos_timeInSeconds - The timestamp date, in seconds, in the Unix epoch format. Fractional
nanosecond data is provided by offsetInNanos.
timeInNanos_offsetInNanos :: Lens' TimeInNanos (Maybe Natural) Source #
The nanosecond offset from timeInSeconds.
timeInNanos_timeInSeconds :: Lens' TimeInNanos Natural Source #
The timestamp date, in seconds, in the Unix epoch format. Fractional
nanosecond data is provided by offsetInNanos.
Transform
Contains an asset transform property. A transform is a one-to-one
mapping of a property's data points from one form to another. For
example, you can use a transform to convert a Celsius data stream to
Fahrenheit by applying the transformation expression to each data point
of the Celsius stream. A transform can only have a data type of DOUBLE
and consume properties with data types of INTEGER or DOUBLE.
For more information, see Transforms in the IoT SiteWise User Guide.
See: newTransform smart constructor.
Constructors
| Transform' | |
Fields
| |
Instances
| Eq Transform Source # | |
| Read Transform Source # | |
| Show Transform Source # | |
| Generic Transform Source # | |
| NFData Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| Hashable Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| ToJSON Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| FromJSON Transform Source # | |
| type Rep Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform type Rep Transform = D1 ('MetaData "Transform" "Amazonka.IoTSiteWise.Types.Transform" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Transform'" 'PrefixI 'True) (S1 ('MetaSel ('Just "processingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformProcessingConfig)) :*: (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExpressionVariable])))) | |
Create a value of Transform with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:processingConfig:Transform', transform_processingConfig - The processing configuration for the given transform property. You can
configure transforms to be kept at the edge or forwarded to the Amazon
Web Services Cloud. You can also configure transforms to be computed at
the edge or in the cloud.
$sel:expression:Transform', transform_expression - The mathematical expression that defines the transformation function.
You can specify up to 10 variables per expression. You can specify up to
10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
$sel:variables:Transform', transform_variables - The list of variables used in the expression.
transform_processingConfig :: Lens' Transform (Maybe TransformProcessingConfig) Source #
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
transform_expression :: Lens' Transform Text Source #
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
transform_variables :: Lens' Transform [ExpressionVariable] Source #
The list of variables used in the expression.
TransformProcessingConfig
data TransformProcessingConfig Source #
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
See: newTransformProcessingConfig smart constructor.
Constructors
| TransformProcessingConfig' | |
Fields
| |
Instances
newTransformProcessingConfig Source #
Arguments
| :: ComputeLocation | |
| -> TransformProcessingConfig |
Create a value of TransformProcessingConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forwardingConfig:TransformProcessingConfig', transformProcessingConfig_forwardingConfig - Undocumented member.
$sel:computeLocation:TransformProcessingConfig', transformProcessingConfig_computeLocation - The compute location for the given transform property.
transformProcessingConfig_forwardingConfig :: Lens' TransformProcessingConfig (Maybe ForwardingConfig) Source #
Undocumented member.
transformProcessingConfig_computeLocation :: Lens' TransformProcessingConfig ComputeLocation Source #
The compute location for the given transform property.
TumblingWindow
data TumblingWindow Source #
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You use this window in metrics to aggregate data from properties and other assets.
You can use m, h, d, and w when you specify an interval or
offset. Note that m represents minutes, and w represents weeks. You
can also use s to represent seconds in offset.
The interval and offset parameters support the
ISO 8601 format. For example,
PT5S represents five seconds, PT5M represents five minutes, and
PT5H represents five hours.
See: newTumblingWindow smart constructor.
Constructors
| TumblingWindow' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> TumblingWindow |
Create a value of TumblingWindow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:offset:TumblingWindow', tumblingWindow_offset - The offset for the tumbling window. The offset parameter accepts the
following:
The offset time.
For example, if you specify
18hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
- If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.
For example, if you specify
PT18Hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
- If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.
For example, if you specify
00:03:00foroffsetand5mforinterval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).The offset time zone.
For example, if you specify
2021-07-23T18:00-08foroffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
- If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
$sel:interval:TumblingWindow', tumblingWindow_interval - The time interval for the tumbling window. The interval time must be
between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight
each week (UTC), the 1d interval at the end of each day at midnight
(UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
tumblingWindow_offset :: Lens' TumblingWindow (Maybe Text) Source #
The offset for the tumbling window. The offset parameter accepts the
following:
The offset time.
For example, if you specify
18hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
- If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.
For example, if you specify
PT18Hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
- If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.
For example, if you specify
00:03:00foroffsetand5mforinterval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).The offset time zone.
For example, if you specify
2021-07-23T18:00-08foroffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:- If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
- If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
tumblingWindow_interval :: Lens' TumblingWindow Text Source #
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight
each week (UTC), the 1d interval at the end of each day at midnight
(UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
UserIdentity
data UserIdentity Source #
Contains information for a user identity in an access policy.
See: newUserIdentity smart constructor.
Constructors
| UserIdentity' | |
Instances
Arguments
| :: Text | |
| -> UserIdentity |
Create a value of UserIdentity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UserIdentity', userIdentity_id - The Amazon Web Services SSO ID of the user.
userIdentity_id :: Lens' UserIdentity Text Source #
The Amazon Web Services SSO ID of the user.
VariableValue
data VariableValue Source #
Identifies a property value used in an expression.
See: newVariableValue smart constructor.
Constructors
| VariableValue' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> VariableValue |
Create a value of VariableValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hierarchyId:VariableValue', variableValue_hierarchyId - The ID of the hierarchy to query for the property ID. You can use the
hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have
several hierarchies using the same model and therefore the same
propertyId. For example, you might have separately grouped assets that
come from the same asset model. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
$sel:propertyId:VariableValue', variableValue_propertyId - The ID of the property to use as the variable. You can use the property
name if it's from the same asset model.
variableValue_hierarchyId :: Lens' VariableValue (Maybe Text) Source #
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have
several hierarchies using the same model and therefore the same
propertyId. For example, you might have separately grouped assets that
come from the same asset model. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
variableValue_propertyId :: Lens' VariableValue Text Source #
The ID of the property to use as the variable. You can use the property
name if it's from the same asset model.
Variant
Contains an asset property value (of a single type only).
See: newVariant smart constructor.
Constructors
| Variant' | |
Fields
| |
Instances
newVariant :: Variant Source #
Create a value of Variant with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:integerValue:Variant', variant_integerValue - Asset property data of type integer (whole number).
$sel:doubleValue:Variant', variant_doubleValue - Asset property data of type double (floating point number).
$sel:stringValue:Variant', variant_stringValue - Asset property data of type string (sequence of characters).
$sel:booleanValue:Variant', variant_booleanValue - Asset property data of type Boolean (true or false).
variant_integerValue :: Lens' Variant (Maybe Int) Source #
Asset property data of type integer (whole number).
variant_doubleValue :: Lens' Variant (Maybe Double) Source #
Asset property data of type double (floating point number).