| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoTSiteWise
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateAssets
- AssociateTimeSeriesToAssetProperty
- BatchAssociateProjectAssets
- BatchDisassociateProjectAssets
- BatchGetAssetPropertyAggregates
- BatchGetAssetPropertyValue
- BatchGetAssetPropertyValueHistory
- BatchPutAssetPropertyValue
- CreateAccessPolicy
- CreateAsset
- CreateAssetModel
- CreateBulkImportJob
- CreateDashboard
- CreateGateway
- CreatePortal
- CreateProject
- DeleteAccessPolicy
- DeleteAsset
- DeleteAssetModel
- DeleteDashboard
- DeleteGateway
- DeletePortal
- DeleteProject
- DeleteTimeSeries
- DescribeAccessPolicy
- DescribeAsset
- DescribeAssetModel
- DescribeAssetProperty
- DescribeBulkImportJob
- DescribeDashboard
- DescribeDefaultEncryptionConfiguration
- DescribeGateway
- DescribeGatewayCapabilityConfiguration
- DescribeLoggingOptions
- DescribePortal
- DescribeProject
- DescribeStorageConfiguration
- DescribeTimeSeries
- DisassociateAssets
- DisassociateTimeSeriesFromAssetProperty
- GetAssetPropertyAggregates (Paginated)
- GetAssetPropertyValue
- GetAssetPropertyValueHistory (Paginated)
- GetInterpolatedAssetPropertyValues (Paginated)
- ListAccessPolicies (Paginated)
- ListAssetModelProperties (Paginated)
- ListAssetModels (Paginated)
- ListAssetProperties (Paginated)
- ListAssetRelationships (Paginated)
- ListAssets (Paginated)
- ListAssociatedAssets (Paginated)
- ListBulkImportJobs (Paginated)
- ListDashboards (Paginated)
- ListGateways (Paginated)
- ListPortals (Paginated)
- ListProjectAssets (Paginated)
- ListProjects (Paginated)
- ListTagsForResource
- ListTimeSeries (Paginated)
- PutDefaultEncryptionConfiguration
- PutLoggingOptions
- PutStorageConfiguration
- TagResource
- UntagResource
- UpdateAccessPolicy
- UpdateAsset
- UpdateAssetModel
- UpdateAssetProperty
- UpdateDashboard
- UpdateGateway
- UpdateGatewayCapabilityConfiguration
- UpdatePortal
- UpdateProject
- Types
- AggregateType
- AssetErrorCode
- AssetModelState
- AssetRelationshipType
- AssetState
- AuthMode
- BatchEntryCompletionStatus
- BatchGetAssetPropertyAggregatesErrorCode
- BatchGetAssetPropertyValueErrorCode
- BatchGetAssetPropertyValueHistoryErrorCode
- BatchPutAssetPropertyValueErrorCode
- CapabilitySyncStatus
- ColumnName
- ComputeLocation
- ConfigurationState
- DetailedErrorCode
- DisassociatedDataStorageState
- EncryptionType
- ErrorCode
- ForwardingConfigState
- IdentityType
- ImageFileType
- JobStatus
- ListAssetModelPropertiesFilter
- ListAssetPropertiesFilter
- ListAssetsFilter
- ListBulkImportJobsFilter
- ListTimeSeriesType
- 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
- AssetModelPropertySummary
- AssetModelStatus
- AssetModelSummary
- AssetProperty
- AssetPropertySummary
- AssetPropertyValue
- AssetRelationshipSummary
- AssetStatus
- AssetSummary
- AssociatedAssetsSummary
- Attribute
- BatchGetAssetPropertyAggregatesEntry
- BatchGetAssetPropertyAggregatesErrorEntry
- BatchGetAssetPropertyAggregatesErrorInfo
- BatchGetAssetPropertyAggregatesSkippedEntry
- BatchGetAssetPropertyAggregatesSuccessEntry
- BatchGetAssetPropertyValueEntry
- BatchGetAssetPropertyValueErrorEntry
- BatchGetAssetPropertyValueErrorInfo
- BatchGetAssetPropertyValueHistoryEntry
- BatchGetAssetPropertyValueHistoryErrorEntry
- BatchGetAssetPropertyValueHistoryErrorInfo
- BatchGetAssetPropertyValueHistorySkippedEntry
- BatchGetAssetPropertyValueHistorySuccessEntry
- BatchGetAssetPropertyValueSkippedEntry
- BatchGetAssetPropertyValueSuccessEntry
- BatchPutAssetPropertyError
- BatchPutAssetPropertyErrorEntry
- CompositeModelProperty
- ConfigurationErrorDetails
- ConfigurationStatus
- Csv
- CustomerManagedS3Storage
- DashboardSummary
- DetailedError
- ErrorDetails
- ErrorReportLocation
- ExpressionVariable
- File
- FileFormat
- ForwardingConfig
- GatewayCapabilitySummary
- GatewayPlatform
- GatewaySummary
- Greengrass
- GreengrassV2
- GroupIdentity
- IAMRoleIdentity
- IAMUserIdentity
- Identity
- Image
- ImageFile
- ImageLocation
- InterpolatedAssetPropertyValue
- JobConfiguration
- JobSummary
- LoggingOptions
- Measurement
- MeasurementProcessingConfig
- Metric
- MetricProcessingConfig
- MetricWindow
- MonitorErrorDetails
- MultiLayerStorage
- PortalResource
- PortalStatus
- PortalSummary
- ProjectResource
- ProjectSummary
- Property
- PropertyNotification
- PropertyType
- PutAssetPropertyValueEntry
- Resource
- RetentionPeriod
- TimeInNanos
- TimeSeriesSummary
- Transform
- TransformProcessingConfig
- TumblingWindow
- UserIdentity
- VariableValue
- Variant
Description
Derived from API version 2019-12-02 of the AWS service descriptions, licensed under Apache 2.0.
Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
Synopsis
- defaultService :: Service
- _ConflictingOperationException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- newAssetActive :: Wait DescribeAsset
- newAssetModelActive :: Wait DescribeAssetModel
- newAssetModelNotExists :: Wait DescribeAssetModel
- newAssetNotExists :: Wait DescribeAsset
- newPortalActive :: Wait DescribePortal
- newPortalNotExists :: Wait DescribePortal
- data AssociateAssets = AssociateAssets' (Maybe Text) Text Text Text
- newAssociateAssets :: Text -> Text -> Text -> AssociateAssets
- data AssociateAssetsResponse = AssociateAssetsResponse' {
- newAssociateAssetsResponse :: AssociateAssetsResponse
- data AssociateTimeSeriesToAssetProperty = AssociateTimeSeriesToAssetProperty' (Maybe Text) Text Text Text
- newAssociateTimeSeriesToAssetProperty :: Text -> Text -> Text -> AssociateTimeSeriesToAssetProperty
- data AssociateTimeSeriesToAssetPropertyResponse = AssociateTimeSeriesToAssetPropertyResponse' {
- newAssociateTimeSeriesToAssetPropertyResponse :: AssociateTimeSeriesToAssetPropertyResponse
- data BatchAssociateProjectAssets = BatchAssociateProjectAssets' (Maybe Text) Text (NonEmpty Text)
- newBatchAssociateProjectAssets :: Text -> NonEmpty Text -> BatchAssociateProjectAssets
- data BatchAssociateProjectAssetsResponse = BatchAssociateProjectAssetsResponse' (Maybe [AssetErrorDetails]) Int
- newBatchAssociateProjectAssetsResponse :: Int -> BatchAssociateProjectAssetsResponse
- data BatchDisassociateProjectAssets = BatchDisassociateProjectAssets' (Maybe Text) Text (NonEmpty Text)
- newBatchDisassociateProjectAssets :: Text -> NonEmpty Text -> BatchDisassociateProjectAssets
- data BatchDisassociateProjectAssetsResponse = BatchDisassociateProjectAssetsResponse' (Maybe [AssetErrorDetails]) Int
- newBatchDisassociateProjectAssetsResponse :: Int -> BatchDisassociateProjectAssetsResponse
- data BatchGetAssetPropertyAggregates = BatchGetAssetPropertyAggregates' (Maybe Natural) (Maybe Text) [BatchGetAssetPropertyAggregatesEntry]
- newBatchGetAssetPropertyAggregates :: BatchGetAssetPropertyAggregates
- data BatchGetAssetPropertyAggregatesResponse = BatchGetAssetPropertyAggregatesResponse' (Maybe Text) Int [BatchGetAssetPropertyAggregatesErrorEntry] [BatchGetAssetPropertyAggregatesSuccessEntry] [BatchGetAssetPropertyAggregatesSkippedEntry]
- newBatchGetAssetPropertyAggregatesResponse :: Int -> BatchGetAssetPropertyAggregatesResponse
- data BatchGetAssetPropertyValue = BatchGetAssetPropertyValue' (Maybe Text) [BatchGetAssetPropertyValueEntry]
- newBatchGetAssetPropertyValue :: BatchGetAssetPropertyValue
- data BatchGetAssetPropertyValueResponse = BatchGetAssetPropertyValueResponse' (Maybe Text) Int [BatchGetAssetPropertyValueErrorEntry] [BatchGetAssetPropertyValueSuccessEntry] [BatchGetAssetPropertyValueSkippedEntry]
- newBatchGetAssetPropertyValueResponse :: Int -> BatchGetAssetPropertyValueResponse
- data BatchGetAssetPropertyValueHistory = BatchGetAssetPropertyValueHistory' (Maybe Natural) (Maybe Text) [BatchGetAssetPropertyValueHistoryEntry]
- newBatchGetAssetPropertyValueHistory :: BatchGetAssetPropertyValueHistory
- data BatchGetAssetPropertyValueHistoryResponse = BatchGetAssetPropertyValueHistoryResponse' (Maybe Text) Int [BatchGetAssetPropertyValueHistoryErrorEntry] [BatchGetAssetPropertyValueHistorySuccessEntry] [BatchGetAssetPropertyValueHistorySkippedEntry]
- newBatchGetAssetPropertyValueHistoryResponse :: Int -> BatchGetAssetPropertyValueHistoryResponse
- data BatchPutAssetPropertyValue = BatchPutAssetPropertyValue' [PutAssetPropertyValueEntry]
- newBatchPutAssetPropertyValue :: BatchPutAssetPropertyValue
- data BatchPutAssetPropertyValueResponse = BatchPutAssetPropertyValueResponse' Int [BatchPutAssetPropertyErrorEntry]
- newBatchPutAssetPropertyValueResponse :: Int -> BatchPutAssetPropertyValueResponse
- data CreateAccessPolicy = CreateAccessPolicy' (Maybe Text) (Maybe (HashMap Text Text)) Identity Resource Permission
- newCreateAccessPolicy :: Identity -> Resource -> Permission -> CreateAccessPolicy
- data CreateAccessPolicyResponse = CreateAccessPolicyResponse' Int Text Text
- newCreateAccessPolicyResponse :: Int -> Text -> Text -> CreateAccessPolicyResponse
- data CreateAsset = CreateAsset' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateAsset :: Text -> Text -> CreateAsset
- data CreateAssetResponse = CreateAssetResponse' Int Text Text AssetStatus
- newCreateAssetResponse :: Int -> Text -> Text -> AssetStatus -> CreateAssetResponse
- data CreateAssetModel = CreateAssetModel' (Maybe [AssetModelCompositeModelDefinition]) (Maybe Text) (Maybe [AssetModelHierarchyDefinition]) (Maybe [AssetModelPropertyDefinition]) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateAssetModel :: Text -> CreateAssetModel
- data CreateAssetModelResponse = CreateAssetModelResponse' Int Text Text AssetModelStatus
- newCreateAssetModelResponse :: Int -> Text -> Text -> AssetModelStatus -> CreateAssetModelResponse
- data CreateBulkImportJob = CreateBulkImportJob' Text Text [File] ErrorReportLocation JobConfiguration
- newCreateBulkImportJob :: Text -> Text -> ErrorReportLocation -> JobConfiguration -> CreateBulkImportJob
- data CreateBulkImportJobResponse = CreateBulkImportJobResponse' Int Text Text JobStatus
- newCreateBulkImportJobResponse :: Int -> Text -> Text -> JobStatus -> CreateBulkImportJobResponse
- data CreateDashboard = CreateDashboard' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newCreateDashboard :: Text -> Text -> Text -> CreateDashboard
- data CreateDashboardResponse = CreateDashboardResponse' Int Text Text
- newCreateDashboardResponse :: Int -> Text -> Text -> CreateDashboardResponse
- data CreateGateway = CreateGateway' (Maybe (HashMap Text Text)) Text GatewayPlatform
- newCreateGateway :: Text -> GatewayPlatform -> CreateGateway
- data CreateGatewayResponse = CreateGatewayResponse' Int Text Text
- newCreateGatewayResponse :: Int -> Text -> Text -> CreateGatewayResponse
- data CreatePortal = CreatePortal' (Maybe Alarms) (Maybe Text) (Maybe Text) (Maybe AuthMode) (Maybe Text) (Maybe ImageFile) (Maybe (HashMap Text Text)) Text Text Text
- newCreatePortal :: Text -> Text -> Text -> CreatePortal
- data CreatePortalResponse = CreatePortalResponse' Int Text Text Text PortalStatus Text
- newCreatePortalResponse :: Int -> Text -> Text -> Text -> PortalStatus -> Text -> CreatePortalResponse
- data CreateProject = CreateProject' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateProject :: Text -> Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' Int Text Text
- newCreateProjectResponse :: Int -> Text -> Text -> CreateProjectResponse
- data DeleteAccessPolicy = DeleteAccessPolicy' (Maybe Text) Text
- newDeleteAccessPolicy :: Text -> DeleteAccessPolicy
- data DeleteAccessPolicyResponse = DeleteAccessPolicyResponse' Int
- newDeleteAccessPolicyResponse :: Int -> DeleteAccessPolicyResponse
- data DeleteAsset = DeleteAsset' (Maybe Text) Text
- newDeleteAsset :: Text -> DeleteAsset
- data DeleteAssetResponse = DeleteAssetResponse' Int AssetStatus
- newDeleteAssetResponse :: Int -> AssetStatus -> DeleteAssetResponse
- data DeleteAssetModel = DeleteAssetModel' (Maybe Text) Text
- newDeleteAssetModel :: Text -> DeleteAssetModel
- data DeleteAssetModelResponse = DeleteAssetModelResponse' Int AssetModelStatus
- newDeleteAssetModelResponse :: Int -> AssetModelStatus -> DeleteAssetModelResponse
- data DeleteDashboard = DeleteDashboard' (Maybe Text) Text
- newDeleteDashboard :: Text -> DeleteDashboard
- data DeleteDashboardResponse = DeleteDashboardResponse' Int
- newDeleteDashboardResponse :: Int -> DeleteDashboardResponse
- data DeleteGateway = DeleteGateway' Text
- newDeleteGateway :: Text -> DeleteGateway
- data DeleteGatewayResponse = DeleteGatewayResponse' {
- newDeleteGatewayResponse :: DeleteGatewayResponse
- data DeletePortal = DeletePortal' (Maybe Text) Text
- newDeletePortal :: Text -> DeletePortal
- data DeletePortalResponse = DeletePortalResponse' Int PortalStatus
- newDeletePortalResponse :: Int -> PortalStatus -> DeletePortalResponse
- data DeleteProject = DeleteProject' (Maybe Text) Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data DeleteTimeSeries = DeleteTimeSeries' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDeleteTimeSeries :: DeleteTimeSeries
- data DeleteTimeSeriesResponse = DeleteTimeSeriesResponse' {
- newDeleteTimeSeriesResponse :: DeleteTimeSeriesResponse
- data DescribeAccessPolicy = DescribeAccessPolicy' Text
- newDescribeAccessPolicy :: Text -> DescribeAccessPolicy
- data DescribeAccessPolicyResponse = DescribeAccessPolicyResponse' Int Text Text Identity Resource Permission POSIX POSIX
- newDescribeAccessPolicyResponse :: Int -> Text -> Text -> Identity -> Resource -> Permission -> UTCTime -> UTCTime -> DescribeAccessPolicyResponse
- data DescribeAsset = DescribeAsset' (Maybe Bool) Text
- newDescribeAsset :: Text -> DescribeAsset
- data DescribeAssetResponse = DescribeAssetResponse' (Maybe [AssetCompositeModel]) (Maybe Text) Int Text Text Text Text [AssetProperty] [AssetHierarchy] POSIX POSIX AssetStatus
- newDescribeAssetResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> DescribeAssetResponse
- data DescribeAssetModel = DescribeAssetModel' (Maybe Bool) Text
- newDescribeAssetModel :: Text -> DescribeAssetModel
- data DescribeAssetModelResponse = DescribeAssetModelResponse' (Maybe [AssetModelCompositeModel]) Int Text Text Text Text [AssetModelProperty] [AssetModelHierarchy] POSIX POSIX AssetModelStatus
- newDescribeAssetModelResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetModelStatus -> DescribeAssetModelResponse
- data DescribeAssetProperty = DescribeAssetProperty' Text Text
- newDescribeAssetProperty :: Text -> Text -> DescribeAssetProperty
- data DescribeAssetPropertyResponse = DescribeAssetPropertyResponse' (Maybe Property) (Maybe CompositeModelProperty) Int Text Text Text
- newDescribeAssetPropertyResponse :: Int -> Text -> Text -> Text -> DescribeAssetPropertyResponse
- data DescribeBulkImportJob = DescribeBulkImportJob' Text
- newDescribeBulkImportJob :: Text -> DescribeBulkImportJob
- data DescribeBulkImportJobResponse = DescribeBulkImportJobResponse' Int Text Text JobStatus Text [File] ErrorReportLocation JobConfiguration POSIX POSIX
- newDescribeBulkImportJobResponse :: Int -> Text -> Text -> JobStatus -> Text -> ErrorReportLocation -> JobConfiguration -> UTCTime -> UTCTime -> DescribeBulkImportJobResponse
- data DescribeDashboard = DescribeDashboard' Text
- newDescribeDashboard :: Text -> DescribeDashboard
- data DescribeDashboardResponse = DescribeDashboardResponse' (Maybe Text) Int Text Text Text Text Text POSIX POSIX
- newDescribeDashboardResponse :: Int -> Text -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeDashboardResponse
- data DescribeDefaultEncryptionConfiguration = DescribeDefaultEncryptionConfiguration' {
- newDescribeDefaultEncryptionConfiguration :: DescribeDefaultEncryptionConfiguration
- data DescribeDefaultEncryptionConfigurationResponse = DescribeDefaultEncryptionConfigurationResponse' (Maybe Text) Int EncryptionType ConfigurationStatus
- newDescribeDefaultEncryptionConfigurationResponse :: Int -> EncryptionType -> ConfigurationStatus -> DescribeDefaultEncryptionConfigurationResponse
- data DescribeGateway = DescribeGateway' Text
- newDescribeGateway :: Text -> DescribeGateway
- data DescribeGatewayResponse = DescribeGatewayResponse' (Maybe GatewayPlatform) Int Text Text Text [GatewayCapabilitySummary] POSIX POSIX
- newDescribeGatewayResponse :: Int -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeGatewayResponse
- data DescribeGatewayCapabilityConfiguration = DescribeGatewayCapabilityConfiguration' Text Text
- newDescribeGatewayCapabilityConfiguration :: Text -> Text -> DescribeGatewayCapabilityConfiguration
- data DescribeGatewayCapabilityConfigurationResponse = DescribeGatewayCapabilityConfigurationResponse' Int Text Text Text CapabilitySyncStatus
- newDescribeGatewayCapabilityConfigurationResponse :: Int -> Text -> Text -> Text -> CapabilitySyncStatus -> DescribeGatewayCapabilityConfigurationResponse
- data DescribeLoggingOptions = DescribeLoggingOptions' {
- newDescribeLoggingOptions :: DescribeLoggingOptions
- data DescribeLoggingOptionsResponse = DescribeLoggingOptionsResponse' Int LoggingOptions
- newDescribeLoggingOptionsResponse :: Int -> LoggingOptions -> DescribeLoggingOptionsResponse
- data DescribePortal = DescribePortal' Text
- newDescribePortal :: Text -> DescribePortal
- data DescribePortalResponse = DescribePortalResponse' (Maybe Alarms) (Maybe Text) (Maybe AuthMode) (Maybe Text) (Maybe ImageLocation) (Maybe Text) Int Text Text Text Text Text Text PortalStatus POSIX POSIX
- newDescribePortalResponse :: Int -> Text -> Text -> Text -> Text -> Text -> Text -> PortalStatus -> UTCTime -> UTCTime -> DescribePortalResponse
- data DescribeProject = DescribeProject' Text
- newDescribeProject :: Text -> DescribeProject
- data DescribeProjectResponse = DescribeProjectResponse' (Maybe Text) Int Text Text Text Text POSIX POSIX
- newDescribeProjectResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeProjectResponse
- data DescribeStorageConfiguration = DescribeStorageConfiguration' {
- newDescribeStorageConfiguration :: DescribeStorageConfiguration
- data DescribeStorageConfigurationResponse = DescribeStorageConfigurationResponse' (Maybe DisassociatedDataStorageState) (Maybe POSIX) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) Int StorageType ConfigurationStatus
- newDescribeStorageConfigurationResponse :: Int -> StorageType -> ConfigurationStatus -> DescribeStorageConfigurationResponse
- data DescribeTimeSeries = DescribeTimeSeries' (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeTimeSeries :: DescribeTimeSeries
- data DescribeTimeSeriesResponse = DescribeTimeSeriesResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int Text PropertyDataType POSIX POSIX
- newDescribeTimeSeriesResponse :: Int -> Text -> PropertyDataType -> UTCTime -> UTCTime -> DescribeTimeSeriesResponse
- data DisassociateAssets = DisassociateAssets' (Maybe Text) Text Text Text
- newDisassociateAssets :: Text -> Text -> Text -> DisassociateAssets
- data DisassociateAssetsResponse = DisassociateAssetsResponse' {
- newDisassociateAssetsResponse :: DisassociateAssetsResponse
- data DisassociateTimeSeriesFromAssetProperty = DisassociateTimeSeriesFromAssetProperty' (Maybe Text) Text Text Text
- newDisassociateTimeSeriesFromAssetProperty :: Text -> Text -> Text -> DisassociateTimeSeriesFromAssetProperty
- data DisassociateTimeSeriesFromAssetPropertyResponse = DisassociateTimeSeriesFromAssetPropertyResponse' {
- newDisassociateTimeSeriesFromAssetPropertyResponse :: DisassociateTimeSeriesFromAssetPropertyResponse
- data GetAssetPropertyAggregates = GetAssetPropertyAggregates' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe TimeOrdering) (NonEmpty AggregateType) Text POSIX POSIX
- newGetAssetPropertyAggregates :: NonEmpty AggregateType -> Text -> UTCTime -> UTCTime -> GetAssetPropertyAggregates
- data GetAssetPropertyAggregatesResponse = GetAssetPropertyAggregatesResponse' (Maybe Text) Int [AggregatedValue]
- newGetAssetPropertyAggregatesResponse :: Int -> GetAssetPropertyAggregatesResponse
- data GetAssetPropertyValue = GetAssetPropertyValue' (Maybe Text) (Maybe Text) (Maybe Text)
- newGetAssetPropertyValue :: GetAssetPropertyValue
- data GetAssetPropertyValueResponse = GetAssetPropertyValueResponse' (Maybe AssetPropertyValue) Int
- newGetAssetPropertyValueResponse :: Int -> GetAssetPropertyValueResponse
- data GetAssetPropertyValueHistory = GetAssetPropertyValueHistory' (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe POSIX) (Maybe TimeOrdering)
- newGetAssetPropertyValueHistory :: GetAssetPropertyValueHistory
- data GetAssetPropertyValueHistoryResponse = GetAssetPropertyValueHistoryResponse' (Maybe Text) Int [AssetPropertyValue]
- newGetAssetPropertyValueHistoryResponse :: Int -> GetAssetPropertyValueHistoryResponse
- data GetInterpolatedAssetPropertyValues = GetInterpolatedAssetPropertyValues' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Natural Natural Quality Natural Text
- newGetInterpolatedAssetPropertyValues :: Natural -> Natural -> Quality -> Natural -> Text -> GetInterpolatedAssetPropertyValues
- data GetInterpolatedAssetPropertyValuesResponse = GetInterpolatedAssetPropertyValuesResponse' (Maybe Text) Int [InterpolatedAssetPropertyValue]
- newGetInterpolatedAssetPropertyValuesResponse :: Int -> GetInterpolatedAssetPropertyValuesResponse
- data ListAccessPolicies = ListAccessPolicies' (Maybe Text) (Maybe Text) (Maybe IdentityType) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ResourceType)
- newListAccessPolicies :: ListAccessPolicies
- data ListAccessPoliciesResponse = ListAccessPoliciesResponse' (Maybe Text) Int [AccessPolicySummary]
- newListAccessPoliciesResponse :: Int -> ListAccessPoliciesResponse
- data ListAssetModelProperties = ListAssetModelProperties' (Maybe ListAssetModelPropertiesFilter) (Maybe Natural) (Maybe Text) Text
- newListAssetModelProperties :: Text -> ListAssetModelProperties
- data ListAssetModelPropertiesResponse = ListAssetModelPropertiesResponse' (Maybe Text) Int [AssetModelPropertySummary]
- newListAssetModelPropertiesResponse :: Int -> ListAssetModelPropertiesResponse
- data ListAssetModels = ListAssetModels' (Maybe Natural) (Maybe Text)
- newListAssetModels :: ListAssetModels
- data ListAssetModelsResponse = ListAssetModelsResponse' (Maybe Text) Int [AssetModelSummary]
- newListAssetModelsResponse :: Int -> ListAssetModelsResponse
- data ListAssetProperties = ListAssetProperties' (Maybe ListAssetPropertiesFilter) (Maybe Natural) (Maybe Text) Text
- newListAssetProperties :: Text -> ListAssetProperties
- data ListAssetPropertiesResponse = ListAssetPropertiesResponse' (Maybe Text) Int [AssetPropertySummary]
- newListAssetPropertiesResponse :: Int -> ListAssetPropertiesResponse
- data ListAssetRelationships = ListAssetRelationships' (Maybe Natural) (Maybe Text) Text TraversalType
- newListAssetRelationships :: Text -> TraversalType -> ListAssetRelationships
- data ListAssetRelationshipsResponse = ListAssetRelationshipsResponse' (Maybe Text) Int [AssetRelationshipSummary]
- newListAssetRelationshipsResponse :: Int -> ListAssetRelationshipsResponse
- data ListAssets = ListAssets' (Maybe Text) (Maybe ListAssetsFilter) (Maybe Natural) (Maybe Text)
- newListAssets :: ListAssets
- data ListAssetsResponse = ListAssetsResponse' (Maybe Text) Int [AssetSummary]
- newListAssetsResponse :: Int -> ListAssetsResponse
- data ListAssociatedAssets = ListAssociatedAssets' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TraversalDirection) Text
- newListAssociatedAssets :: Text -> ListAssociatedAssets
- data ListAssociatedAssetsResponse = ListAssociatedAssetsResponse' (Maybe Text) Int [AssociatedAssetsSummary]
- newListAssociatedAssetsResponse :: Int -> ListAssociatedAssetsResponse
- data ListBulkImportJobs = ListBulkImportJobs' (Maybe ListBulkImportJobsFilter) (Maybe Natural) (Maybe Text)
- newListBulkImportJobs :: ListBulkImportJobs
- data ListBulkImportJobsResponse = ListBulkImportJobsResponse' (Maybe Text) Int [JobSummary]
- newListBulkImportJobsResponse :: Int -> ListBulkImportJobsResponse
- data ListDashboards = ListDashboards' (Maybe Natural) (Maybe Text) Text
- newListDashboards :: Text -> ListDashboards
- data ListDashboardsResponse = ListDashboardsResponse' (Maybe Text) Int [DashboardSummary]
- newListDashboardsResponse :: Int -> ListDashboardsResponse
- data ListGateways = ListGateways' (Maybe Natural) (Maybe Text)
- newListGateways :: ListGateways
- data ListGatewaysResponse = ListGatewaysResponse' (Maybe Text) Int [GatewaySummary]
- newListGatewaysResponse :: Int -> ListGatewaysResponse
- data ListPortals = ListPortals' (Maybe Natural) (Maybe Text)
- newListPortals :: ListPortals
- data ListPortalsResponse = ListPortalsResponse' (Maybe Text) (Maybe [PortalSummary]) Int
- newListPortalsResponse :: Int -> ListPortalsResponse
- data ListProjectAssets = ListProjectAssets' (Maybe Natural) (Maybe Text) Text
- newListProjectAssets :: Text -> ListProjectAssets
- data ListProjectAssetsResponse = ListProjectAssetsResponse' (Maybe Text) Int [Text]
- newListProjectAssetsResponse :: Int -> ListProjectAssetsResponse
- data ListProjects = ListProjects' (Maybe Natural) (Maybe Text) Text
- newListProjects :: Text -> ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) Int [ProjectSummary]
- newListProjectsResponse :: Int -> ListProjectsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTimeSeries = ListTimeSeries' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ListTimeSeriesType)
- newListTimeSeries :: ListTimeSeries
- data ListTimeSeriesResponse = ListTimeSeriesResponse' (Maybe Text) Int [TimeSeriesSummary]
- newListTimeSeriesResponse :: Int -> ListTimeSeriesResponse
- data PutDefaultEncryptionConfiguration = PutDefaultEncryptionConfiguration' (Maybe Text) EncryptionType
- newPutDefaultEncryptionConfiguration :: EncryptionType -> PutDefaultEncryptionConfiguration
- data PutDefaultEncryptionConfigurationResponse = PutDefaultEncryptionConfigurationResponse' (Maybe Text) Int EncryptionType ConfigurationStatus
- newPutDefaultEncryptionConfigurationResponse :: Int -> EncryptionType -> ConfigurationStatus -> PutDefaultEncryptionConfigurationResponse
- data PutLoggingOptions = PutLoggingOptions' LoggingOptions
- newPutLoggingOptions :: LoggingOptions -> PutLoggingOptions
- data PutLoggingOptionsResponse = PutLoggingOptionsResponse' Int
- newPutLoggingOptionsResponse :: Int -> PutLoggingOptionsResponse
- data PutStorageConfiguration = PutStorageConfiguration' (Maybe DisassociatedDataStorageState) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) StorageType
- newPutStorageConfiguration :: StorageType -> PutStorageConfiguration
- data PutStorageConfigurationResponse = PutStorageConfigurationResponse' (Maybe DisassociatedDataStorageState) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) Int StorageType ConfigurationStatus
- newPutStorageConfigurationResponse :: Int -> StorageType -> ConfigurationStatus -> PutStorageConfigurationResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAccessPolicy = UpdateAccessPolicy' (Maybe Text) Text Identity Resource Permission
- newUpdateAccessPolicy :: Text -> Identity -> Resource -> Permission -> UpdateAccessPolicy
- data UpdateAccessPolicyResponse = UpdateAccessPolicyResponse' Int
- newUpdateAccessPolicyResponse :: Int -> UpdateAccessPolicyResponse
- data UpdateAsset = UpdateAsset' (Maybe Text) (Maybe Text) Text Text
- newUpdateAsset :: Text -> Text -> UpdateAsset
- data UpdateAssetResponse = UpdateAssetResponse' Int AssetStatus
- newUpdateAssetResponse :: Int -> AssetStatus -> UpdateAssetResponse
- data UpdateAssetModel = UpdateAssetModel' (Maybe [AssetModelCompositeModel]) (Maybe Text) (Maybe [AssetModelHierarchy]) (Maybe [AssetModelProperty]) (Maybe Text) Text Text
- newUpdateAssetModel :: Text -> Text -> UpdateAssetModel
- data UpdateAssetModelResponse = UpdateAssetModelResponse' Int AssetModelStatus
- newUpdateAssetModelResponse :: Int -> AssetModelStatus -> UpdateAssetModelResponse
- data UpdateAssetProperty = UpdateAssetProperty' (Maybe Text) (Maybe Text) (Maybe PropertyNotificationState) (Maybe Text) Text Text
- newUpdateAssetProperty :: Text -> Text -> UpdateAssetProperty
- data UpdateAssetPropertyResponse = UpdateAssetPropertyResponse' {
- newUpdateAssetPropertyResponse :: UpdateAssetPropertyResponse
- data UpdateDashboard = UpdateDashboard' (Maybe Text) (Maybe Text) Text Text Text
- newUpdateDashboard :: Text -> Text -> Text -> UpdateDashboard
- data UpdateDashboardResponse = UpdateDashboardResponse' Int
- newUpdateDashboardResponse :: Int -> UpdateDashboardResponse
- data UpdateGateway = UpdateGateway' Text Text
- newUpdateGateway :: Text -> Text -> UpdateGateway
- data UpdateGatewayResponse = UpdateGatewayResponse' {
- newUpdateGatewayResponse :: UpdateGatewayResponse
- data UpdateGatewayCapabilityConfiguration = UpdateGatewayCapabilityConfiguration' Text Text Text
- newUpdateGatewayCapabilityConfiguration :: Text -> Text -> Text -> UpdateGatewayCapabilityConfiguration
- data UpdateGatewayCapabilityConfigurationResponse = UpdateGatewayCapabilityConfigurationResponse' Int Text CapabilitySyncStatus
- newUpdateGatewayCapabilityConfigurationResponse :: Int -> Text -> CapabilitySyncStatus -> UpdateGatewayCapabilityConfigurationResponse
- data UpdatePortal = UpdatePortal' (Maybe Alarms) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Image) Text Text Text Text
- newUpdatePortal :: Text -> Text -> Text -> Text -> UpdatePortal
- data UpdatePortalResponse = UpdatePortalResponse' Int PortalStatus
- newUpdatePortalResponse :: Int -> PortalStatus -> UpdatePortalResponse
- data UpdateProject = UpdateProject' (Maybe Text) (Maybe Text) Text Text
- newUpdateProject :: Text -> Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' Int
- newUpdateProjectResponse :: Int -> UpdateProjectResponse
- 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 BatchEntryCompletionStatus where
- newtype BatchGetAssetPropertyAggregatesErrorCode where
- BatchGetAssetPropertyAggregatesErrorCode' { }
- pattern BatchGetAssetPropertyAggregatesErrorCode_AccessDeniedException :: BatchGetAssetPropertyAggregatesErrorCode
- pattern BatchGetAssetPropertyAggregatesErrorCode_InvalidRequestException :: BatchGetAssetPropertyAggregatesErrorCode
- pattern BatchGetAssetPropertyAggregatesErrorCode_ResourceNotFoundException :: BatchGetAssetPropertyAggregatesErrorCode
- newtype BatchGetAssetPropertyValueErrorCode where
- BatchGetAssetPropertyValueErrorCode' { }
- pattern BatchGetAssetPropertyValueErrorCode_AccessDeniedException :: BatchGetAssetPropertyValueErrorCode
- pattern BatchGetAssetPropertyValueErrorCode_InvalidRequestException :: BatchGetAssetPropertyValueErrorCode
- pattern BatchGetAssetPropertyValueErrorCode_ResourceNotFoundException :: BatchGetAssetPropertyValueErrorCode
- newtype BatchGetAssetPropertyValueHistoryErrorCode where
- BatchGetAssetPropertyValueHistoryErrorCode' { }
- pattern BatchGetAssetPropertyValueHistoryErrorCode_AccessDeniedException :: BatchGetAssetPropertyValueHistoryErrorCode
- pattern BatchGetAssetPropertyValueHistoryErrorCode_InvalidRequestException :: BatchGetAssetPropertyValueHistoryErrorCode
- pattern BatchGetAssetPropertyValueHistoryErrorCode_ResourceNotFoundException :: BatchGetAssetPropertyValueHistoryErrorCode
- 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 ColumnName where
- ColumnName' { }
- pattern ColumnName_ALIAS :: ColumnName
- pattern ColumnName_ASSET_ID :: ColumnName
- pattern ColumnName_DATA_TYPE :: ColumnName
- pattern ColumnName_PROPERTY_ID :: ColumnName
- pattern ColumnName_QUALITY :: ColumnName
- pattern ColumnName_TIMESTAMP_NANO_OFFSET :: ColumnName
- pattern ColumnName_TIMESTAMP_SECONDS :: ColumnName
- pattern ColumnName_VALUE :: ColumnName
- newtype ComputeLocation where
- ComputeLocation' { }
- pattern ComputeLocation_CLOUD :: ComputeLocation
- pattern ComputeLocation_EDGE :: ComputeLocation
- newtype ConfigurationState where
- newtype DetailedErrorCode where
- newtype DisassociatedDataStorageState 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 JobStatus where
- JobStatus' { }
- pattern JobStatus_CANCELLED :: JobStatus
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_COMPLETED_WITH_FAILURES :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_PENDING :: JobStatus
- pattern JobStatus_RUNNING :: JobStatus
- newtype ListAssetModelPropertiesFilter where
- newtype ListAssetPropertiesFilter where
- newtype ListAssetsFilter where
- ListAssetsFilter' { }
- pattern ListAssetsFilter_ALL :: ListAssetsFilter
- pattern ListAssetsFilter_TOP_LEVEL :: ListAssetsFilter
- newtype ListBulkImportJobsFilter where
- ListBulkImportJobsFilter' { }
- pattern ListBulkImportJobsFilter_ALL :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_CANCELLED :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_COMPLETED :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_COMPLETED_WITH_FAILURES :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_FAILED :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_PENDING :: ListBulkImportJobsFilter
- pattern ListBulkImportJobsFilter_RUNNING :: ListBulkImportJobsFilter
- newtype ListTimeSeriesType where
- 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' (Maybe POSIX) (Maybe POSIX) Text Identity Resource Permission
- newAccessPolicySummary :: Text -> Identity -> Resource -> Permission -> AccessPolicySummary
- data AggregatedValue = AggregatedValue' (Maybe Quality) POSIX Aggregates
- newAggregatedValue :: UTCTime -> Aggregates -> AggregatedValue
- data Aggregates = Aggregates' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newAggregates :: Aggregates
- data Alarms = Alarms' (Maybe Text) Text
- newAlarms :: Text -> Alarms
- data AssetCompositeModel = AssetCompositeModel' (Maybe Text) (Maybe Text) Text Text [AssetProperty]
- newAssetCompositeModel :: Text -> Text -> AssetCompositeModel
- data AssetErrorDetails = AssetErrorDetails' Text AssetErrorCode Text
- newAssetErrorDetails :: Text -> AssetErrorCode -> Text -> AssetErrorDetails
- data AssetHierarchy = AssetHierarchy' (Maybe Text) Text
- newAssetHierarchy :: Text -> AssetHierarchy
- data AssetHierarchyInfo = AssetHierarchyInfo' (Maybe Text) (Maybe Text)
- newAssetHierarchyInfo :: AssetHierarchyInfo
- data AssetModelCompositeModel = AssetModelCompositeModel' (Maybe Text) (Maybe Text) (Maybe [AssetModelProperty]) Text Text
- newAssetModelCompositeModel :: Text -> Text -> AssetModelCompositeModel
- data AssetModelCompositeModelDefinition = AssetModelCompositeModelDefinition' (Maybe Text) (Maybe [AssetModelPropertyDefinition]) Text Text
- newAssetModelCompositeModelDefinition :: Text -> Text -> AssetModelCompositeModelDefinition
- data AssetModelHierarchy = AssetModelHierarchy' (Maybe Text) Text Text
- newAssetModelHierarchy :: Text -> Text -> AssetModelHierarchy
- data AssetModelHierarchyDefinition = AssetModelHierarchyDefinition' Text Text
- newAssetModelHierarchyDefinition :: Text -> Text -> AssetModelHierarchyDefinition
- data AssetModelProperty = AssetModelProperty' (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType
- newAssetModelProperty :: Text -> PropertyDataType -> PropertyType -> AssetModelProperty
- data AssetModelPropertyDefinition = AssetModelPropertyDefinition' (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType
- newAssetModelPropertyDefinition :: Text -> PropertyDataType -> PropertyType -> AssetModelPropertyDefinition
- data AssetModelPropertySummary = AssetModelPropertySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType
- newAssetModelPropertySummary :: Text -> PropertyDataType -> PropertyType -> AssetModelPropertySummary
- data AssetModelStatus = AssetModelStatus' (Maybe ErrorDetails) AssetModelState
- newAssetModelStatus :: AssetModelState -> AssetModelStatus
- data AssetModelSummary = AssetModelSummary' Text Text Text Text POSIX POSIX AssetModelStatus
- newAssetModelSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetModelStatus -> AssetModelSummary
- data AssetProperty = AssetProperty' (Maybe Text) (Maybe Text) (Maybe PropertyNotification) (Maybe Text) Text Text PropertyDataType
- newAssetProperty :: Text -> Text -> PropertyDataType -> AssetProperty
- data AssetPropertySummary = AssetPropertySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PropertyNotification) (Maybe Text)
- newAssetPropertySummary :: AssetPropertySummary
- data AssetPropertyValue = AssetPropertyValue' (Maybe Quality) Variant TimeInNanos
- newAssetPropertyValue :: Variant -> TimeInNanos -> AssetPropertyValue
- data AssetRelationshipSummary = AssetRelationshipSummary' (Maybe AssetHierarchyInfo) AssetRelationshipType
- newAssetRelationshipSummary :: AssetRelationshipType -> AssetRelationshipSummary
- data AssetStatus = AssetStatus' (Maybe ErrorDetails) AssetState
- newAssetStatus :: AssetState -> AssetStatus
- data AssetSummary = AssetSummary' (Maybe Text) Text Text Text Text POSIX POSIX AssetStatus [AssetHierarchy]
- newAssetSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> AssetSummary
- data AssociatedAssetsSummary = AssociatedAssetsSummary' (Maybe Text) Text Text Text Text POSIX POSIX AssetStatus [AssetHierarchy]
- newAssociatedAssetsSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> AssetStatus -> AssociatedAssetsSummary
- data Attribute = Attribute' (Maybe Text)
- newAttribute :: Attribute
- data BatchGetAssetPropertyAggregatesEntry = BatchGetAssetPropertyAggregatesEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe TimeOrdering) Text (NonEmpty AggregateType) Text POSIX POSIX
- newBatchGetAssetPropertyAggregatesEntry :: Text -> NonEmpty AggregateType -> Text -> UTCTime -> UTCTime -> BatchGetAssetPropertyAggregatesEntry
- data BatchGetAssetPropertyAggregatesErrorEntry = BatchGetAssetPropertyAggregatesErrorEntry' BatchGetAssetPropertyAggregatesErrorCode Text Text
- newBatchGetAssetPropertyAggregatesErrorEntry :: BatchGetAssetPropertyAggregatesErrorCode -> Text -> Text -> BatchGetAssetPropertyAggregatesErrorEntry
- data BatchGetAssetPropertyAggregatesErrorInfo = BatchGetAssetPropertyAggregatesErrorInfo' BatchGetAssetPropertyAggregatesErrorCode POSIX
- newBatchGetAssetPropertyAggregatesErrorInfo :: BatchGetAssetPropertyAggregatesErrorCode -> UTCTime -> BatchGetAssetPropertyAggregatesErrorInfo
- data BatchGetAssetPropertyAggregatesSkippedEntry = BatchGetAssetPropertyAggregatesSkippedEntry' (Maybe BatchGetAssetPropertyAggregatesErrorInfo) Text BatchEntryCompletionStatus
- newBatchGetAssetPropertyAggregatesSkippedEntry :: Text -> BatchEntryCompletionStatus -> BatchGetAssetPropertyAggregatesSkippedEntry
- data BatchGetAssetPropertyAggregatesSuccessEntry = BatchGetAssetPropertyAggregatesSuccessEntry' Text [AggregatedValue]
- newBatchGetAssetPropertyAggregatesSuccessEntry :: Text -> BatchGetAssetPropertyAggregatesSuccessEntry
- data BatchGetAssetPropertyValueEntry = BatchGetAssetPropertyValueEntry' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newBatchGetAssetPropertyValueEntry :: Text -> BatchGetAssetPropertyValueEntry
- data BatchGetAssetPropertyValueErrorEntry = BatchGetAssetPropertyValueErrorEntry' BatchGetAssetPropertyValueErrorCode Text Text
- newBatchGetAssetPropertyValueErrorEntry :: BatchGetAssetPropertyValueErrorCode -> Text -> Text -> BatchGetAssetPropertyValueErrorEntry
- data BatchGetAssetPropertyValueErrorInfo = BatchGetAssetPropertyValueErrorInfo' BatchGetAssetPropertyValueErrorCode POSIX
- newBatchGetAssetPropertyValueErrorInfo :: BatchGetAssetPropertyValueErrorCode -> UTCTime -> BatchGetAssetPropertyValueErrorInfo
- data BatchGetAssetPropertyValueHistoryEntry = BatchGetAssetPropertyValueHistoryEntry' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe POSIX) (Maybe TimeOrdering) Text
- newBatchGetAssetPropertyValueHistoryEntry :: Text -> BatchGetAssetPropertyValueHistoryEntry
- data BatchGetAssetPropertyValueHistoryErrorEntry = BatchGetAssetPropertyValueHistoryErrorEntry' BatchGetAssetPropertyValueHistoryErrorCode Text Text
- newBatchGetAssetPropertyValueHistoryErrorEntry :: BatchGetAssetPropertyValueHistoryErrorCode -> Text -> Text -> BatchGetAssetPropertyValueHistoryErrorEntry
- data BatchGetAssetPropertyValueHistoryErrorInfo = BatchGetAssetPropertyValueHistoryErrorInfo' BatchGetAssetPropertyValueHistoryErrorCode POSIX
- newBatchGetAssetPropertyValueHistoryErrorInfo :: BatchGetAssetPropertyValueHistoryErrorCode -> UTCTime -> BatchGetAssetPropertyValueHistoryErrorInfo
- data BatchGetAssetPropertyValueHistorySkippedEntry = BatchGetAssetPropertyValueHistorySkippedEntry' (Maybe BatchGetAssetPropertyValueHistoryErrorInfo) Text BatchEntryCompletionStatus
- newBatchGetAssetPropertyValueHistorySkippedEntry :: Text -> BatchEntryCompletionStatus -> BatchGetAssetPropertyValueHistorySkippedEntry
- data BatchGetAssetPropertyValueHistorySuccessEntry = BatchGetAssetPropertyValueHistorySuccessEntry' Text [AssetPropertyValue]
- newBatchGetAssetPropertyValueHistorySuccessEntry :: Text -> BatchGetAssetPropertyValueHistorySuccessEntry
- data BatchGetAssetPropertyValueSkippedEntry = BatchGetAssetPropertyValueSkippedEntry' (Maybe BatchGetAssetPropertyValueErrorInfo) Text BatchEntryCompletionStatus
- newBatchGetAssetPropertyValueSkippedEntry :: Text -> BatchEntryCompletionStatus -> BatchGetAssetPropertyValueSkippedEntry
- data BatchGetAssetPropertyValueSuccessEntry = BatchGetAssetPropertyValueSuccessEntry' (Maybe AssetPropertyValue) Text
- newBatchGetAssetPropertyValueSuccessEntry :: Text -> BatchGetAssetPropertyValueSuccessEntry
- data BatchPutAssetPropertyError = BatchPutAssetPropertyError' BatchPutAssetPropertyValueErrorCode Text [TimeInNanos]
- newBatchPutAssetPropertyError :: BatchPutAssetPropertyValueErrorCode -> Text -> BatchPutAssetPropertyError
- data BatchPutAssetPropertyErrorEntry = BatchPutAssetPropertyErrorEntry' Text [BatchPutAssetPropertyError]
- newBatchPutAssetPropertyErrorEntry :: Text -> BatchPutAssetPropertyErrorEntry
- data CompositeModelProperty = CompositeModelProperty' (Maybe Text) Text Text Property
- newCompositeModelProperty :: Text -> Text -> Property -> CompositeModelProperty
- data ConfigurationErrorDetails = ConfigurationErrorDetails' ErrorCode Text
- newConfigurationErrorDetails :: ErrorCode -> Text -> ConfigurationErrorDetails
- data ConfigurationStatus = ConfigurationStatus' (Maybe ConfigurationErrorDetails) ConfigurationState
- newConfigurationStatus :: ConfigurationState -> ConfigurationStatus
- data Csv = Csv' (Maybe [ColumnName])
- newCsv :: Csv
- data CustomerManagedS3Storage = CustomerManagedS3Storage' Text Text
- newCustomerManagedS3Storage :: Text -> Text -> CustomerManagedS3Storage
- data DashboardSummary = DashboardSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text Text
- newDashboardSummary :: Text -> Text -> DashboardSummary
- data DetailedError = DetailedError' DetailedErrorCode Text
- newDetailedError :: DetailedErrorCode -> Text -> DetailedError
- data ErrorDetails = ErrorDetails' (Maybe [DetailedError]) ErrorCode Text
- newErrorDetails :: ErrorCode -> Text -> ErrorDetails
- data ErrorReportLocation = ErrorReportLocation' Text Text
- newErrorReportLocation :: Text -> Text -> ErrorReportLocation
- data ExpressionVariable = ExpressionVariable' Text VariableValue
- newExpressionVariable :: Text -> VariableValue -> ExpressionVariable
- data File = File' (Maybe Text) Text Text
- newFile :: Text -> Text -> File
- data FileFormat = FileFormat' (Maybe Csv)
- newFileFormat :: FileFormat
- data ForwardingConfig = ForwardingConfig' ForwardingConfigState
- newForwardingConfig :: ForwardingConfigState -> ForwardingConfig
- data GatewayCapabilitySummary = GatewayCapabilitySummary' Text CapabilitySyncStatus
- newGatewayCapabilitySummary :: Text -> CapabilitySyncStatus -> GatewayCapabilitySummary
- data GatewayPlatform = GatewayPlatform' (Maybe Greengrass) (Maybe GreengrassV2)
- newGatewayPlatform :: GatewayPlatform
- data GatewaySummary = GatewaySummary' (Maybe [GatewayCapabilitySummary]) (Maybe GatewayPlatform) Text Text POSIX POSIX
- newGatewaySummary :: Text -> Text -> UTCTime -> UTCTime -> GatewaySummary
- data Greengrass = Greengrass' Text
- newGreengrass :: Text -> Greengrass
- data GreengrassV2 = GreengrassV2' Text
- newGreengrassV2 :: Text -> GreengrassV2
- data GroupIdentity = GroupIdentity' Text
- newGroupIdentity :: Text -> GroupIdentity
- data IAMRoleIdentity = IAMRoleIdentity' Text
- newIAMRoleIdentity :: Text -> IAMRoleIdentity
- data IAMUserIdentity = IAMUserIdentity' Text
- newIAMUserIdentity :: Text -> IAMUserIdentity
- data Identity = Identity' (Maybe GroupIdentity) (Maybe IAMRoleIdentity) (Maybe IAMUserIdentity) (Maybe UserIdentity)
- newIdentity :: Identity
- data Image = Image' (Maybe ImageFile) (Maybe Text)
- newImage :: Image
- data ImageFile = ImageFile' Base64 ImageFileType
- newImageFile :: ByteString -> ImageFileType -> ImageFile
- data ImageLocation = ImageLocation' Text Text
- newImageLocation :: Text -> Text -> ImageLocation
- data InterpolatedAssetPropertyValue = InterpolatedAssetPropertyValue' TimeInNanos Variant
- newInterpolatedAssetPropertyValue :: TimeInNanos -> Variant -> InterpolatedAssetPropertyValue
- data JobConfiguration = JobConfiguration' FileFormat
- newJobConfiguration :: FileFormat -> JobConfiguration
- data JobSummary = JobSummary' Text Text JobStatus
- newJobSummary :: Text -> Text -> JobStatus -> JobSummary
- data LoggingOptions = LoggingOptions' LoggingLevel
- newLoggingOptions :: LoggingLevel -> LoggingOptions
- data Measurement = Measurement' (Maybe MeasurementProcessingConfig)
- newMeasurement :: Measurement
- data MeasurementProcessingConfig = MeasurementProcessingConfig' ForwardingConfig
- newMeasurementProcessingConfig :: ForwardingConfig -> MeasurementProcessingConfig
- data Metric = Metric' (Maybe MetricProcessingConfig) Text [ExpressionVariable] MetricWindow
- newMetric :: Text -> MetricWindow -> Metric
- data MetricProcessingConfig = MetricProcessingConfig' ComputeLocation
- newMetricProcessingConfig :: ComputeLocation -> MetricProcessingConfig
- data MetricWindow = MetricWindow' (Maybe TumblingWindow)
- newMetricWindow :: MetricWindow
- data MonitorErrorDetails = MonitorErrorDetails' (Maybe MonitorErrorCode) (Maybe Text)
- newMonitorErrorDetails :: MonitorErrorDetails
- data MultiLayerStorage = MultiLayerStorage' CustomerManagedS3Storage
- newMultiLayerStorage :: CustomerManagedS3Storage -> MultiLayerStorage
- data PortalResource = PortalResource' Text
- newPortalResource :: Text -> PortalResource
- data PortalStatus = PortalStatus' (Maybe MonitorErrorDetails) PortalState
- newPortalStatus :: PortalState -> PortalStatus
- data PortalSummary = PortalSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) Text Text Text PortalStatus
- newPortalSummary :: Text -> Text -> Text -> PortalStatus -> PortalSummary
- data ProjectResource = ProjectResource' Text
- newProjectResource :: Text -> ProjectResource
- data ProjectSummary = ProjectSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text Text
- newProjectSummary :: Text -> Text -> ProjectSummary
- data Property = Property' (Maybe Text) (Maybe PropertyNotification) (Maybe PropertyType) (Maybe Text) Text Text PropertyDataType
- newProperty :: Text -> Text -> PropertyDataType -> Property
- data PropertyNotification = PropertyNotification' Text PropertyNotificationState
- newPropertyNotification :: Text -> PropertyNotificationState -> PropertyNotification
- data PropertyType = PropertyType' (Maybe Attribute) (Maybe Measurement) (Maybe Metric) (Maybe Transform)
- newPropertyType :: PropertyType
- data PutAssetPropertyValueEntry = PutAssetPropertyValueEntry' (Maybe Text) (Maybe Text) (Maybe Text) Text [AssetPropertyValue]
- newPutAssetPropertyValueEntry :: Text -> PutAssetPropertyValueEntry
- data Resource = Resource' (Maybe PortalResource) (Maybe ProjectResource)
- newResource :: Resource
- data RetentionPeriod = RetentionPeriod' (Maybe Natural) (Maybe Bool)
- newRetentionPeriod :: RetentionPeriod
- data TimeInNanos = TimeInNanos' (Maybe Natural) Natural
- newTimeInNanos :: Natural -> TimeInNanos
- data TimeSeriesSummary = TimeSeriesSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType POSIX POSIX
- newTimeSeriesSummary :: Text -> PropertyDataType -> UTCTime -> UTCTime -> TimeSeriesSummary
- data Transform = Transform' (Maybe TransformProcessingConfig) Text [ExpressionVariable]
- newTransform :: Text -> Transform
- data TransformProcessingConfig = TransformProcessingConfig' (Maybe ForwardingConfig) ComputeLocation
- newTransformProcessingConfig :: ComputeLocation -> TransformProcessingConfig
- data TumblingWindow = TumblingWindow' (Maybe Text) Text
- newTumblingWindow :: Text -> TumblingWindow
- data UserIdentity = UserIdentity' Text
- newUserIdentity :: Text -> UserIdentity
- data VariableValue = VariableValue' (Maybe Text) Text
- newVariableValue :: Text -> VariableValue
- data Variant = Variant' (Maybe Bool) (Maybe Double) (Maybe Int) (Maybe Text)
- newVariant :: Variant
Service Configuration
defaultService :: Service Source #
API version 2019-12-02 of the Amazon IoT SiteWise SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTSiteWise.
ConflictingOperationException
_ConflictingOperationException :: AsError a => Fold a ServiceError Source #
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold 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.
LimitExceededException
_LimitExceededException :: AsError a => Fold 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.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource can't be found.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The requested service is unavailable.
ThrottlingException
_ThrottlingException :: AsError a => Fold 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.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold 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.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You are not authorized.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
AssetActive
newAssetActive :: Wait DescribeAsset Source #
Polls DescribeAsset every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
AssetModelActive
newAssetModelActive :: Wait DescribeAssetModel Source #
Polls DescribeAssetModel every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
AssetModelNotExists
newAssetModelNotExists :: Wait DescribeAssetModel Source #
Polls DescribeAssetModel every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
AssetNotExists
newAssetNotExists :: Wait DescribeAsset Source #
Polls DescribeAsset every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
PortalActive
newPortalActive :: Wait DescribePortal Source #
Polls DescribePortal every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
PortalNotExists
newPortalNotExists :: Wait DescribePortal Source #
Polls DescribePortal every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateAssets
data AssociateAssets Source #
See: newAssociateAssets smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateAssets |
Create a value of AssociateAssets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:AssociateAssets', associateAssets_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
AssociateAssets, associateAssets_assetId - The ID of the parent asset.
AssociateAssets, associateAssets_hierarchyId - The ID of a hierarchy in the parent asset's model. Hierarchies allow
different groupings of assets to be formed that all come from the same
asset model. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
AssociateAssets, associateAssets_childAssetId - The ID of the child asset to be associated.
data AssociateAssetsResponse Source #
See: newAssociateAssetsResponse smart constructor.
Constructors
| AssociateAssetsResponse' | |
Instances
newAssociateAssetsResponse :: AssociateAssetsResponse Source #
Create a value of AssociateAssetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AssociateTimeSeriesToAssetProperty
data AssociateTimeSeriesToAssetProperty Source #
See: newAssociateTimeSeriesToAssetProperty smart constructor.
Instances
newAssociateTimeSeriesToAssetProperty Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateTimeSeriesToAssetProperty |
Create a value of AssociateTimeSeriesToAssetProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:AssociateTimeSeriesToAssetProperty', associateTimeSeriesToAssetProperty_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
AssociateTimeSeriesToAssetProperty, associateTimeSeriesToAssetProperty_alias - The alias that identifies the time series.
AssociateTimeSeriesToAssetProperty, associateTimeSeriesToAssetProperty_assetId - The ID of the asset in which the asset property was created.
AssociateTimeSeriesToAssetProperty, associateTimeSeriesToAssetProperty_propertyId - The ID of the asset property.
data AssociateTimeSeriesToAssetPropertyResponse Source #
See: newAssociateTimeSeriesToAssetPropertyResponse smart constructor.
Constructors
| AssociateTimeSeriesToAssetPropertyResponse' | |
Instances
| Generic AssociateTimeSeriesToAssetPropertyResponse Source # | |
Defined in Amazonka.IoTSiteWise.AssociateTimeSeriesToAssetProperty Associated Types type Rep AssociateTimeSeriesToAssetPropertyResponse :: Type -> Type # | |
| Read AssociateTimeSeriesToAssetPropertyResponse Source # | |
| Show AssociateTimeSeriesToAssetPropertyResponse Source # | |
| NFData AssociateTimeSeriesToAssetPropertyResponse Source # | |
Defined in Amazonka.IoTSiteWise.AssociateTimeSeriesToAssetProperty Methods | |
| Eq AssociateTimeSeriesToAssetPropertyResponse Source # | |
| type Rep AssociateTimeSeriesToAssetPropertyResponse Source # | |
Defined in Amazonka.IoTSiteWise.AssociateTimeSeriesToAssetProperty type Rep AssociateTimeSeriesToAssetPropertyResponse = D1 ('MetaData "AssociateTimeSeriesToAssetPropertyResponse" "Amazonka.IoTSiteWise.AssociateTimeSeriesToAssetProperty" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "AssociateTimeSeriesToAssetPropertyResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newAssociateTimeSeriesToAssetPropertyResponse :: AssociateTimeSeriesToAssetPropertyResponse Source #
Create a value of AssociateTimeSeriesToAssetPropertyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchAssociateProjectAssets
data BatchAssociateProjectAssets Source #
See: newBatchAssociateProjectAssets smart constructor.
Instances
newBatchAssociateProjectAssets Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchAssociateProjectAssets |
Create a value of BatchAssociateProjectAssets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:BatchAssociateProjectAssets', batchAssociateProjectAssets_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:projectId:BatchAssociateProjectAssets', batchAssociateProjectAssets_projectId - The ID of the project to which to associate the assets.
$sel:assetIds:BatchAssociateProjectAssets', batchAssociateProjectAssets_assetIds - The IDs of the assets to be associated to the project.
data BatchAssociateProjectAssetsResponse Source #
See: newBatchAssociateProjectAssetsResponse smart constructor.
Constructors
| BatchAssociateProjectAssetsResponse' (Maybe [AssetErrorDetails]) Int |
Instances
newBatchAssociateProjectAssetsResponse Source #
Arguments
| :: Int | |
| -> BatchAssociateProjectAssetsResponse |
Create a value of BatchAssociateProjectAssetsResponse 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:
BatchAssociateProjectAssetsResponse, batchAssociateProjectAssetsResponse_errors - A list of associated error information, if any.
$sel:httpStatus:BatchAssociateProjectAssetsResponse', batchAssociateProjectAssetsResponse_httpStatus - The response's http status code.
BatchDisassociateProjectAssets
data BatchDisassociateProjectAssets Source #
See: newBatchDisassociateProjectAssets smart constructor.
Instances
newBatchDisassociateProjectAssets Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchDisassociateProjectAssets |
Create a value of BatchDisassociateProjectAssets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:BatchDisassociateProjectAssets', batchDisassociateProjectAssets_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:projectId:BatchDisassociateProjectAssets', batchDisassociateProjectAssets_projectId - The ID of the project from which to disassociate the assets.
$sel:assetIds:BatchDisassociateProjectAssets', batchDisassociateProjectAssets_assetIds - The IDs of the assets to be disassociated from the project.
data BatchDisassociateProjectAssetsResponse Source #
See: newBatchDisassociateProjectAssetsResponse smart constructor.
Constructors
| BatchDisassociateProjectAssetsResponse' (Maybe [AssetErrorDetails]) Int |
Instances
newBatchDisassociateProjectAssetsResponse Source #
Arguments
| :: Int | |
| -> BatchDisassociateProjectAssetsResponse |
Create a value of BatchDisassociateProjectAssetsResponse 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:
BatchDisassociateProjectAssetsResponse, batchDisassociateProjectAssetsResponse_errors - A list of associated error information, if any.
$sel:httpStatus:BatchDisassociateProjectAssetsResponse', batchDisassociateProjectAssetsResponse_httpStatus - The response's http status code.
BatchGetAssetPropertyAggregates
data BatchGetAssetPropertyAggregates Source #
See: newBatchGetAssetPropertyAggregates smart constructor.
Constructors
| BatchGetAssetPropertyAggregates' (Maybe Natural) (Maybe Text) [BatchGetAssetPropertyAggregatesEntry] |
Instances
newBatchGetAssetPropertyAggregates :: BatchGetAssetPropertyAggregates Source #
Create a value of BatchGetAssetPropertyAggregates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchGetAssetPropertyAggregates', batchGetAssetPropertyAggregates_maxResults - The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first.
- The size of the result set is less than 1 MB.
- The number of data points in the result set is less than the value
of
maxResults. The maximum value ofmaxResultsis 4000.
BatchGetAssetPropertyAggregates, batchGetAssetPropertyAggregates_nextToken - The token to be used for the next set of paginated results.
$sel:entries:BatchGetAssetPropertyAggregates', batchGetAssetPropertyAggregates_entries - The list of asset property aggregate entries for the batch get request.
You can specify up to 16 entries per request.
data BatchGetAssetPropertyAggregatesResponse Source #
See: newBatchGetAssetPropertyAggregatesResponse smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesResponse' (Maybe Text) Int [BatchGetAssetPropertyAggregatesErrorEntry] [BatchGetAssetPropertyAggregatesSuccessEntry] [BatchGetAssetPropertyAggregatesSkippedEntry] |
Instances
newBatchGetAssetPropertyAggregatesResponse Source #
Arguments
| :: Int | |
| -> BatchGetAssetPropertyAggregatesResponse |
Create a value of BatchGetAssetPropertyAggregatesResponse 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:
BatchGetAssetPropertyAggregates, batchGetAssetPropertyAggregatesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_httpStatus - The response's http status code.
$sel:errorEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_errorEntries - A list of the errors (if any) associated with the batch request. Each
error entry contains the entryId of the entry that failed.
$sel:successEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_successEntries - A list of entries that were processed successfully by this batch
request. Each success entry contains the entryId of the entry that
succeeded and the latest query result.
$sel:skippedEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_skippedEntries - A list of entries that were not processed by this batch request. because
these entries had been completely processed by previous paginated
requests. Each skipped entry contains the entryId of the entry that
skipped.
BatchGetAssetPropertyValue
data BatchGetAssetPropertyValue Source #
See: newBatchGetAssetPropertyValue smart constructor.
Constructors
| BatchGetAssetPropertyValue' (Maybe Text) [BatchGetAssetPropertyValueEntry] |
Instances
newBatchGetAssetPropertyValue :: BatchGetAssetPropertyValue Source #
Create a value of BatchGetAssetPropertyValue 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:
BatchGetAssetPropertyValue, batchGetAssetPropertyValue_nextToken - The token to be used for the next set of paginated results.
$sel:entries:BatchGetAssetPropertyValue', batchGetAssetPropertyValue_entries - The list of asset property value entries for the batch get request. You
can specify up to 16 entries per request.
data BatchGetAssetPropertyValueResponse Source #
See: newBatchGetAssetPropertyValueResponse smart constructor.
Constructors
| BatchGetAssetPropertyValueResponse' (Maybe Text) Int [BatchGetAssetPropertyValueErrorEntry] [BatchGetAssetPropertyValueSuccessEntry] [BatchGetAssetPropertyValueSkippedEntry] |
Instances
newBatchGetAssetPropertyValueResponse Source #
Arguments
| :: Int | |
| -> BatchGetAssetPropertyValueResponse |
Create a value of BatchGetAssetPropertyValueResponse 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:
BatchGetAssetPropertyValue, batchGetAssetPropertyValueResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:BatchGetAssetPropertyValueResponse', batchGetAssetPropertyValueResponse_httpStatus - The response's http status code.
$sel:errorEntries:BatchGetAssetPropertyValueResponse', batchGetAssetPropertyValueResponse_errorEntries - A list of the errors (if any) associated with the batch request. Each
error entry contains the entryId of the entry that failed.
$sel:successEntries:BatchGetAssetPropertyValueResponse', batchGetAssetPropertyValueResponse_successEntries - A list of entries that were processed successfully by this batch
request. Each success entry contains the entryId of the entry that
succeeded and the latest query result.
$sel:skippedEntries:BatchGetAssetPropertyValueResponse', batchGetAssetPropertyValueResponse_skippedEntries - A list of entries that were not processed by this batch request. because
these entries had been completely processed by previous paginated
requests. Each skipped entry contains the entryId of the entry that
skipped.
BatchGetAssetPropertyValueHistory
data BatchGetAssetPropertyValueHistory Source #
See: newBatchGetAssetPropertyValueHistory smart constructor.
Constructors
| BatchGetAssetPropertyValueHistory' (Maybe Natural) (Maybe Text) [BatchGetAssetPropertyValueHistoryEntry] |
Instances
newBatchGetAssetPropertyValueHistory :: BatchGetAssetPropertyValueHistory Source #
Create a value of BatchGetAssetPropertyValueHistory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:BatchGetAssetPropertyValueHistory', batchGetAssetPropertyValueHistory_maxResults - The maximum number of results to return for each paginated request. A
result set is returned in the two cases, whichever occurs first.
- The size of the result set is less than 1 MB.
- The number of data points in the result set is less than the value
of
maxResults. The maximum value ofmaxResultsis 4000.
BatchGetAssetPropertyValueHistory, batchGetAssetPropertyValueHistory_nextToken - The token to be used for the next set of paginated results.
$sel:entries:BatchGetAssetPropertyValueHistory', batchGetAssetPropertyValueHistory_entries - The list of asset property historical value entries for the batch get
request. You can specify up to 16 entries per request.
data BatchGetAssetPropertyValueHistoryResponse Source #
See: newBatchGetAssetPropertyValueHistoryResponse smart constructor.
Constructors
Instances
newBatchGetAssetPropertyValueHistoryResponse Source #
Arguments
| :: Int | |
| -> BatchGetAssetPropertyValueHistoryResponse |
Create a value of BatchGetAssetPropertyValueHistoryResponse 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:
BatchGetAssetPropertyValueHistory, batchGetAssetPropertyValueHistoryResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_httpStatus - The response's http status code.
$sel:errorEntries:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_errorEntries - A list of the errors (if any) associated with the batch request. Each
error entry contains the entryId of the entry that failed.
$sel:successEntries:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_successEntries - A list of entries that were processed successfully by this batch
request. Each success entry contains the entryId of the entry that
succeeded and the latest query result.
$sel:skippedEntries:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_skippedEntries - A list of entries that were not processed by this batch request. because
these entries had been completely processed by previous paginated
requests. Each skipped entry contains the entryId of the entry that
skipped.
BatchPutAssetPropertyValue
data BatchPutAssetPropertyValue Source #
See: newBatchPutAssetPropertyValue smart constructor.
Constructors
| BatchPutAssetPropertyValue' [PutAssetPropertyValueEntry] |
Instances
newBatchPutAssetPropertyValue :: BatchPutAssetPropertyValue Source #
Create a value of BatchPutAssetPropertyValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entries:BatchPutAssetPropertyValue', batchPutAssetPropertyValue_entries - The list of asset property value entries for the batch put request. You
can specify up to 10 entries per request.
data BatchPutAssetPropertyValueResponse Source #
See: newBatchPutAssetPropertyValueResponse smart constructor.
Instances
newBatchPutAssetPropertyValueResponse Source #
Arguments
| :: Int | |
| -> BatchPutAssetPropertyValueResponse |
Create a value of BatchPutAssetPropertyValueResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchPutAssetPropertyValueResponse', batchPutAssetPropertyValueResponse_httpStatus - The response's http status code.
$sel:errorEntries:BatchPutAssetPropertyValueResponse', batchPutAssetPropertyValueResponse_errorEntries - A list of the errors (if any) associated with the batch put request.
Each error entry contains the entryId of the entry that failed.
CreateAccessPolicy
data CreateAccessPolicy Source #
See: newCreateAccessPolicy smart constructor.
Constructors
| CreateAccessPolicy' (Maybe Text) (Maybe (HashMap Text Text)) Identity Resource Permission |
Instances
newCreateAccessPolicy Source #
Arguments
| :: Identity | |
| -> Resource | |
| -> Permission | |
| -> CreateAccessPolicy |
Create a value of CreateAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateAccessPolicy', createAccessPolicy_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:tags:CreateAccessPolicy', createAccessPolicy_tags - A list of key-value pairs that contain metadata for the access policy.
For more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:accessPolicyIdentity:CreateAccessPolicy', createAccessPolicy_accessPolicyIdentity - The identity for this access policy. Choose an IAM Identity Center user,
an IAM Identity Center group, or an IAM user.
$sel:accessPolicyResource:CreateAccessPolicy', createAccessPolicy_accessPolicyResource - The IoT SiteWise Monitor resource for this access policy. Choose either
a portal or a project.
$sel:accessPolicyPermission:CreateAccessPolicy', createAccessPolicy_accessPolicyPermission - The permission level for this access policy. Note that a project
ADMINISTRATOR is also known as a project owner.
data CreateAccessPolicyResponse Source #
See: newCreateAccessPolicyResponse smart constructor.
Constructors
| CreateAccessPolicyResponse' Int Text Text |
Instances
newCreateAccessPolicyResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateAccessPolicyResponse |
Create a value of CreateAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAccessPolicyResponse', createAccessPolicyResponse_httpStatus - The response's http status code.
$sel:accessPolicyId:CreateAccessPolicyResponse', createAccessPolicyResponse_accessPolicyId - The ID of the access policy.
$sel:accessPolicyArn:CreateAccessPolicyResponse', createAccessPolicyResponse_accessPolicyArn - The
ARN
of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}CreateAsset
data CreateAsset Source #
See: newCreateAsset smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateAsset |
Create a value of CreateAsset 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:assetDescription:CreateAsset', createAsset_assetDescription - A description for the asset.
$sel:clientToken:CreateAsset', createAsset_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:tags:CreateAsset', createAsset_tags - A list of key-value pairs that contain metadata for the asset. For more
information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:assetName:CreateAsset', createAsset_assetName - A friendly name for the asset.
CreateAsset, createAsset_assetModelId - The ID of the asset model from which to create the asset.
data CreateAssetResponse Source #
See: newCreateAssetResponse smart constructor.
Constructors
| CreateAssetResponse' Int Text Text AssetStatus |
Instances
newCreateAssetResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> AssetStatus | |
| -> CreateAssetResponse |
Create a value of CreateAssetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAssetResponse', createAssetResponse_httpStatus - The response's http status code.
CreateAssetResponse, createAssetResponse_assetId - The ID of the asset. This ID uniquely identifies the asset within IoT
SiteWise and can be used with other IoT SiteWise APIs.
$sel:assetArn:CreateAssetResponse', createAssetResponse_assetArn - The
ARN
of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}$sel:assetStatus:CreateAssetResponse', createAssetResponse_assetStatus - The status of the asset, which contains a state (CREATING after
successfully calling this operation) and any error message.
CreateAssetModel
data CreateAssetModel Source #
See: newCreateAssetModel smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> CreateAssetModel |
Create a value of CreateAssetModel 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:assetModelCompositeModels:CreateAssetModel', createAssetModel_assetModelCompositeModels - The composite asset models that are part of this asset model. Composite
asset models are asset models that contain specific properties. Each
composite model has a type that defines the properties that the
composite model supports. Use composite asset models to define alarms on
this asset model.
$sel:assetModelDescription:CreateAssetModel', createAssetModel_assetModelDescription - A description for the asset model.
$sel:assetModelHierarchies:CreateAssetModel', createAssetModel_assetModelHierarchies - The hierarchy definitions of the asset model. Each hierarchy specifies
an asset model whose assets can be children of any other assets created
from this asset model. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
$sel:assetModelProperties:CreateAssetModel', createAssetModel_assetModelProperties - The property definitions of the asset model. For more information, see
Asset properties
in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
$sel:clientToken:CreateAssetModel', createAssetModel_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:tags:CreateAssetModel', createAssetModel_tags - A list of key-value pairs that contain metadata for the asset model. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:assetModelName:CreateAssetModel', createAssetModel_assetModelName - A unique, friendly name for the asset model.
data CreateAssetModelResponse Source #
See: newCreateAssetModelResponse smart constructor.
Constructors
| CreateAssetModelResponse' Int Text Text AssetModelStatus |
Instances
newCreateAssetModelResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> AssetModelStatus | |
| -> CreateAssetModelResponse |
Create a value of CreateAssetModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAssetModelResponse', createAssetModelResponse_httpStatus - The response's http status code.
CreateAssetModelResponse, createAssetModelResponse_assetModelId - The ID of the asset model. You can use this ID when you call other IoT
SiteWise APIs.
$sel:assetModelArn:CreateAssetModelResponse', createAssetModelResponse_assetModelArn - The
ARN
of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}$sel:assetModelStatus:CreateAssetModelResponse', createAssetModelResponse_assetModelStatus - The status of the asset model, which contains a state (CREATING after
successfully calling this operation) and any error message.
CreateBulkImportJob
data CreateBulkImportJob Source #
See: newCreateBulkImportJob smart constructor.
Constructors
| CreateBulkImportJob' Text Text [File] ErrorReportLocation JobConfiguration |
Instances
newCreateBulkImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> ErrorReportLocation | |
| -> JobConfiguration | |
| -> CreateBulkImportJob |
Create a value of CreateBulkImportJob 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:
CreateBulkImportJob, createBulkImportJob_jobName - The unique name that helps identify the job request.
$sel:jobRoleArn:CreateBulkImportJob', createBulkImportJob_jobRoleArn - The
ARN
of the IAM role that allows IoT SiteWise to read Amazon S3 data.
$sel:files:CreateBulkImportJob', createBulkImportJob_files - The files in the specified Amazon S3 bucket that contain your data.
$sel:errorReportLocation:CreateBulkImportJob', createBulkImportJob_errorReportLocation - The Amazon S3 destination where errors associated with the job creation
request are saved.
$sel:jobConfiguration:CreateBulkImportJob', createBulkImportJob_jobConfiguration - Contains the configuration information of a job, such as the file format
used to save data in Amazon S3.
data CreateBulkImportJobResponse Source #
See: newCreateBulkImportJobResponse smart constructor.
Constructors
| CreateBulkImportJobResponse' Int Text Text JobStatus |
Instances
newCreateBulkImportJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> JobStatus | |
| -> CreateBulkImportJobResponse |
Create a value of CreateBulkImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBulkImportJobResponse', createBulkImportJobResponse_httpStatus - The response's http status code.
$sel:jobId:CreateBulkImportJobResponse', createBulkImportJobResponse_jobId - The ID of the job.
CreateBulkImportJob, createBulkImportJobResponse_jobName - The unique name that helps identify the job request.
$sel:jobStatus:CreateBulkImportJobResponse', createBulkImportJobResponse_jobStatus - The status of the bulk import job can be one of following values.
PENDING– IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED– The bulk import job has been canceled.RUNNING– IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED– IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED– IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES– IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
CreateDashboard
data CreateDashboard Source #
See: newCreateDashboard smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateDashboard |
Create a value of CreateDashboard with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateDashboard', createDashboard_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:dashboardDescription:CreateDashboard', createDashboard_dashboardDescription - A description for the dashboard.
$sel:tags:CreateDashboard', createDashboard_tags - A list of key-value pairs that contain metadata for the dashboard. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:projectId:CreateDashboard', createDashboard_projectId - The ID of the project in which to create the dashboard.
$sel:dashboardName:CreateDashboard', createDashboard_dashboardName - A friendly name for the dashboard.
$sel:dashboardDefinition:CreateDashboard', createDashboard_dashboardDefinition - The dashboard definition specified in a JSON literal. For detailed
information, see
Creating dashboards (CLI)
in the IoT SiteWise User Guide.
data CreateDashboardResponse Source #
See: newCreateDashboardResponse smart constructor.
Constructors
| CreateDashboardResponse' Int Text Text |
Instances
newCreateDashboardResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateDashboardResponse |
Create a value of CreateDashboardResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDashboardResponse', createDashboardResponse_httpStatus - The response's http status code.
$sel:dashboardId:CreateDashboardResponse', createDashboardResponse_dashboardId - The ID of the dashboard.
$sel:dashboardArn:CreateDashboardResponse', createDashboardResponse_dashboardArn - The
ARN
of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}CreateGateway
data CreateGateway Source #
See: newCreateGateway smart constructor.
Constructors
| CreateGateway' (Maybe (HashMap Text Text)) Text GatewayPlatform |
Instances
Arguments
| :: Text | |
| -> GatewayPlatform | |
| -> CreateGateway |
Create a value of CreateGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateGateway', createGateway_tags - A list of key-value pairs that contain metadata for the gateway. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
CreateGateway, createGateway_gatewayName - A unique, friendly name for the gateway.
CreateGateway, createGateway_gatewayPlatform - The gateway's platform. You can only specify one platform in a gateway.
data CreateGatewayResponse Source #
See: newCreateGatewayResponse smart constructor.
Constructors
| CreateGatewayResponse' Int Text Text |
Instances
newCreateGatewayResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateGatewayResponse |
Create a value of CreateGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateGatewayResponse', createGatewayResponse_httpStatus - The response's http status code.
CreateGatewayResponse, createGatewayResponse_gatewayId - The ID of the gateway device. You can use this ID when you call other
IoT SiteWise APIs.
$sel:gatewayArn:CreateGatewayResponse', createGatewayResponse_gatewayArn - The
ARN
of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}CreatePortal
data CreatePortal Source #
See: newCreatePortal smart constructor.
Constructors
| CreatePortal' (Maybe Alarms) (Maybe Text) (Maybe Text) (Maybe AuthMode) (Maybe Text) (Maybe ImageFile) (Maybe (HashMap Text Text)) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreatePortal |
Create a value of CreatePortal 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:alarms:CreatePortal', createPortal_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.
$sel:clientToken:CreatePortal', createPortal_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:notificationSenderEmail:CreatePortal', createPortal_notificationSenderEmail - The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
$sel:portalAuthMode:CreatePortal', createPortal_portalAuthMode - The service to use to authenticate users to the portal. Choose from the
following options:
SSO– The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.IAM– The portal uses Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.
Default: SSO
$sel:portalDescription:CreatePortal', createPortal_portalDescription - A description for the portal.
$sel:portalLogoImageFile:CreatePortal', createPortal_portalLogoImageFile - A logo image to display in the portal. Upload a square, high-resolution
image. The image is displayed on a dark background.
$sel:tags:CreatePortal', createPortal_tags - A list of key-value pairs that contain metadata for the portal. For more
information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:portalName:CreatePortal', createPortal_portalName - A friendly name for the portal.
$sel:portalContactEmail:CreatePortal', createPortal_portalContactEmail - The Amazon Web Services administrator's contact email address.
CreatePortal, createPortal_roleArn - The
ARN
of a 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.
data CreatePortalResponse Source #
See: newCreatePortalResponse smart constructor.
Constructors
| CreatePortalResponse' Int Text Text Text PortalStatus Text |
Instances
newCreatePortalResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> PortalStatus | |
| -> Text | |
| -> CreatePortalResponse |
Create a value of CreatePortalResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreatePortalResponse', createPortalResponse_httpStatus - The response's http status code.
$sel:portalId:CreatePortalResponse', createPortalResponse_portalId - The ID of the created portal.
$sel:portalArn:CreatePortalResponse', createPortalResponse_portalArn - The
ARN
of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}$sel:portalStartUrl:CreatePortalResponse', createPortalResponse_portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to
access portals that use IAM Identity Center 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:portalStatus:CreatePortalResponse', createPortalResponse_portalStatus - The status of the portal, which contains a state (CREATING after
successfully calling this operation) and any error message.
$sel:ssoApplicationId:CreatePortalResponse', createPortalResponse_ssoApplicationId - The associated IAM Identity Center application ID, if the portal uses
IAM Identity Center.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Instances
Create a value of CreateProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateProject', createProject_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:projectDescription:CreateProject', createProject_projectDescription - A description for the project.
$sel:tags:CreateProject', createProject_tags - A list of key-value pairs that contain metadata for the project. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:portalId:CreateProject', createProject_portalId - The ID of the portal in which to create the project.
$sel:projectName:CreateProject', createProject_projectName - A friendly name for the project.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Constructors
| CreateProjectResponse' Int Text Text |
Instances
newCreateProjectResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateProjectResponse |
Create a value of CreateProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
$sel:projectId:CreateProjectResponse', createProjectResponse_projectId - The ID of the project.
$sel:projectArn:CreateProjectResponse', createProjectResponse_projectArn - The
ARN
of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}DeleteAccessPolicy
data DeleteAccessPolicy Source #
See: newDeleteAccessPolicy smart constructor.
Constructors
| DeleteAccessPolicy' (Maybe Text) Text |
Instances
newDeleteAccessPolicy Source #
Create a value of DeleteAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteAccessPolicy', deleteAccessPolicy_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:accessPolicyId:DeleteAccessPolicy', deleteAccessPolicy_accessPolicyId - The ID of the access policy to be deleted.
data DeleteAccessPolicyResponse Source #
See: newDeleteAccessPolicyResponse smart constructor.
Constructors
| DeleteAccessPolicyResponse' Int |
Instances
newDeleteAccessPolicyResponse Source #
Create a value of DeleteAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAccessPolicyResponse', deleteAccessPolicyResponse_httpStatus - The response's http status code.
DeleteAsset
data DeleteAsset Source #
See: newDeleteAsset smart constructor.
Constructors
| DeleteAsset' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteAsset |
Create a value of DeleteAsset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteAsset', deleteAsset_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DeleteAsset, deleteAsset_assetId - The ID of the asset to delete.
data DeleteAssetResponse Source #
See: newDeleteAssetResponse smart constructor.
Constructors
| DeleteAssetResponse' Int AssetStatus |
Instances
newDeleteAssetResponse Source #
Arguments
| :: Int | |
| -> AssetStatus | |
| -> DeleteAssetResponse |
Create a value of DeleteAssetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAssetResponse', deleteAssetResponse_httpStatus - The response's http status code.
$sel:assetStatus:DeleteAssetResponse', deleteAssetResponse_assetStatus - The status of the asset, which contains a state (DELETING after
successfully calling this operation) and any error message.
DeleteAssetModel
data DeleteAssetModel Source #
See: newDeleteAssetModel smart constructor.
Constructors
| DeleteAssetModel' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteAssetModel |
Create a value of DeleteAssetModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteAssetModel', deleteAssetModel_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DeleteAssetModel, deleteAssetModel_assetModelId - The ID of the asset model to delete.
data DeleteAssetModelResponse Source #
See: newDeleteAssetModelResponse smart constructor.
Constructors
| DeleteAssetModelResponse' Int AssetModelStatus |
Instances
newDeleteAssetModelResponse Source #
Arguments
| :: Int | |
| -> AssetModelStatus | |
| -> DeleteAssetModelResponse |
Create a value of DeleteAssetModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAssetModelResponse', deleteAssetModelResponse_httpStatus - The response's http status code.
$sel:assetModelStatus:DeleteAssetModelResponse', deleteAssetModelResponse_assetModelStatus - The status of the asset model, which contains a state (DELETING after
successfully calling this operation) and any error message.
DeleteDashboard
data DeleteDashboard Source #
See: newDeleteDashboard smart constructor.
Constructors
| DeleteDashboard' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteDashboard |
Create a value of DeleteDashboard with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteDashboard', deleteDashboard_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:dashboardId:DeleteDashboard', deleteDashboard_dashboardId - The ID of the dashboard to delete.
data DeleteDashboardResponse Source #
See: newDeleteDashboardResponse smart constructor.
Constructors
| DeleteDashboardResponse' Int |
Instances
newDeleteDashboardResponse Source #
Create a value of DeleteDashboardResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDashboardResponse', deleteDashboardResponse_httpStatus - The response's http status code.
DeleteGateway
data DeleteGateway Source #
See: newDeleteGateway smart constructor.
Constructors
| DeleteGateway' Text |
Instances
Arguments
| :: Text | |
| -> DeleteGateway |
Create a value of DeleteGateway 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:
DeleteGateway, deleteGateway_gatewayId - The ID of the gateway to delete.
data DeleteGatewayResponse Source #
See: newDeleteGatewayResponse smart constructor.
Constructors
| DeleteGatewayResponse' | |
Instances
newDeleteGatewayResponse :: DeleteGatewayResponse Source #
Create a value of DeleteGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePortal
data DeletePortal Source #
See: newDeletePortal smart constructor.
Constructors
| DeletePortal' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeletePortal |
Create a value of DeletePortal with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeletePortal', deletePortal_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:portalId:DeletePortal', deletePortal_portalId - The ID of the portal to delete.
data DeletePortalResponse Source #
See: newDeletePortalResponse smart constructor.
Constructors
| DeletePortalResponse' Int PortalStatus |
Instances
newDeletePortalResponse Source #
Arguments
| :: Int | |
| -> PortalStatus | |
| -> DeletePortalResponse |
Create a value of DeletePortalResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeletePortalResponse', deletePortalResponse_httpStatus - The response's http status code.
$sel:portalStatus:DeletePortalResponse', deletePortalResponse_portalStatus - The status of the portal, which contains a state (DELETING after
successfully calling this operation) and any error message.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Constructors
| DeleteProject' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteProject |
Create a value of DeleteProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteProject', deleteProject_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:projectId:DeleteProject', deleteProject_projectId - The ID of the project.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Constructors
| DeleteProjectResponse' Int |
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
DeleteTimeSeries
data DeleteTimeSeries Source #
See: newDeleteTimeSeries smart constructor.
Instances
newDeleteTimeSeries :: DeleteTimeSeries Source #
Create a value of DeleteTimeSeries 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:
DeleteTimeSeries, deleteTimeSeries_alias - The alias that identifies the time series.
DeleteTimeSeries, deleteTimeSeries_assetId - The ID of the asset in which the asset property was created.
$sel:clientToken:DeleteTimeSeries', deleteTimeSeries_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DeleteTimeSeries, deleteTimeSeries_propertyId - The ID of the asset property.
data DeleteTimeSeriesResponse Source #
See: newDeleteTimeSeriesResponse smart constructor.
Constructors
| DeleteTimeSeriesResponse' | |
Instances
newDeleteTimeSeriesResponse :: DeleteTimeSeriesResponse Source #
Create a value of DeleteTimeSeriesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAccessPolicy
data DescribeAccessPolicy Source #
See: newDescribeAccessPolicy smart constructor.
Constructors
| DescribeAccessPolicy' Text |
Instances
newDescribeAccessPolicy Source #
Arguments
| :: Text | |
| -> DescribeAccessPolicy |
Create a value of DescribeAccessPolicy 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:
DescribeAccessPolicy, describeAccessPolicy_accessPolicyId - The ID of the access policy.
data DescribeAccessPolicyResponse Source #
See: newDescribeAccessPolicyResponse smart constructor.
Constructors
| DescribeAccessPolicyResponse' Int Text Text Identity Resource Permission POSIX POSIX |
Instances
newDescribeAccessPolicyResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Identity | |
| -> Resource | |
| -> Permission | |
| -> UTCTime | |
| -> UTCTime |
|
| -> DescribeAccessPolicyResponse |
Create a value of DescribeAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAccessPolicyResponse', describeAccessPolicyResponse_httpStatus - The response's http status code.
DescribeAccessPolicy, describeAccessPolicyResponse_accessPolicyId - The ID of the access policy.
$sel:accessPolicyArn:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyArn - The
ARN
of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}$sel:accessPolicyIdentity:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyIdentity - The identity (IAM Identity Center user, IAM Identity Center group, or
IAM user) to which this access policy applies.
$sel:accessPolicyResource:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyResource - The IoT SiteWise Monitor resource (portal or project) to which this
access policy provides access.
$sel:accessPolicyPermission:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyPermission - The access policy permission. Note that a project ADMINISTRATOR is
also known as a project owner.
$sel:accessPolicyCreationDate:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyCreationDate - The date the access policy was created, in Unix epoch time.
$sel:accessPolicyLastUpdateDate:DescribeAccessPolicyResponse', describeAccessPolicyResponse_accessPolicyLastUpdateDate - The date the access policy was last updated, in Unix epoch time.
DescribeAsset
data DescribeAsset Source #
See: newDescribeAsset smart constructor.
Constructors
| DescribeAsset' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DescribeAsset |
Create a value of DescribeAsset 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:excludeProperties:DescribeAsset', describeAsset_excludeProperties - Whether or not to exclude asset properties from the response.
DescribeAsset, describeAsset_assetId - The ID of the asset.
data DescribeAssetResponse Source #
See: newDescribeAssetResponse smart constructor.
Constructors
| DescribeAssetResponse' (Maybe [AssetCompositeModel]) (Maybe Text) Int Text Text Text Text [AssetProperty] [AssetHierarchy] POSIX POSIX AssetStatus |
Instances
newDescribeAssetResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetStatus | |
| -> DescribeAssetResponse |
Create a value of DescribeAssetResponse 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:assetCompositeModels:DescribeAssetResponse', describeAssetResponse_assetCompositeModels - The composite models for the asset.
$sel:assetDescription:DescribeAssetResponse', describeAssetResponse_assetDescription - A description for the asset.
$sel:httpStatus:DescribeAssetResponse', describeAssetResponse_httpStatus - The response's http status code.
DescribeAsset, describeAssetResponse_assetId - The ID of the asset.
$sel:assetArn:DescribeAssetResponse', describeAssetResponse_assetArn - The
ARN
of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}$sel:assetName:DescribeAssetResponse', describeAssetResponse_assetName - The name of the asset.
DescribeAssetResponse, describeAssetResponse_assetModelId - The ID of the asset model that was used to create the asset.
$sel:assetProperties:DescribeAssetResponse', describeAssetResponse_assetProperties - The list of asset properties for the asset.
This object doesn't include properties that you define in composite
models. You can find composite model properties in the
assetCompositeModels object.
$sel:assetHierarchies:DescribeAssetResponse', describeAssetResponse_assetHierarchies - A list of asset hierarchies that each contain a hierarchyId. A
hierarchy specifies allowed parent/child asset relationships.
$sel:assetCreationDate:DescribeAssetResponse', describeAssetResponse_assetCreationDate - The date the asset was created, in Unix epoch time.
$sel:assetLastUpdateDate:DescribeAssetResponse', describeAssetResponse_assetLastUpdateDate - The date the asset was last updated, in Unix epoch time.
$sel:assetStatus:DescribeAssetResponse', describeAssetResponse_assetStatus - The current status of the asset, which contains a state and any error
message.
DescribeAssetModel
data DescribeAssetModel Source #
See: newDescribeAssetModel smart constructor.
Constructors
| DescribeAssetModel' (Maybe Bool) Text |
Instances
newDescribeAssetModel Source #
Arguments
| :: Text | |
| -> DescribeAssetModel |
Create a value of DescribeAssetModel 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:excludeProperties:DescribeAssetModel', describeAssetModel_excludeProperties - Whether or not to exclude asset model properties from the response.
DescribeAssetModel, describeAssetModel_assetModelId - The ID of the asset model.
data DescribeAssetModelResponse Source #
See: newDescribeAssetModelResponse smart constructor.
Constructors
| DescribeAssetModelResponse' (Maybe [AssetModelCompositeModel]) Int Text Text Text Text [AssetModelProperty] [AssetModelHierarchy] POSIX POSIX AssetModelStatus |
Instances
newDescribeAssetModelResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> AssetModelStatus | |
| -> DescribeAssetModelResponse |
Create a value of DescribeAssetModelResponse 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:assetModelCompositeModels:DescribeAssetModelResponse', describeAssetModelResponse_assetModelCompositeModels - The list of composite asset models for the asset model.
$sel:httpStatus:DescribeAssetModelResponse', describeAssetModelResponse_httpStatus - The response's http status code.
DescribeAssetModel, describeAssetModelResponse_assetModelId - The ID of the asset model.
$sel:assetModelArn:DescribeAssetModelResponse', describeAssetModelResponse_assetModelArn - The
ARN
of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}$sel:assetModelName:DescribeAssetModelResponse', describeAssetModelResponse_assetModelName - The name of the asset model.
$sel:assetModelDescription:DescribeAssetModelResponse', describeAssetModelResponse_assetModelDescription - The asset model's description.
$sel:assetModelProperties:DescribeAssetModelResponse', describeAssetModelResponse_assetModelProperties - The list of asset properties for the asset model.
This object doesn't include properties that you define in composite
models. You can find composite model properties in the
assetModelCompositeModels object.
$sel:assetModelHierarchies:DescribeAssetModelResponse', describeAssetModelResponse_assetModelHierarchies - A list of asset model hierarchies that each contain a
childAssetModelId and a hierarchyId (named id). A hierarchy
specifies allowed parent/child asset relationships for an asset model.
$sel:assetModelCreationDate:DescribeAssetModelResponse', describeAssetModelResponse_assetModelCreationDate - The date the asset model was created, in Unix epoch time.
$sel:assetModelLastUpdateDate:DescribeAssetModelResponse', describeAssetModelResponse_assetModelLastUpdateDate - The date the asset model was last updated, in Unix epoch time.
$sel:assetModelStatus:DescribeAssetModelResponse', describeAssetModelResponse_assetModelStatus - The current status of the asset model, which contains a state and any
error message.
DescribeAssetProperty
data DescribeAssetProperty Source #
See: newDescribeAssetProperty smart constructor.
Constructors
| DescribeAssetProperty' Text Text |
Instances
newDescribeAssetProperty Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeAssetProperty |
Create a value of DescribeAssetProperty 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:
DescribeAssetProperty, describeAssetProperty_assetId - The ID of the asset.
DescribeAssetProperty, describeAssetProperty_propertyId - The ID of the asset property.
data DescribeAssetPropertyResponse Source #
See: newDescribeAssetPropertyResponse smart constructor.
Constructors
| DescribeAssetPropertyResponse' (Maybe Property) (Maybe CompositeModelProperty) Int Text Text Text |
Instances
newDescribeAssetPropertyResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> DescribeAssetPropertyResponse |
Create a value of DescribeAssetPropertyResponse 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:
DescribeAssetPropertyResponse, describeAssetPropertyResponse_assetProperty - The asset property's definition, alias, and notification state.
This response includes this object for normal asset properties. If you
describe an asset property in a composite model, this response includes
the asset property information in compositeModel.
$sel:compositeModel:DescribeAssetPropertyResponse', describeAssetPropertyResponse_compositeModel - The composite asset model that declares this asset property, if this
asset property exists in a composite model.
$sel:httpStatus:DescribeAssetPropertyResponse', describeAssetPropertyResponse_httpStatus - The response's http status code.
DescribeAssetProperty, describeAssetPropertyResponse_assetId - The ID of the asset.
$sel:assetName:DescribeAssetPropertyResponse', describeAssetPropertyResponse_assetName - The name of the asset.
DescribeAssetPropertyResponse, describeAssetPropertyResponse_assetModelId - The ID of the asset model.
DescribeBulkImportJob
data DescribeBulkImportJob Source #
See: newDescribeBulkImportJob smart constructor.
Constructors
| DescribeBulkImportJob' Text |
Instances
newDescribeBulkImportJob Source #
Arguments
| :: Text | |
| -> DescribeBulkImportJob |
Create a value of DescribeBulkImportJob 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:
DescribeBulkImportJob, describeBulkImportJob_jobId - The ID of the job.
data DescribeBulkImportJobResponse Source #
See: newDescribeBulkImportJobResponse smart constructor.
Constructors
| DescribeBulkImportJobResponse' Int Text Text JobStatus Text [File] ErrorReportLocation JobConfiguration POSIX POSIX |
Instances
newDescribeBulkImportJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> JobStatus | |
| -> Text | |
| -> ErrorReportLocation | |
| -> JobConfiguration | |
| -> UTCTime | |
| -> UTCTime | |
| -> DescribeBulkImportJobResponse |
Create a value of DescribeBulkImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeBulkImportJobResponse', describeBulkImportJobResponse_httpStatus - The response's http status code.
DescribeBulkImportJob, describeBulkImportJobResponse_jobId - The ID of the job.
$sel:jobName:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobName - The unique name that helps identify the job request.
$sel:jobStatus:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobStatus - The status of the bulk import job can be one of following values.
PENDING– IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED– The bulk import job has been canceled.RUNNING– IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED– IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED– IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES– IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
$sel:jobRoleArn:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobRoleArn - The
ARN
of the IAM role that allows IoT SiteWise to read Amazon S3 data.
$sel:files:DescribeBulkImportJobResponse', describeBulkImportJobResponse_files - The files in the specified Amazon S3 bucket that contain your data.
$sel:errorReportLocation:DescribeBulkImportJobResponse', describeBulkImportJobResponse_errorReportLocation - The Amazon S3 destination where errors associated with the job creation
request are saved.
$sel:jobConfiguration:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobConfiguration - Contains the configuration information of a job, such as the file format
used to save data in Amazon S3.
$sel:jobCreationDate:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobCreationDate - The date the job was created, in Unix epoch TIME.
$sel:jobLastUpdateDate:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobLastUpdateDate - The date the job was last updated, in Unix epoch time.
DescribeDashboard
data DescribeDashboard Source #
See: newDescribeDashboard smart constructor.
Constructors
| DescribeDashboard' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDashboard |
Create a value of DescribeDashboard 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:
DescribeDashboard, describeDashboard_dashboardId - The ID of the dashboard.
data DescribeDashboardResponse Source #
See: newDescribeDashboardResponse smart constructor.
Instances
newDescribeDashboardResponse Source #
Create a value of DescribeDashboardResponse 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:dashboardDescription:DescribeDashboardResponse', describeDashboardResponse_dashboardDescription - The dashboard's description.
$sel:httpStatus:DescribeDashboardResponse', describeDashboardResponse_httpStatus - The response's http status code.
DescribeDashboard, describeDashboardResponse_dashboardId - The ID of the dashboard.
$sel:dashboardArn:DescribeDashboardResponse', describeDashboardResponse_dashboardArn - The
ARN
of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}$sel:dashboardName:DescribeDashboardResponse', describeDashboardResponse_dashboardName - The name of the dashboard.
$sel:projectId:DescribeDashboardResponse', describeDashboardResponse_projectId - The ID of the project that the dashboard is in.
$sel:dashboardDefinition:DescribeDashboardResponse', describeDashboardResponse_dashboardDefinition - The dashboard's definition JSON literal. For detailed information, see
Creating dashboards (CLI)
in the IoT SiteWise User Guide.
$sel:dashboardCreationDate:DescribeDashboardResponse', describeDashboardResponse_dashboardCreationDate - The date the dashboard was created, in Unix epoch time.
$sel:dashboardLastUpdateDate:DescribeDashboardResponse', describeDashboardResponse_dashboardLastUpdateDate - The date the dashboard was last updated, in Unix epoch time.
DescribeDefaultEncryptionConfiguration
data DescribeDefaultEncryptionConfiguration Source #
See: newDescribeDefaultEncryptionConfiguration smart constructor.
Constructors
| DescribeDefaultEncryptionConfiguration' | |
Instances
newDescribeDefaultEncryptionConfiguration :: DescribeDefaultEncryptionConfiguration Source #
Create a value of DescribeDefaultEncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeDefaultEncryptionConfigurationResponse Source #
See: newDescribeDefaultEncryptionConfigurationResponse smart constructor.
Constructors
| DescribeDefaultEncryptionConfigurationResponse' (Maybe Text) Int EncryptionType ConfigurationStatus |
Instances
newDescribeDefaultEncryptionConfigurationResponse Source #
Arguments
Create a value of DescribeDefaultEncryptionConfigurationResponse 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:kmsKeyArn:DescribeDefaultEncryptionConfigurationResponse', describeDefaultEncryptionConfigurationResponse_kmsKeyArn - The key ARN of the customer managed key used for KMS encryption if you
use KMS_BASED_ENCRYPTION.
$sel:httpStatus:DescribeDefaultEncryptionConfigurationResponse', describeDefaultEncryptionConfigurationResponse_httpStatus - The response's http status code.
$sel:encryptionType:DescribeDefaultEncryptionConfigurationResponse', describeDefaultEncryptionConfigurationResponse_encryptionType - The type of encryption used for the encryption configuration.
$sel:configurationStatus:DescribeDefaultEncryptionConfigurationResponse', describeDefaultEncryptionConfigurationResponse_configurationStatus - The status of the account configuration. This contains the
ConfigurationState. If there's an error, it also contains the
ErrorDetails.
DescribeGateway
data DescribeGateway Source #
See: newDescribeGateway smart constructor.
Constructors
| DescribeGateway' Text |
Instances
Arguments
| :: Text | |
| -> DescribeGateway |
Create a value of DescribeGateway 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:
DescribeGateway, describeGateway_gatewayId - The ID of the gateway device.
data DescribeGatewayResponse Source #
See: newDescribeGatewayResponse smart constructor.
Constructors
| DescribeGatewayResponse' (Maybe GatewayPlatform) Int Text Text Text [GatewayCapabilitySummary] POSIX POSIX |
Instances
newDescribeGatewayResponse Source #
Create a value of DescribeGatewayResponse 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:
DescribeGatewayResponse, describeGatewayResponse_gatewayPlatform - The gateway's platform.
$sel:httpStatus:DescribeGatewayResponse', describeGatewayResponse_httpStatus - The response's http status code.
DescribeGateway, describeGatewayResponse_gatewayId - The ID of the gateway device.
DescribeGatewayResponse, describeGatewayResponse_gatewayName - The name of the gateway.
$sel:gatewayArn:DescribeGatewayResponse', describeGatewayResponse_gatewayArn - The
ARN
of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}DescribeGatewayResponse, describeGatewayResponse_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.
DescribeGatewayResponse, describeGatewayResponse_creationDate - The date the gateway was created, in Unix epoch time.
DescribeGatewayResponse, describeGatewayResponse_lastUpdateDate - The date the gateway was last updated, in Unix epoch time.
DescribeGatewayCapabilityConfiguration
data DescribeGatewayCapabilityConfiguration Source #
See: newDescribeGatewayCapabilityConfiguration smart constructor.
Constructors
| DescribeGatewayCapabilityConfiguration' Text Text |
Instances
newDescribeGatewayCapabilityConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeGatewayCapabilityConfiguration |
Create a value of DescribeGatewayCapabilityConfiguration 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:
DescribeGatewayCapabilityConfiguration, describeGatewayCapabilityConfiguration_gatewayId - The ID of the gateway that defines the capability configuration.
DescribeGatewayCapabilityConfiguration, describeGatewayCapabilityConfiguration_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.
data DescribeGatewayCapabilityConfigurationResponse Source #
See: newDescribeGatewayCapabilityConfigurationResponse smart constructor.
Instances
newDescribeGatewayCapabilityConfigurationResponse Source #
Arguments
Create a value of DescribeGatewayCapabilityConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeGatewayCapabilityConfigurationResponse', describeGatewayCapabilityConfigurationResponse_httpStatus - The response's http status code.
DescribeGatewayCapabilityConfiguration, describeGatewayCapabilityConfigurationResponse_gatewayId - The ID of the gateway that defines the capability configuration.
DescribeGatewayCapabilityConfiguration, describeGatewayCapabilityConfigurationResponse_capabilityNamespace - The namespace of the gateway capability.
$sel:capabilityConfiguration:DescribeGatewayCapabilityConfigurationResponse', describeGatewayCapabilityConfigurationResponse_capabilityConfiguration - The JSON document that defines the gateway capability's configuration.
For more information, see
Configuring data sources (CLI)
in the IoT SiteWise User Guide.
DescribeGatewayCapabilityConfigurationResponse, describeGatewayCapabilityConfigurationResponse_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.
DescribeLoggingOptions
data DescribeLoggingOptions Source #
See: newDescribeLoggingOptions smart constructor.
Constructors
| DescribeLoggingOptions' | |
Instances
newDescribeLoggingOptions :: DescribeLoggingOptions Source #
Create a value of DescribeLoggingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeLoggingOptionsResponse Source #
See: newDescribeLoggingOptionsResponse smart constructor.
Constructors
| DescribeLoggingOptionsResponse' Int LoggingOptions |
Instances
newDescribeLoggingOptionsResponse Source #
Arguments
| :: Int | |
| -> LoggingOptions | |
| -> DescribeLoggingOptionsResponse |
Create a value of DescribeLoggingOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeLoggingOptionsResponse', describeLoggingOptionsResponse_httpStatus - The response's http status code.
$sel:loggingOptions:DescribeLoggingOptionsResponse', describeLoggingOptionsResponse_loggingOptions - The current logging options.
DescribePortal
data DescribePortal Source #
See: newDescribePortal smart constructor.
Constructors
| DescribePortal' Text |
Instances
Arguments
| :: Text | |
| -> DescribePortal |
Create a value of DescribePortal 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:
DescribePortal, describePortal_portalId - The ID of the portal.
data DescribePortalResponse Source #
See: newDescribePortalResponse smart constructor.
Constructors
| DescribePortalResponse' (Maybe Alarms) (Maybe Text) (Maybe AuthMode) (Maybe Text) (Maybe ImageLocation) (Maybe Text) Int Text Text Text Text Text Text PortalStatus POSIX POSIX |
Instances
newDescribePortalResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> PortalStatus | |
| -> UTCTime | |
| -> UTCTime | |
| -> DescribePortalResponse |
Create a value of DescribePortalResponse 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:alarms:DescribePortalResponse', describePortalResponse_alarms - Contains the configuration information of an alarm created in an IoT
SiteWise Monitor portal.
$sel:notificationSenderEmail:DescribePortalResponse', describePortalResponse_notificationSenderEmail - The email address that sends alarm notifications.
$sel:portalAuthMode:DescribePortalResponse', describePortalResponse_portalAuthMode - The service to use to authenticate users to the portal.
$sel:portalDescription:DescribePortalResponse', describePortalResponse_portalDescription - The portal's description.
$sel:portalLogoImageLocation:DescribePortalResponse', describePortalResponse_portalLogoImageLocation - The portal's logo image, which is available at a URL.
DescribePortalResponse, describePortalResponse_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:httpStatus:DescribePortalResponse', describePortalResponse_httpStatus - The response's http status code.
DescribePortal, describePortalResponse_portalId - The ID of the portal.
$sel:portalArn:DescribePortalResponse', describePortalResponse_portalArn - The
ARN
of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}$sel:portalName:DescribePortalResponse', describePortalResponse_portalName - The name of the portal.
$sel:portalClientId:DescribePortalResponse', describePortalResponse_portalClientId - The IAM Identity Center application generated client ID (used with IAM
Identity Center APIs). IoT SiteWise includes portalClientId for only
portals that use IAM Identity Center to authenticate users.
$sel:portalStartUrl:DescribePortalResponse', describePortalResponse_portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to
access portals that use IAM Identity Center 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:portalContactEmail:DescribePortalResponse', describePortalResponse_portalContactEmail - The Amazon Web Services administrator's contact email address.
$sel:portalStatus:DescribePortalResponse', describePortalResponse_portalStatus - The current status of the portal, which contains a state and any error
message.
$sel:portalCreationDate:DescribePortalResponse', describePortalResponse_portalCreationDate - The date the portal was created, in Unix epoch time.
$sel:portalLastUpdateDate:DescribePortalResponse', describePortalResponse_portalLastUpdateDate - The date the portal was last updated, in Unix epoch time.
DescribeProject
data DescribeProject Source #
See: newDescribeProject smart constructor.
Constructors
| DescribeProject' Text |
Instances
Arguments
| :: Text | |
| -> DescribeProject |
Create a value of DescribeProject 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:
DescribeProject, describeProject_projectId - The ID of the project.
data DescribeProjectResponse Source #
See: newDescribeProjectResponse smart constructor.
Instances
newDescribeProjectResponse Source #
Create a value of DescribeProjectResponse 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:projectDescription:DescribeProjectResponse', describeProjectResponse_projectDescription - The project's description.
$sel:httpStatus:DescribeProjectResponse', describeProjectResponse_httpStatus - The response's http status code.
DescribeProject, describeProjectResponse_projectId - The ID of the project.
$sel:projectArn:DescribeProjectResponse', describeProjectResponse_projectArn - The
ARN
of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}$sel:projectName:DescribeProjectResponse', describeProjectResponse_projectName - The name of the project.
$sel:portalId:DescribeProjectResponse', describeProjectResponse_portalId - The ID of the portal that the project is in.
$sel:projectCreationDate:DescribeProjectResponse', describeProjectResponse_projectCreationDate - The date the project was created, in Unix epoch time.
$sel:projectLastUpdateDate:DescribeProjectResponse', describeProjectResponse_projectLastUpdateDate - The date the project was last updated, in Unix epoch time.
DescribeStorageConfiguration
data DescribeStorageConfiguration Source #
See: newDescribeStorageConfiguration smart constructor.
Constructors
| DescribeStorageConfiguration' | |
Instances
newDescribeStorageConfiguration :: DescribeStorageConfiguration Source #
Create a value of DescribeStorageConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeStorageConfigurationResponse Source #
See: newDescribeStorageConfigurationResponse smart constructor.
Constructors
| DescribeStorageConfigurationResponse' (Maybe DisassociatedDataStorageState) (Maybe POSIX) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) Int StorageType ConfigurationStatus |
Instances
newDescribeStorageConfigurationResponse Source #
Arguments
| :: Int | |
| -> StorageType | |
| -> ConfigurationStatus |
|
| -> DescribeStorageConfigurationResponse |
Create a value of DescribeStorageConfigurationResponse 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:disassociatedDataStorage:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_disassociatedDataStorage - Contains the storage configuration for time series (data streams) that
aren't associated with asset properties. The disassociatedDataStorage
can be one of the following values:
ENABLED– IoT SiteWise accepts time series that aren't associated with asset properties.After the
disassociatedDataStorageis enabled, you can't disable it.DISABLED– IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
DescribeStorageConfigurationResponse, describeStorageConfigurationResponse_lastUpdateDate - The date the storage configuration was last updated, in Unix epoch time.
$sel:multiLayerStorage:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_multiLayerStorage - Contains information about the storage destination.
$sel:retentionPeriod:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_retentionPeriod - How many days your data is kept in the hot tier. By default, your data
is kept indefinitely in the hot tier.
$sel:httpStatus:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_httpStatus - The response's http status code.
$sel:storageType:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_storageType - The storage tier that you specified for your data. The storageType
parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE– IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE– IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
$sel:configurationStatus:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_configurationStatus - Undocumented member.
DescribeTimeSeries
data DescribeTimeSeries Source #
See: newDescribeTimeSeries smart constructor.
Instances
newDescribeTimeSeries :: DescribeTimeSeries Source #
Create a value of DescribeTimeSeries 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:
DescribeTimeSeries, describeTimeSeries_alias - The alias that identifies the time series.
DescribeTimeSeries, describeTimeSeries_assetId - The ID of the asset in which the asset property was created.
DescribeTimeSeries, describeTimeSeries_propertyId - The ID of the asset property.
data DescribeTimeSeriesResponse Source #
See: newDescribeTimeSeriesResponse smart constructor.
Constructors
| DescribeTimeSeriesResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int Text PropertyDataType POSIX POSIX |
Instances
newDescribeTimeSeriesResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> PropertyDataType | |
| -> UTCTime | |
| -> UTCTime | |
| -> DescribeTimeSeriesResponse |
Create a value of DescribeTimeSeriesResponse 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:
DescribeTimeSeries, describeTimeSeriesResponse_alias - The alias that identifies the time series.
DescribeTimeSeries, describeTimeSeriesResponse_assetId - The ID of the asset in which the asset property was created.
DescribeTimeSeriesResponse, describeTimeSeriesResponse_dataTypeSpec - The data type of the structure for this time series. This parameter is
required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model
in which you created the asset property that is associated with your
time series. Use AWS/ALARM_STATE for alarm state in alarm composite
models.
DescribeTimeSeries, describeTimeSeriesResponse_propertyId - The ID of the asset property.
$sel:httpStatus:DescribeTimeSeriesResponse', describeTimeSeriesResponse_httpStatus - The response's http status code.
DescribeTimeSeriesResponse, describeTimeSeriesResponse_timeSeriesId - The ID of the time series.
DescribeTimeSeriesResponse, describeTimeSeriesResponse_dataType - The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to
identify the type of the structure for this time series.
DescribeTimeSeriesResponse, describeTimeSeriesResponse_timeSeriesCreationDate - The date that the time series was created, in Unix epoch time.
DescribeTimeSeriesResponse, describeTimeSeriesResponse_timeSeriesLastUpdateDate - The date that the time series was last updated, in Unix epoch time.
DisassociateAssets
data DisassociateAssets Source #
See: newDisassociateAssets smart constructor.
Instances
newDisassociateAssets Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DisassociateAssets |
Create a value of DisassociateAssets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DisassociateAssets', disassociateAssets_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DisassociateAssets, disassociateAssets_assetId - The ID of the parent asset from which to disassociate the child asset.
DisassociateAssets, disassociateAssets_hierarchyId - The ID of a hierarchy in the parent asset's model. Hierarchies allow
different groupings of assets to be formed that all come from the same
asset model. You can use the hierarchy ID to identify the correct asset
to disassociate. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
DisassociateAssets, disassociateAssets_childAssetId - The ID of the child asset to disassociate.
data DisassociateAssetsResponse Source #
See: newDisassociateAssetsResponse smart constructor.
Constructors
| DisassociateAssetsResponse' | |
Instances
newDisassociateAssetsResponse :: DisassociateAssetsResponse Source #
Create a value of DisassociateAssetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisassociateTimeSeriesFromAssetProperty
data DisassociateTimeSeriesFromAssetProperty Source #
See: newDisassociateTimeSeriesFromAssetProperty smart constructor.
Instances
newDisassociateTimeSeriesFromAssetProperty Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DisassociateTimeSeriesFromAssetProperty |
Create a value of DisassociateTimeSeriesFromAssetProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DisassociateTimeSeriesFromAssetProperty', disassociateTimeSeriesFromAssetProperty_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DisassociateTimeSeriesFromAssetProperty, disassociateTimeSeriesFromAssetProperty_alias - The alias that identifies the time series.
DisassociateTimeSeriesFromAssetProperty, disassociateTimeSeriesFromAssetProperty_assetId - The ID of the asset in which the asset property was created.
DisassociateTimeSeriesFromAssetProperty, disassociateTimeSeriesFromAssetProperty_propertyId - The ID of the asset property.
data DisassociateTimeSeriesFromAssetPropertyResponse Source #
See: newDisassociateTimeSeriesFromAssetPropertyResponse smart constructor.
Constructors
| DisassociateTimeSeriesFromAssetPropertyResponse' | |
Instances
newDisassociateTimeSeriesFromAssetPropertyResponse :: DisassociateTimeSeriesFromAssetPropertyResponse Source #
Create a value of DisassociateTimeSeriesFromAssetPropertyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetAssetPropertyAggregates (Paginated)
data GetAssetPropertyAggregates Source #
See: newGetAssetPropertyAggregates smart constructor.
Constructors
| GetAssetPropertyAggregates' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe TimeOrdering) (NonEmpty AggregateType) Text POSIX POSIX |
Instances
newGetAssetPropertyAggregates Source #
Arguments
| :: NonEmpty AggregateType | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> GetAssetPropertyAggregates |
Create a value of GetAssetPropertyAggregates 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:
GetAssetPropertyAggregates, getAssetPropertyAggregates_assetId - The ID of the asset.
$sel:maxResults:GetAssetPropertyAggregates', getAssetPropertyAggregates_maxResults - The maximum number of results to return for each paginated request.
Default: 100
GetAssetPropertyAggregates, getAssetPropertyAggregates_nextToken - The token to be used for the next set of paginated results.
GetAssetPropertyAggregates, getAssetPropertyAggregates_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.
GetAssetPropertyAggregates, getAssetPropertyAggregates_propertyId - The ID of the asset property.
GetAssetPropertyAggregates, getAssetPropertyAggregates_qualities - The quality by which to filter asset data.
GetAssetPropertyAggregates, getAssetPropertyAggregates_timeOrdering - The chronological sorting order of the requested information.
Default: ASCENDING
GetAssetPropertyAggregates, getAssetPropertyAggregates_aggregateTypes - The data aggregating function.
GetAssetPropertyAggregates, getAssetPropertyAggregates_resolution - The time interval over which to aggregate data.
GetAssetPropertyAggregates, getAssetPropertyAggregates_startDate - The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
GetAssetPropertyAggregates, getAssetPropertyAggregates_endDate - The inclusive end of the range from which to query historical data,
expressed in seconds in Unix epoch time.
data GetAssetPropertyAggregatesResponse Source #
See: newGetAssetPropertyAggregatesResponse smart constructor.
Constructors
| GetAssetPropertyAggregatesResponse' (Maybe Text) Int [AggregatedValue] |
Instances
newGetAssetPropertyAggregatesResponse Source #
Arguments
| :: Int | |
| -> GetAssetPropertyAggregatesResponse |
Create a value of GetAssetPropertyAggregatesResponse 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:
GetAssetPropertyAggregates, getAssetPropertyAggregatesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:GetAssetPropertyAggregatesResponse', getAssetPropertyAggregatesResponse_httpStatus - The response's http status code.
GetAssetPropertyAggregatesResponse, getAssetPropertyAggregatesResponse_aggregatedValues - The requested aggregated values.
GetAssetPropertyValue
data GetAssetPropertyValue Source #
See: newGetAssetPropertyValue smart constructor.
Instances
newGetAssetPropertyValue :: GetAssetPropertyValue Source #
Create a value of GetAssetPropertyValue 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:
GetAssetPropertyValue, getAssetPropertyValue_assetId - The ID of the asset.
GetAssetPropertyValue, getAssetPropertyValue_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.
GetAssetPropertyValue, getAssetPropertyValue_propertyId - The ID of the asset property.
data GetAssetPropertyValueResponse Source #
See: newGetAssetPropertyValueResponse smart constructor.
Constructors
| GetAssetPropertyValueResponse' (Maybe AssetPropertyValue) Int |
Instances
newGetAssetPropertyValueResponse Source #
Create a value of GetAssetPropertyValueResponse 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:propertyValue:GetAssetPropertyValueResponse', getAssetPropertyValueResponse_propertyValue - The current asset property value.
$sel:httpStatus:GetAssetPropertyValueResponse', getAssetPropertyValueResponse_httpStatus - The response's http status code.
GetAssetPropertyValueHistory (Paginated)
data GetAssetPropertyValueHistory Source #
See: newGetAssetPropertyValueHistory smart constructor.
Constructors
| GetAssetPropertyValueHistory' (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe POSIX) (Maybe TimeOrdering) |
Instances
newGetAssetPropertyValueHistory :: GetAssetPropertyValueHistory Source #
Create a value of GetAssetPropertyValueHistory 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:
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_assetId - The ID of the asset.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_endDate - The inclusive end of the range from which to query historical data,
expressed in seconds in Unix epoch time.
$sel:maxResults:GetAssetPropertyValueHistory', getAssetPropertyValueHistory_maxResults - The maximum number of results to return for each paginated request.
Default: 100
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_nextToken - The token to be used for the next set of paginated results.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_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.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_propertyId - The ID of the asset property.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_qualities - The quality by which to filter asset data.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_startDate - The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
GetAssetPropertyValueHistory, getAssetPropertyValueHistory_timeOrdering - The chronological sorting order of the requested information.
Default: ASCENDING
data GetAssetPropertyValueHistoryResponse Source #
See: newGetAssetPropertyValueHistoryResponse smart constructor.
Constructors
| GetAssetPropertyValueHistoryResponse' (Maybe Text) Int [AssetPropertyValue] |
Instances
newGetAssetPropertyValueHistoryResponse Source #
Arguments
| :: Int | |
| -> GetAssetPropertyValueHistoryResponse |
Create a value of GetAssetPropertyValueHistoryResponse 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:
GetAssetPropertyValueHistory, getAssetPropertyValueHistoryResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:GetAssetPropertyValueHistoryResponse', getAssetPropertyValueHistoryResponse_httpStatus - The response's http status code.
GetAssetPropertyValueHistoryResponse, getAssetPropertyValueHistoryResponse_assetPropertyValueHistory - The asset property's value history.
GetInterpolatedAssetPropertyValues (Paginated)
data GetInterpolatedAssetPropertyValues Source #
See: newGetInterpolatedAssetPropertyValues smart constructor.
Constructors
| GetInterpolatedAssetPropertyValues' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Natural Natural Quality Natural Text |
Instances
newGetInterpolatedAssetPropertyValues Source #
Create a value of GetInterpolatedAssetPropertyValues 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:
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_assetId - The ID of the asset.
$sel:endTimeOffsetInNanos:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_endTimeOffsetInNanos - The nanosecond offset converted from endTimeInSeconds.
$sel:intervalWindowInSeconds:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_intervalWindowInSeconds - The query interval for the window, in seconds. IoT SiteWise computes
each interpolated value by using data points from the timestamp of each
interval, minus the window to the timestamp of each interval plus the
window. If not specified, the window ranges between the start time minus
the interval and the end time plus the interval.
- If you specify a value for the
intervalWindowInSecondsparameter, the value for thetypeparameter must beLINEAR_INTERPOLATION. - If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
$sel:maxResults:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_maxResults - The maximum number of results to return for each paginated request. If
not specified, the default value is 10.
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_nextToken - The token to be used for the next set of paginated results.
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_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.
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_propertyId - The ID of the asset property.
$sel:startTimeOffsetInNanos:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_startTimeOffsetInNanos - The nanosecond offset converted from startTimeInSeconds.
$sel:startTimeInSeconds:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_startTimeInSeconds - The exclusive start of the range from which to interpolate data,
expressed in seconds in Unix epoch time.
$sel:endTimeInSeconds:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_endTimeInSeconds - The inclusive end of the range from which to interpolate data, expressed
in seconds in Unix epoch time.
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_quality - The quality of the asset property value. You can use this parameter as a
filter to choose only the asset property values that have a specific
quality.
$sel:intervalInSeconds:GetInterpolatedAssetPropertyValues', getInterpolatedAssetPropertyValues_intervalInSeconds - The time interval in seconds over which to interpolate data. Each
interval starts when the previous one ends.
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValues_type - The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION– Estimates missing data using linear interpolation.For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.
LOCF_INTERPOLATION– Estimates missing data using last observation carried forward interpolationIf no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.
For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
data GetInterpolatedAssetPropertyValuesResponse Source #
See: newGetInterpolatedAssetPropertyValuesResponse smart constructor.
Constructors
| GetInterpolatedAssetPropertyValuesResponse' (Maybe Text) Int [InterpolatedAssetPropertyValue] |
Instances
newGetInterpolatedAssetPropertyValuesResponse Source #
Arguments
| :: Int | |
| -> GetInterpolatedAssetPropertyValuesResponse |
Create a value of GetInterpolatedAssetPropertyValuesResponse 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:
GetInterpolatedAssetPropertyValues, getInterpolatedAssetPropertyValuesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:GetInterpolatedAssetPropertyValuesResponse', getInterpolatedAssetPropertyValuesResponse_httpStatus - The response's http status code.
$sel:interpolatedAssetPropertyValues:GetInterpolatedAssetPropertyValuesResponse', getInterpolatedAssetPropertyValuesResponse_interpolatedAssetPropertyValues - The requested interpolated values.
ListAccessPolicies (Paginated)
data ListAccessPolicies Source #
See: newListAccessPolicies smart constructor.
Constructors
| ListAccessPolicies' (Maybe Text) (Maybe Text) (Maybe IdentityType) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ResourceType) |
Instances
newListAccessPolicies :: ListAccessPolicies Source #
Create a value of ListAccessPolicies 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:iamArn:ListAccessPolicies', listAccessPolicies_iamArn - The ARN of the IAM user. For more information, see
IAM ARNs
in the IAM User Guide. This parameter is required if you specify IAM
for identityType.
$sel:identityId:ListAccessPolicies', listAccessPolicies_identityId - The ID of the identity. This parameter is required if you specify USER
or GROUP for identityType.
$sel:identityType:ListAccessPolicies', listAccessPolicies_identityType - The type of identity (IAM Identity Center user, IAM Identity Center
group, or IAM user). This parameter is required if you specify
identityId.
$sel:maxResults:ListAccessPolicies', listAccessPolicies_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListAccessPolicies, listAccessPolicies_nextToken - The token to be used for the next set of paginated results.
$sel:resourceId:ListAccessPolicies', listAccessPolicies_resourceId - The ID of the resource. This parameter is required if you specify
resourceType.
$sel:resourceType:ListAccessPolicies', listAccessPolicies_resourceType - The type of resource (portal or project). This parameter is required if
you specify resourceId.
data ListAccessPoliciesResponse Source #
See: newListAccessPoliciesResponse smart constructor.
Constructors
| ListAccessPoliciesResponse' (Maybe Text) Int [AccessPolicySummary] |
Instances
newListAccessPoliciesResponse Source #
Create a value of ListAccessPoliciesResponse 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:
ListAccessPolicies, listAccessPoliciesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAccessPoliciesResponse', listAccessPoliciesResponse_httpStatus - The response's http status code.
$sel:accessPolicySummaries:ListAccessPoliciesResponse', listAccessPoliciesResponse_accessPolicySummaries - A list that summarizes each access policy.
ListAssetModelProperties (Paginated)
data ListAssetModelProperties Source #
See: newListAssetModelProperties smart constructor.
Constructors
| ListAssetModelProperties' (Maybe ListAssetModelPropertiesFilter) (Maybe Natural) (Maybe Text) Text |
Instances
newListAssetModelProperties Source #
Arguments
| :: Text | |
| -> ListAssetModelProperties |
Create a value of ListAssetModelProperties 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:filter':ListAssetModelProperties', listAssetModelProperties_filter - Filters the requested list of asset model properties. You can choose one
of the following options:
ALL– The list includes all asset model properties for a given asset model ID.BASE– The list includes only base asset model properties for a given asset model ID.
Default: BASE
$sel:maxResults:ListAssetModelProperties', listAssetModelProperties_maxResults - The maximum number of results to return for each paginated request. If
not specified, the default value is 50.
ListAssetModelProperties, listAssetModelProperties_nextToken - The token to be used for the next set of paginated results.
ListAssetModelProperties, listAssetModelProperties_assetModelId - The ID of the asset model.
data ListAssetModelPropertiesResponse Source #
See: newListAssetModelPropertiesResponse smart constructor.
Constructors
| ListAssetModelPropertiesResponse' (Maybe Text) Int [AssetModelPropertySummary] |
Instances
newListAssetModelPropertiesResponse Source #
Create a value of ListAssetModelPropertiesResponse 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:
ListAssetModelProperties, listAssetModelPropertiesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssetModelPropertiesResponse', listAssetModelPropertiesResponse_httpStatus - The response's http status code.
$sel:assetModelPropertySummaries:ListAssetModelPropertiesResponse', listAssetModelPropertiesResponse_assetModelPropertySummaries - A list that summarizes the properties associated with the specified
asset model.
ListAssetModels (Paginated)
data ListAssetModels Source #
See: newListAssetModels smart constructor.
Constructors
| ListAssetModels' (Maybe Natural) (Maybe Text) |
Instances
newListAssetModels :: ListAssetModels Source #
Create a value of ListAssetModels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAssetModels', listAssetModels_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListAssetModels, listAssetModels_nextToken - The token to be used for the next set of paginated results.
data ListAssetModelsResponse Source #
See: newListAssetModelsResponse smart constructor.
Constructors
| ListAssetModelsResponse' (Maybe Text) Int [AssetModelSummary] |
Instances
newListAssetModelsResponse Source #
Create a value of ListAssetModelsResponse 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:
ListAssetModels, listAssetModelsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssetModelsResponse', listAssetModelsResponse_httpStatus - The response's http status code.
$sel:assetModelSummaries:ListAssetModelsResponse', listAssetModelsResponse_assetModelSummaries - A list that summarizes each asset model.
ListAssetProperties (Paginated)
data ListAssetProperties Source #
See: newListAssetProperties smart constructor.
Constructors
| ListAssetProperties' (Maybe ListAssetPropertiesFilter) (Maybe Natural) (Maybe Text) Text |
Instances
newListAssetProperties Source #
Arguments
| :: Text | |
| -> ListAssetProperties |
Create a value of ListAssetProperties 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:filter':ListAssetProperties', listAssetProperties_filter - Filters the requested list of asset properties. You can choose one of
the following options:
ALL– The list includes all asset properties for a given asset model ID.BASE– The list includes only base asset properties for a given asset model ID.
Default: BASE
$sel:maxResults:ListAssetProperties', listAssetProperties_maxResults - The maximum number of results to return for each paginated request. If
not specified, the default value is 50.
ListAssetProperties, listAssetProperties_nextToken - The token to be used for the next set of paginated results.
ListAssetProperties, listAssetProperties_assetId - The ID of the asset.
data ListAssetPropertiesResponse Source #
See: newListAssetPropertiesResponse smart constructor.
Constructors
| ListAssetPropertiesResponse' (Maybe Text) Int [AssetPropertySummary] |
Instances
newListAssetPropertiesResponse Source #
Create a value of ListAssetPropertiesResponse 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:
ListAssetProperties, listAssetPropertiesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssetPropertiesResponse', listAssetPropertiesResponse_httpStatus - The response's http status code.
$sel:assetPropertySummaries:ListAssetPropertiesResponse', listAssetPropertiesResponse_assetPropertySummaries - A list that summarizes the properties associated with the specified
asset.
ListAssetRelationships (Paginated)
data ListAssetRelationships Source #
See: newListAssetRelationships smart constructor.
Constructors
| ListAssetRelationships' (Maybe Natural) (Maybe Text) Text TraversalType |
Instances
newListAssetRelationships Source #
Arguments
| :: Text | |
| -> TraversalType | |
| -> ListAssetRelationships |
Create a value of ListAssetRelationships with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAssetRelationships', listAssetRelationships_maxResults - The maximum number of results to return for each paginated request.
ListAssetRelationships, listAssetRelationships_nextToken - The token to be used for the next set of paginated results.
ListAssetRelationships, listAssetRelationships_assetId - The ID of the asset.
$sel:traversalType:ListAssetRelationships', listAssetRelationships_traversalType - The type of traversal to use to identify asset relationships. Choose the
following option:
PATH_TO_ROOT– Identify the asset's parent assets up to the root asset. The asset that you specify inassetIdis the first result in the list ofassetRelationshipSummaries, and the root asset is the last result.
data ListAssetRelationshipsResponse Source #
See: newListAssetRelationshipsResponse smart constructor.
Constructors
| ListAssetRelationshipsResponse' (Maybe Text) Int [AssetRelationshipSummary] |
Instances
newListAssetRelationshipsResponse Source #
Create a value of ListAssetRelationshipsResponse 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:
ListAssetRelationships, listAssetRelationshipsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssetRelationshipsResponse', listAssetRelationshipsResponse_httpStatus - The response's http status code.
$sel:assetRelationshipSummaries:ListAssetRelationshipsResponse', listAssetRelationshipsResponse_assetRelationshipSummaries - A list that summarizes each asset relationship.
ListAssets (Paginated)
data ListAssets Source #
See: newListAssets smart constructor.
Constructors
| ListAssets' (Maybe Text) (Maybe ListAssetsFilter) (Maybe Natural) (Maybe Text) |
Instances
newListAssets :: ListAssets Source #
Create a value of ListAssets 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:
ListAssets, listAssets_assetModelId - The ID of the asset model by which to filter the list of assets. This
parameter is required if you choose ALL for filter.
$sel:filter':ListAssets', listAssets_filter - The filter for the requested list of assets. Choose one of the following
options:
ALL– The list includes all assets for a given asset model ID. TheassetModelIdparameter is required if you filter byALL.TOP_LEVEL– The list includes only top-level assets in the asset hierarchy tree.
Default: ALL
$sel:maxResults:ListAssets', listAssets_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListAssets, listAssets_nextToken - The token to be used for the next set of paginated results.
data ListAssetsResponse Source #
See: newListAssetsResponse smart constructor.
Constructors
| ListAssetsResponse' (Maybe Text) Int [AssetSummary] |
Instances
newListAssetsResponse Source #
Arguments
| :: Int | |
| -> ListAssetsResponse |
Create a value of ListAssetsResponse 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:
ListAssets, listAssetsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssetsResponse', listAssetsResponse_httpStatus - The response's http status code.
$sel:assetSummaries:ListAssetsResponse', listAssetsResponse_assetSummaries - A list that summarizes each asset.
ListAssociatedAssets (Paginated)
data ListAssociatedAssets Source #
See: newListAssociatedAssets smart constructor.
Constructors
| ListAssociatedAssets' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TraversalDirection) Text |
Instances
newListAssociatedAssets Source #
Arguments
| :: Text | |
| -> ListAssociatedAssets |
Create a value of ListAssociatedAssets 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:
ListAssociatedAssets, listAssociatedAssets_hierarchyId - The ID of the hierarchy by which child assets are associated to the
asset. To find a hierarchy ID, use the
DescribeAsset
or
DescribeAssetModel
operations. This parameter is required if you choose CHILD for
traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
$sel:maxResults:ListAssociatedAssets', listAssociatedAssets_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListAssociatedAssets, listAssociatedAssets_nextToken - The token to be used for the next set of paginated results.
$sel:traversalDirection:ListAssociatedAssets', listAssociatedAssets_traversalDirection - The direction to list associated assets. Choose one of the following
options:
CHILD– The list includes all child assets associated to the asset. ThehierarchyIdparameter is required if you chooseCHILD.PARENT– The list includes the asset's parent asset.
Default: CHILD
ListAssociatedAssets, listAssociatedAssets_assetId - The ID of the asset to query.
data ListAssociatedAssetsResponse Source #
See: newListAssociatedAssetsResponse smart constructor.
Constructors
| ListAssociatedAssetsResponse' (Maybe Text) Int [AssociatedAssetsSummary] |
Instances
newListAssociatedAssetsResponse Source #
Create a value of ListAssociatedAssetsResponse 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:
ListAssociatedAssets, listAssociatedAssetsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListAssociatedAssetsResponse', listAssociatedAssetsResponse_httpStatus - The response's http status code.
$sel:assetSummaries:ListAssociatedAssetsResponse', listAssociatedAssetsResponse_assetSummaries - A list that summarizes the associated assets.
ListBulkImportJobs (Paginated)
data ListBulkImportJobs Source #
See: newListBulkImportJobs smart constructor.
Constructors
| ListBulkImportJobs' (Maybe ListBulkImportJobsFilter) (Maybe Natural) (Maybe Text) |
Instances
newListBulkImportJobs :: ListBulkImportJobs Source #
Create a value of ListBulkImportJobs 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:filter':ListBulkImportJobs', listBulkImportJobs_filter - You can use a filter to select the bulk import jobs that you want to
retrieve.
$sel:maxResults:ListBulkImportJobs', listBulkImportJobs_maxResults - The maximum number of results to return for each paginated request.
ListBulkImportJobs, listBulkImportJobs_nextToken - The token to be used for the next set of paginated results.
data ListBulkImportJobsResponse Source #
See: newListBulkImportJobsResponse smart constructor.
Constructors
| ListBulkImportJobsResponse' (Maybe Text) Int [JobSummary] |
Instances
newListBulkImportJobsResponse Source #
Create a value of ListBulkImportJobsResponse 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:
ListBulkImportJobs, listBulkImportJobsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListBulkImportJobsResponse', listBulkImportJobsResponse_httpStatus - The response's http status code.
$sel:jobSummaries:ListBulkImportJobsResponse', listBulkImportJobsResponse_jobSummaries - One or more job summaries to list.
ListDashboards (Paginated)
data ListDashboards Source #
See: newListDashboards smart constructor.
Instances
Arguments
| :: Text | |
| -> ListDashboards |
Create a value of ListDashboards with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDashboards', listDashboards_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListDashboards, listDashboards_nextToken - The token to be used for the next set of paginated results.
$sel:projectId:ListDashboards', listDashboards_projectId - The ID of the project.
data ListDashboardsResponse Source #
See: newListDashboardsResponse smart constructor.
Constructors
| ListDashboardsResponse' (Maybe Text) Int [DashboardSummary] |
Instances
newListDashboardsResponse Source #
Create a value of ListDashboardsResponse 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:
ListDashboards, listDashboardsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListDashboardsResponse', listDashboardsResponse_httpStatus - The response's http status code.
$sel:dashboardSummaries:ListDashboardsResponse', listDashboardsResponse_dashboardSummaries - A list that summarizes each dashboard in the project.
ListGateways (Paginated)
data ListGateways Source #
See: newListGateways smart constructor.
Constructors
| ListGateways' (Maybe Natural) (Maybe Text) |
Instances
newListGateways :: ListGateways Source #
Create a value of ListGateways with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListGateways', listGateways_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListGateways, listGateways_nextToken - The token to be used for the next set of paginated results.
data ListGatewaysResponse Source #
See: newListGatewaysResponse smart constructor.
Constructors
| ListGatewaysResponse' (Maybe Text) Int [GatewaySummary] |
Instances
newListGatewaysResponse Source #
Arguments
| :: Int | |
| -> ListGatewaysResponse |
Create a value of ListGatewaysResponse 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:
ListGateways, listGatewaysResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.
$sel:gatewaySummaries:ListGatewaysResponse', listGatewaysResponse_gatewaySummaries - A list that summarizes each gateway.
ListPortals (Paginated)
data ListPortals Source #
See: newListPortals smart constructor.
Constructors
| ListPortals' (Maybe Natural) (Maybe Text) |
Instances
newListPortals :: ListPortals Source #
Create a value of ListPortals with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPortals', listPortals_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListPortals, listPortals_nextToken - The token to be used for the next set of paginated results.
data ListPortalsResponse Source #
See: newListPortalsResponse smart constructor.
Constructors
| ListPortalsResponse' (Maybe Text) (Maybe [PortalSummary]) Int |
Instances
newListPortalsResponse Source #
Arguments
| :: Int | |
| -> ListPortalsResponse |
Create a value of ListPortalsResponse 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:
ListPortals, listPortalsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:portalSummaries:ListPortalsResponse', listPortalsResponse_portalSummaries - A list that summarizes each portal.
$sel:httpStatus:ListPortalsResponse', listPortalsResponse_httpStatus - The response's http status code.
ListProjectAssets (Paginated)
data ListProjectAssets Source #
See: newListProjectAssets smart constructor.
Instances
Arguments
| :: Text | |
| -> ListProjectAssets |
Create a value of ListProjectAssets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListProjectAssets', listProjectAssets_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListProjectAssets, listProjectAssets_nextToken - The token to be used for the next set of paginated results.
$sel:projectId:ListProjectAssets', listProjectAssets_projectId - The ID of the project.
data ListProjectAssetsResponse Source #
See: newListProjectAssetsResponse smart constructor.
Constructors
| ListProjectAssetsResponse' (Maybe Text) Int [Text] |
Instances
newListProjectAssetsResponse Source #
Create a value of ListProjectAssetsResponse 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:
ListProjectAssets, listProjectAssetsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListProjectAssetsResponse', listProjectAssetsResponse_httpStatus - The response's http status code.
$sel:assetIds:ListProjectAssetsResponse', listProjectAssetsResponse_assetIds - A list that contains the IDs of each asset associated with the project.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects smart constructor.
Instances
Arguments
| :: Text | |
| -> ListProjects |
Create a value of ListProjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListProjects', listProjects_maxResults - The maximum number of results to return for each paginated request.
Default: 50
ListProjects, listProjects_nextToken - The token to be used for the next set of paginated results.
$sel:portalId:ListProjects', listProjects_portalId - The ID of the portal.
data ListProjectsResponse Source #
See: newListProjectsResponse smart constructor.
Constructors
| ListProjectsResponse' (Maybe Text) Int [ProjectSummary] |
Instances
newListProjectsResponse Source #
Arguments
| :: Int | |
| -> ListProjectsResponse |
Create a value of ListProjectsResponse 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:
ListProjects, listProjectsResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.
$sel:projectSummaries:ListProjectsResponse', listProjectsResponse_projectSummaries - A list that summarizes each project in the portal.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The
ARN
of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of key-value pairs that contain metadata for the resource. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTimeSeries (Paginated)
data ListTimeSeries Source #
See: newListTimeSeries smart constructor.
Constructors
| ListTimeSeries' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ListTimeSeriesType) |
Instances
newListTimeSeries :: ListTimeSeries Source #
Create a value of ListTimeSeries 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:aliasPrefix:ListTimeSeries', listTimeSeries_aliasPrefix - The alias prefix of the time series.
ListTimeSeries, listTimeSeries_assetId - The ID of the asset in which the asset property was created.
$sel:maxResults:ListTimeSeries', listTimeSeries_maxResults - The maximum number of results to return for each paginated request.
ListTimeSeries, listTimeSeries_nextToken - The token to be used for the next set of paginated results.
$sel:timeSeriesType:ListTimeSeries', listTimeSeries_timeSeriesType - The type of the time series. The time series type can be one of the
following values:
ASSOCIATED– The time series is associated with an asset property.DISASSOCIATED– The time series isn't associated with any asset property.
data ListTimeSeriesResponse Source #
See: newListTimeSeriesResponse smart constructor.
Constructors
| ListTimeSeriesResponse' (Maybe Text) Int [TimeSeriesSummary] |
Instances
newListTimeSeriesResponse Source #
Create a value of ListTimeSeriesResponse 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:
ListTimeSeries, listTimeSeriesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:httpStatus:ListTimeSeriesResponse', listTimeSeriesResponse_httpStatus - The response's http status code.
$sel:timeSeriesSummaries:ListTimeSeriesResponse', listTimeSeriesResponse_timeSeriesSummaries - One or more time series summaries to list.
PutDefaultEncryptionConfiguration
data PutDefaultEncryptionConfiguration Source #
See: newPutDefaultEncryptionConfiguration smart constructor.
Constructors
| PutDefaultEncryptionConfiguration' (Maybe Text) EncryptionType |
Instances
newPutDefaultEncryptionConfiguration Source #
Create a value of PutDefaultEncryptionConfiguration 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:kmsKeyId:PutDefaultEncryptionConfiguration', putDefaultEncryptionConfiguration_kmsKeyId - The Key ID of the customer managed key used for KMS encryption. This is
required if you use KMS_BASED_ENCRYPTION.
PutDefaultEncryptionConfiguration, putDefaultEncryptionConfiguration_encryptionType - The type of encryption used for the encryption configuration.
data PutDefaultEncryptionConfigurationResponse Source #
See: newPutDefaultEncryptionConfigurationResponse smart constructor.
Constructors
| PutDefaultEncryptionConfigurationResponse' (Maybe Text) Int EncryptionType ConfigurationStatus |
Instances
newPutDefaultEncryptionConfigurationResponse Source #
Arguments
| :: Int | |
| -> EncryptionType | |
| -> ConfigurationStatus |
|
| -> PutDefaultEncryptionConfigurationResponse |
Create a value of PutDefaultEncryptionConfigurationResponse 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:kmsKeyArn:PutDefaultEncryptionConfigurationResponse', putDefaultEncryptionConfigurationResponse_kmsKeyArn - The Key ARN of the KMS key used for KMS encryption if you use
KMS_BASED_ENCRYPTION.
$sel:httpStatus:PutDefaultEncryptionConfigurationResponse', putDefaultEncryptionConfigurationResponse_httpStatus - The response's http status code.
PutDefaultEncryptionConfiguration, putDefaultEncryptionConfigurationResponse_encryptionType - The type of encryption used for the encryption configuration.
$sel:configurationStatus:PutDefaultEncryptionConfigurationResponse', putDefaultEncryptionConfigurationResponse_configurationStatus - The status of the account configuration. This contains the
ConfigurationState. If there is an error, it also contains the
ErrorDetails.
PutLoggingOptions
data PutLoggingOptions Source #
See: newPutLoggingOptions smart constructor.
Constructors
| PutLoggingOptions' LoggingOptions |
Instances
Create a value of PutLoggingOptions 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:loggingOptions:PutLoggingOptions', putLoggingOptions_loggingOptions - The logging options to set.
data PutLoggingOptionsResponse Source #
See: newPutLoggingOptionsResponse smart constructor.
Constructors
| PutLoggingOptionsResponse' Int |
Instances
newPutLoggingOptionsResponse Source #
Create a value of PutLoggingOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutLoggingOptionsResponse', putLoggingOptionsResponse_httpStatus - The response's http status code.
PutStorageConfiguration
data PutStorageConfiguration Source #
See: newPutStorageConfiguration smart constructor.
Constructors
| PutStorageConfiguration' (Maybe DisassociatedDataStorageState) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) StorageType |
Instances
newPutStorageConfiguration Source #
Arguments
| :: StorageType | |
| -> PutStorageConfiguration |
Create a value of PutStorageConfiguration 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:
PutStorageConfiguration, putStorageConfiguration_disassociatedDataStorage - Contains the storage configuration for time series (data streams) that
aren't associated with asset properties. The disassociatedDataStorage
can be one of the following values:
ENABLED– IoT SiteWise accepts time series that aren't associated with asset properties.After the
disassociatedDataStorageis enabled, you can't disable it.DISABLED– IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
PutStorageConfiguration, putStorageConfiguration_multiLayerStorage - Identifies a storage destination. If you specified MULTI_LAYER_STORAGE
for the storage type, you must specify a MultiLayerStorage object.
PutStorageConfiguration, putStorageConfiguration_retentionPeriod - Undocumented member.
PutStorageConfiguration, putStorageConfiguration_storageType - The storage tier that you specified for your data. The storageType
parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE– IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE– IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
data PutStorageConfigurationResponse Source #
See: newPutStorageConfigurationResponse smart constructor.
Constructors
| PutStorageConfigurationResponse' (Maybe DisassociatedDataStorageState) (Maybe MultiLayerStorage) (Maybe RetentionPeriod) Int StorageType ConfigurationStatus |
Instances
newPutStorageConfigurationResponse Source #
Arguments
| :: Int | |
| -> StorageType | |
| -> ConfigurationStatus | |
| -> PutStorageConfigurationResponse |
Create a value of PutStorageConfigurationResponse 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:
PutStorageConfiguration, putStorageConfigurationResponse_disassociatedDataStorage - Contains the storage configuration for time series (data streams) that
aren't associated with asset properties. The disassociatedDataStorage
can be one of the following values:
ENABLED– IoT SiteWise accepts time series that aren't associated with asset properties.After the
disassociatedDataStorageis enabled, you can't disable it.DISABLED– IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
PutStorageConfiguration, putStorageConfigurationResponse_multiLayerStorage - Contains information about the storage destination.
PutStorageConfiguration, putStorageConfigurationResponse_retentionPeriod - Undocumented member.
$sel:httpStatus:PutStorageConfigurationResponse', putStorageConfigurationResponse_httpStatus - The response's http status code.
PutStorageConfiguration, putStorageConfigurationResponse_storageType - The storage tier that you specified for your data. The storageType
parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE– IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE– IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
$sel:configurationStatus:PutStorageConfigurationResponse', putStorageConfigurationResponse_configurationStatus - Undocumented member.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The
ARN
of the resource to tag.
$sel:tags:TagResource', tagResource_tags - A list of key-value pairs that contain metadata for the resource. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The
ARN
of the resource to untag.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of keys for tags to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateAccessPolicy
data UpdateAccessPolicy Source #
See: newUpdateAccessPolicy smart constructor.
Constructors
| UpdateAccessPolicy' (Maybe Text) Text Identity Resource Permission |
Instances
newUpdateAccessPolicy Source #
Arguments
| :: Text | |
| -> Identity | |
| -> Resource | |
| -> Permission | |
| -> UpdateAccessPolicy |
Create a value of UpdateAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateAccessPolicy', updateAccessPolicy_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:accessPolicyId:UpdateAccessPolicy', updateAccessPolicy_accessPolicyId - The ID of the access policy.
$sel:accessPolicyIdentity:UpdateAccessPolicy', updateAccessPolicy_accessPolicyIdentity - The identity for this access policy. Choose an IAM Identity Center user,
an IAM Identity Center group, or an IAM user.
$sel:accessPolicyResource:UpdateAccessPolicy', updateAccessPolicy_accessPolicyResource - The IoT SiteWise Monitor resource for this access policy. Choose either
a portal or a project.
$sel:accessPolicyPermission:UpdateAccessPolicy', updateAccessPolicy_accessPolicyPermission - The permission level for this access policy. Note that a project
ADMINISTRATOR is also known as a project owner.
data UpdateAccessPolicyResponse Source #
See: newUpdateAccessPolicyResponse smart constructor.
Constructors
| UpdateAccessPolicyResponse' Int |
Instances
newUpdateAccessPolicyResponse Source #
Create a value of UpdateAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAccessPolicyResponse', updateAccessPolicyResponse_httpStatus - The response's http status code.
UpdateAsset
data UpdateAsset Source #
See: newUpdateAsset smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateAsset |
Create a value of UpdateAsset 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:assetDescription:UpdateAsset', updateAsset_assetDescription - A description for the asset.
$sel:clientToken:UpdateAsset', updateAsset_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
UpdateAsset, updateAsset_assetId - The ID of the asset to update.
$sel:assetName:UpdateAsset', updateAsset_assetName - A friendly name for the asset.
data UpdateAssetResponse Source #
See: newUpdateAssetResponse smart constructor.
Constructors
| UpdateAssetResponse' Int AssetStatus |
Instances
newUpdateAssetResponse Source #
Arguments
| :: Int | |
| -> AssetStatus | |
| -> UpdateAssetResponse |
Create a value of UpdateAssetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAssetResponse', updateAssetResponse_httpStatus - The response's http status code.
$sel:assetStatus:UpdateAssetResponse', updateAssetResponse_assetStatus - The status of the asset, which contains a state (UPDATING after
successfully calling this operation) and any error message.
UpdateAssetModel
data UpdateAssetModel Source #
See: newUpdateAssetModel smart constructor.
Constructors
| UpdateAssetModel' (Maybe [AssetModelCompositeModel]) (Maybe Text) (Maybe [AssetModelHierarchy]) (Maybe [AssetModelProperty]) (Maybe Text) Text Text |
Instances
Create a value of UpdateAssetModel 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:assetModelCompositeModels:UpdateAssetModel', updateAssetModel_assetModelCompositeModels - The composite asset models that are part of this asset model. Composite
asset models are asset models that contain specific properties. Each
composite model has a type that defines the properties that the
composite model supports. Use composite asset models to define alarms on
this asset model.
$sel:assetModelDescription:UpdateAssetModel', updateAssetModel_assetModelDescription - A description for the asset model.
$sel:assetModelHierarchies:UpdateAssetModel', updateAssetModel_assetModelHierarchies - The updated hierarchy definitions of the asset model. Each hierarchy
specifies an asset model whose assets can be children of any other
assets created from this asset model. For more information, see
Asset hierarchies
in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
$sel:assetModelProperties:UpdateAssetModel', updateAssetModel_assetModelProperties - The updated property definitions of the asset model. For more
information, see
Asset properties
in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
$sel:clientToken:UpdateAssetModel', updateAssetModel_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
UpdateAssetModel, updateAssetModel_assetModelId - The ID of the asset model to update.
$sel:assetModelName:UpdateAssetModel', updateAssetModel_assetModelName - A unique, friendly name for the asset model.
data UpdateAssetModelResponse Source #
See: newUpdateAssetModelResponse smart constructor.
Constructors
| UpdateAssetModelResponse' Int AssetModelStatus |
Instances
newUpdateAssetModelResponse Source #
Arguments
| :: Int | |
| -> AssetModelStatus | |
| -> UpdateAssetModelResponse |
Create a value of UpdateAssetModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAssetModelResponse', updateAssetModelResponse_httpStatus - The response's http status code.
$sel:assetModelStatus:UpdateAssetModelResponse', updateAssetModelResponse_assetModelStatus - The status of the asset model, which contains a state (UPDATING after
successfully calling this operation) and any error message.
UpdateAssetProperty
data UpdateAssetProperty Source #
See: newUpdateAssetProperty smart constructor.
Constructors
| UpdateAssetProperty' (Maybe Text) (Maybe Text) (Maybe PropertyNotificationState) (Maybe Text) Text Text |
Instances
newUpdateAssetProperty Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateAssetProperty |
Create a value of UpdateAssetProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateAssetProperty', updateAssetProperty_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
UpdateAssetProperty, updateAssetProperty_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.
If you omit this parameter, the alias is removed from the property.
$sel:propertyNotificationState:UpdateAssetProperty', updateAssetProperty_propertyNotificationState - The MQTT notification state (enabled or disabled) for this asset
property. 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.
If you omit this parameter, the notification state is set to DISABLED.
$sel:propertyUnit:UpdateAssetProperty', updateAssetProperty_propertyUnit - The unit of measure (such as Newtons or RPM) of the asset property. If
you don't specify a value for this parameter, the service uses the
value of the assetModelProperty in the asset model.
UpdateAssetProperty, updateAssetProperty_assetId - The ID of the asset to be updated.
UpdateAssetProperty, updateAssetProperty_propertyId - The ID of the asset property to be updated.
data UpdateAssetPropertyResponse Source #
See: newUpdateAssetPropertyResponse smart constructor.
Constructors
| UpdateAssetPropertyResponse' | |
Instances
newUpdateAssetPropertyResponse :: UpdateAssetPropertyResponse Source #
Create a value of UpdateAssetPropertyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDashboard
data UpdateDashboard Source #
See: newUpdateDashboard smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateDashboard |
Create a value of UpdateDashboard with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateDashboard', updateDashboard_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:dashboardDescription:UpdateDashboard', updateDashboard_dashboardDescription - A new description for the dashboard.
$sel:dashboardId:UpdateDashboard', updateDashboard_dashboardId - The ID of the dashboard to update.
$sel:dashboardName:UpdateDashboard', updateDashboard_dashboardName - A new friendly name for the dashboard.
$sel:dashboardDefinition:UpdateDashboard', updateDashboard_dashboardDefinition - The new dashboard definition, as specified in a JSON literal. For
detailed information, see
Creating dashboards (CLI)
in the IoT SiteWise User Guide.
data UpdateDashboardResponse Source #
See: newUpdateDashboardResponse smart constructor.
Constructors
| UpdateDashboardResponse' Int |
Instances
newUpdateDashboardResponse Source #
Create a value of UpdateDashboardResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDashboardResponse', updateDashboardResponse_httpStatus - The response's http status code.
UpdateGateway
data UpdateGateway Source #
See: newUpdateGateway smart constructor.
Constructors
| UpdateGateway' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateGateway |
Create a value of UpdateGateway 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:
UpdateGateway, updateGateway_gatewayId - The ID of the gateway to update.
UpdateGateway, updateGateway_gatewayName - A unique, friendly name for the gateway.
data UpdateGatewayResponse Source #
See: newUpdateGatewayResponse smart constructor.
Constructors
| UpdateGatewayResponse' | |
Instances
newUpdateGatewayResponse :: UpdateGatewayResponse Source #
Create a value of UpdateGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateGatewayCapabilityConfiguration
data UpdateGatewayCapabilityConfiguration Source #
See: newUpdateGatewayCapabilityConfiguration smart constructor.
Constructors
| UpdateGatewayCapabilityConfiguration' Text Text Text |
Instances
newUpdateGatewayCapabilityConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text |
|
| -> UpdateGatewayCapabilityConfiguration |
Create a value of UpdateGatewayCapabilityConfiguration 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:
UpdateGatewayCapabilityConfiguration, updateGatewayCapabilityConfiguration_gatewayId - The ID of the gateway to be updated.
UpdateGatewayCapabilityConfiguration, updateGatewayCapabilityConfiguration_capabilityNamespace - The namespace of the gateway capability configuration to be updated. 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:capabilityConfiguration:UpdateGatewayCapabilityConfiguration', updateGatewayCapabilityConfiguration_capabilityConfiguration - The JSON document that defines the configuration for the gateway
capability. For more information, see
Configuring data sources (CLI)
in the IoT SiteWise User Guide.
data UpdateGatewayCapabilityConfigurationResponse Source #
See: newUpdateGatewayCapabilityConfigurationResponse smart constructor.
Instances
newUpdateGatewayCapabilityConfigurationResponse Source #
Arguments
| :: Int |
|
| -> Text | |
| -> CapabilitySyncStatus | |
| -> UpdateGatewayCapabilityConfigurationResponse |
Create a value of UpdateGatewayCapabilityConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateGatewayCapabilityConfigurationResponse', updateGatewayCapabilityConfigurationResponse_httpStatus - The response's http status code.
UpdateGatewayCapabilityConfiguration, updateGatewayCapabilityConfigurationResponse_capabilityNamespace - The namespace of the gateway capability.
UpdateGatewayCapabilityConfigurationResponse, updateGatewayCapabilityConfigurationResponse_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.
After you update a capability configuration, its sync status is
OUT_OF_SYNC until the gateway receives and applies or rejects the
updated configuration.
UpdatePortal
data UpdatePortal Source #
See: newUpdatePortal smart constructor.
Constructors
| UpdatePortal' (Maybe Alarms) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Image) Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UpdatePortal |
Create a value of UpdatePortal 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:alarms:UpdatePortal', updatePortal_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.
$sel:clientToken:UpdatePortal', updatePortal_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:notificationSenderEmail:UpdatePortal', updatePortal_notificationSenderEmail - The email address that sends alarm notifications.
$sel:portalDescription:UpdatePortal', updatePortal_portalDescription - A new description for the portal.
$sel:portalLogoImage:UpdatePortal', updatePortal_portalLogoImage - Undocumented member.
$sel:portalId:UpdatePortal', updatePortal_portalId - The ID of the portal to update.
$sel:portalName:UpdatePortal', updatePortal_portalName - A new friendly name for the portal.
$sel:portalContactEmail:UpdatePortal', updatePortal_portalContactEmail - The Amazon Web Services administrator's contact email address.
UpdatePortal, updatePortal_roleArn - The
ARN
of a 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.
data UpdatePortalResponse Source #
See: newUpdatePortalResponse smart constructor.
Constructors
| UpdatePortalResponse' Int PortalStatus |
Instances
newUpdatePortalResponse Source #
Arguments
| :: Int | |
| -> PortalStatus | |
| -> UpdatePortalResponse |
Create a value of UpdatePortalResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdatePortalResponse', updatePortalResponse_httpStatus - The response's http status code.
$sel:portalStatus:UpdatePortalResponse', updatePortalResponse_portalStatus - The status of the portal, which contains a state (UPDATING after
successfully calling this operation) and any error message.
UpdateProject
data UpdateProject Source #
See: newUpdateProject smart constructor.
Instances
Create a value of UpdateProject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateProject', updateProject_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:projectDescription:UpdateProject', updateProject_projectDescription - A new description for the project.
$sel:projectId:UpdateProject', updateProject_projectId - The ID of the project to update.
$sel:projectName:UpdateProject', updateProject_projectName - A new friendly name for the project.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse smart constructor.
Constructors
| UpdateProjectResponse' Int |
Instances
newUpdateProjectResponse Source #
Create a value of UpdateProjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.
Types
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
BatchEntryCompletionStatus
newtype BatchEntryCompletionStatus Source #
Constructors
| BatchEntryCompletionStatus' | |
Fields | |
Bundled Patterns
| pattern BatchEntryCompletionStatus_ERROR :: BatchEntryCompletionStatus | |
| pattern BatchEntryCompletionStatus_SUCCESS :: BatchEntryCompletionStatus |
Instances
BatchGetAssetPropertyAggregatesErrorCode
newtype BatchGetAssetPropertyAggregatesErrorCode Source #
Constructors
| BatchGetAssetPropertyAggregatesErrorCode' | |
Bundled Patterns
Instances
BatchGetAssetPropertyValueErrorCode
newtype BatchGetAssetPropertyValueErrorCode Source #
Constructors
| BatchGetAssetPropertyValueErrorCode' | |
Bundled Patterns
Instances
BatchGetAssetPropertyValueHistoryErrorCode
newtype BatchGetAssetPropertyValueHistoryErrorCode Source #
Constructors
| BatchGetAssetPropertyValueHistoryErrorCode' | |
Bundled Patterns
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
ColumnName
newtype ColumnName Source #
Constructors
| ColumnName' | |
Fields | |
Bundled Patterns
| pattern ColumnName_ALIAS :: ColumnName | |
| pattern ColumnName_ASSET_ID :: ColumnName | |
| pattern ColumnName_DATA_TYPE :: ColumnName | |
| pattern ColumnName_PROPERTY_ID :: ColumnName | |
| pattern ColumnName_QUALITY :: ColumnName | |
| pattern ColumnName_TIMESTAMP_NANO_OFFSET :: ColumnName | |
| pattern ColumnName_TIMESTAMP_SECONDS :: ColumnName | |
| pattern ColumnName_VALUE :: ColumnName |
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
DisassociatedDataStorageState
newtype DisassociatedDataStorageState Source #
Constructors
| DisassociatedDataStorageState' | |
Fields | |
Bundled Patterns
| pattern DisassociatedDataStorageState_DISABLED :: DisassociatedDataStorageState | |
| pattern DisassociatedDataStorageState_ENABLED :: DisassociatedDataStorageState |
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
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_CANCELLED :: JobStatus | |
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_COMPLETED_WITH_FAILURES :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_PENDING :: JobStatus | |
| pattern JobStatus_RUNNING :: JobStatus |
Instances
ListAssetModelPropertiesFilter
newtype ListAssetModelPropertiesFilter Source #
Constructors
| ListAssetModelPropertiesFilter' | |
Fields | |
Bundled Patterns
| pattern ListAssetModelPropertiesFilter_ALL :: ListAssetModelPropertiesFilter | |
| pattern ListAssetModelPropertiesFilter_BASE :: ListAssetModelPropertiesFilter |
Instances
ListAssetPropertiesFilter
newtype ListAssetPropertiesFilter Source #
Constructors
| ListAssetPropertiesFilter' | |
Fields | |
Bundled Patterns
| pattern ListAssetPropertiesFilter_ALL :: ListAssetPropertiesFilter | |
| pattern ListAssetPropertiesFilter_BASE :: ListAssetPropertiesFilter |
Instances
ListAssetsFilter
newtype ListAssetsFilter Source #
Constructors
| ListAssetsFilter' | |
Fields | |
Bundled Patterns
| pattern ListAssetsFilter_ALL :: ListAssetsFilter | |
| pattern ListAssetsFilter_TOP_LEVEL :: ListAssetsFilter |
Instances
ListBulkImportJobsFilter
newtype ListBulkImportJobsFilter Source #
Constructors
| ListBulkImportJobsFilter' | |
Fields | |
Bundled Patterns
Instances
ListTimeSeriesType
newtype ListTimeSeriesType Source #
Constructors
| ListTimeSeriesType' | |
Fields | |
Bundled Patterns
| pattern ListTimeSeriesType_ASSOCIATED :: ListTimeSeriesType | |
| pattern ListTimeSeriesType_DISASSOCIATED :: ListTimeSeriesType |
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' (Maybe POSIX) (Maybe POSIX) Text Identity Resource Permission |
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:creationDate:AccessPolicySummary', accessPolicySummary_creationDate - The date the access policy was created, in Unix epoch time.
$sel:lastUpdateDate:AccessPolicySummary', accessPolicySummary_lastUpdateDate - The date the access policy was last updated, in Unix epoch time.
$sel:id:AccessPolicySummary', accessPolicySummary_id - The ID of the access policy.
$sel:identity:AccessPolicySummary', accessPolicySummary_identity - The identity (an IAM Identity Center user, an IAM Identity Center 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.
AggregatedValue
data AggregatedValue Source #
Contains aggregated asset property values (for example, average, minimum, and maximum).
See: newAggregatedValue smart constructor.
Constructors
| AggregatedValue' (Maybe Quality) POSIX Aggregates |
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.
Aggregates
data Aggregates Source #
Contains the (pre-calculated) aggregate values for an asset property.
See: newAggregates smart constructor.
Constructors
| Aggregates' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) |
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: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:maximum:Aggregates', aggregates_maximum - The maximum value of 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.
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.
Instances
| FromJSON Alarms Source # | |
| ToJSON Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| Generic Alarms Source # | |
| Read Alarms Source # | |
| Show Alarms Source # | |
| NFData Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| Eq Alarms Source # | |
| Hashable Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms | |
| type Rep Alarms Source # | |
Defined in Amazonka.IoTSiteWise.Types.Alarms type Rep Alarms = D1 ('MetaData "Alarms" "Amazonka.IoTSiteWise.Types.Alarms" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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.
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' (Maybe Text) (Maybe Text) Text Text [AssetProperty] |
Instances
newAssetCompositeModel Source #
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.
AssetCompositeModel, assetCompositeModel_id - The ID of the asset composite model.
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.
AssetErrorDetails
data AssetErrorDetails Source #
Contains error details for the requested associate project asset action.
See: newAssetErrorDetails smart constructor.
Constructors
| AssetErrorDetails' Text AssetErrorCode Text |
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.
AssetHierarchy
data AssetHierarchy Source #
Describes an asset hierarchy that contains a hierarchy's name and ID.
See: newAssetHierarchy smart constructor.
Constructors
| AssetHierarchy' (Maybe Text) Text |
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.
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' (Maybe Text) (Maybe Text) |
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.
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' (Maybe Text) (Maybe Text) (Maybe [AssetModelProperty]) Text Text |
Instances
newAssetModelCompositeModel Source #
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.
AssetModelCompositeModel, assetModelCompositeModel_id - The ID of the asset model composite model.
$sel:properties:AssetModelCompositeModel', assetModelCompositeModel_properties - The asset property definitions for this composite model.
AssetModelCompositeModel, assetModelCompositeModel_name - The name of the composite model.
AssetModelCompositeModel, assetModelCompositeModel_type - 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' (Maybe Text) (Maybe [AssetModelPropertyDefinition]) Text Text |
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.
AssetModelCompositeModelDefinition, assetModelCompositeModelDefinition_name - The name of the composite model.
AssetModelCompositeModelDefinition, assetModelCompositeModelDefinition_type - 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' (Maybe Text) Text Text |
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.
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' Text Text |
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.
AssetModelProperty
data AssetModelProperty Source #
Contains information about an asset model property.
See: newAssetModelProperty smart constructor.
Constructors
| AssetModelProperty' (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType |
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).
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' (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType |
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.
AssetModelPropertySummary
data AssetModelPropertySummary Source #
Contains a summary of a property associated with a model.
See: newAssetModelPropertySummary smart constructor.
Constructors
| AssetModelPropertySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType PropertyType |
Instances
newAssetModelPropertySummary Source #
Arguments
| :: Text | |
| -> PropertyDataType | |
| -> PropertyType | |
| -> AssetModelPropertySummary |
Create a value of AssetModelPropertySummary 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:assetModelCompositeModelId:AssetModelPropertySummary', assetModelPropertySummary_assetModelCompositeModelId - The ID of the composite model that contains the asset model property.
$sel:dataTypeSpec:AssetModelPropertySummary', assetModelPropertySummary_dataTypeSpec - The data type of the structure for this property. This parameter exists
on properties that have the STRUCT data type.
$sel:id:AssetModelPropertySummary', assetModelPropertySummary_id - The ID of the property.
$sel:unit:AssetModelPropertySummary', assetModelPropertySummary_unit - The unit (such as Newtons or RPM) of the property.
$sel:name:AssetModelPropertySummary', assetModelPropertySummary_name - The name of the property.
$sel:dataType:AssetModelPropertySummary', assetModelPropertySummary_dataType - The data type of the property.
$sel:type':AssetModelPropertySummary', assetModelPropertySummary_type - Undocumented member.
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' (Maybe ErrorDetails) AssetModelState |
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.
AssetModelSummary
data AssetModelSummary Source #
Contains a summary of an asset model.
See: newAssetModelSummary smart constructor.
Constructors
| AssetModelSummary' Text Text Text Text POSIX POSIX AssetModelStatus |
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.
AssetProperty
data AssetProperty Source #
Contains asset property information.
See: newAssetProperty smart constructor.
Constructors
| AssetProperty' (Maybe Text) (Maybe Text) (Maybe PropertyNotification) (Maybe Text) Text Text PropertyDataType |
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: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: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: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.
AssetPropertySummary
data AssetPropertySummary Source #
Contains a summary of a property associated with an asset.
See: newAssetPropertySummary smart constructor.
Constructors
| AssetPropertySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PropertyNotification) (Maybe Text) |
Instances
newAssetPropertySummary :: AssetPropertySummary Source #
Create a value of AssetPropertySummary 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:alias:AssetPropertySummary', assetPropertySummary_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:assetCompositeModelId:AssetPropertySummary', assetPropertySummary_assetCompositeModelId - The ID of the composite model that contains the asset property.
$sel:id:AssetPropertySummary', assetPropertySummary_id - The ID of the property.
$sel:notification:AssetPropertySummary', assetPropertySummary_notification - Undocumented member.
$sel:unit:AssetPropertySummary', assetPropertySummary_unit - The unit of measure (such as Newtons or RPM) of the asset property.
AssetPropertyValue
data AssetPropertyValue Source #
Contains asset property value information.
See: newAssetPropertyValue smart constructor.
Constructors
| AssetPropertyValue' (Maybe Quality) Variant TimeInNanos |
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.
AssetRelationshipSummary
data AssetRelationshipSummary Source #
Contains information about assets that are related to one another.
See: newAssetRelationshipSummary smart constructor.
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.
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' (Maybe ErrorDetails) AssetState |
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.
AssetSummary
data AssetSummary Source #
Contains a summary of an asset.
See: newAssetSummary smart constructor.
Constructors
| AssetSummary' (Maybe Text) Text Text Text Text POSIX POSIX AssetStatus [AssetHierarchy] |
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:description:AssetSummary', assetSummary_description - A description for the asset.
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}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.
AssociatedAssetsSummary
data AssociatedAssetsSummary Source #
Contains a summary of an associated asset.
See: newAssociatedAssetsSummary smart constructor.
Constructors
| AssociatedAssetsSummary' (Maybe Text) Text Text Text Text POSIX POSIX AssetStatus [AssetHierarchy] |
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:description:AssociatedAssetsSummary', associatedAssetsSummary_description - A description for the asset.
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}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.
Attribute
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.
See: newAttribute smart constructor.
Constructors
| Attribute' (Maybe Text) |
Instances
| FromJSON Attribute Source # | |
| ToJSON Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| Generic Attribute Source # | |
| Read Attribute Source # | |
| Show Attribute Source # | |
| NFData Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| Eq Attribute Source # | |
| Hashable Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute | |
| type Rep Attribute Source # | |
Defined in Amazonka.IoTSiteWise.Types.Attribute type Rep Attribute = D1 ('MetaData "Attribute" "Amazonka.IoTSiteWise.Types.Attribute" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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.
BatchGetAssetPropertyAggregatesEntry
data BatchGetAssetPropertyAggregatesEntry Source #
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
- The
assetIdandpropertyIdof an asset property. - A
propertyAlias, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
See: newBatchGetAssetPropertyAggregatesEntry smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe TimeOrdering) Text (NonEmpty AggregateType) Text POSIX POSIX |
Instances
newBatchGetAssetPropertyAggregatesEntry Source #
Arguments
| :: Text | |
| -> NonEmpty AggregateType | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> BatchGetAssetPropertyAggregatesEntry |
Create a value of BatchGetAssetPropertyAggregatesEntry 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:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_assetId - The ID of the asset in which the asset property was created.
$sel:propertyAlias:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_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:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_propertyId - The ID of the asset property.
$sel:qualities:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_qualities - The quality by which to filter asset data.
$sel:timeOrdering:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_timeOrdering - The chronological sorting order of the requested information.
Default: ASCENDING
$sel:entryId:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_entryId - The ID of the entry.
$sel:aggregateTypes:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_aggregateTypes - The data aggregating function.
$sel:resolution:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_resolution - The time interval over which to aggregate data.
$sel:startDate:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_startDate - The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
$sel:endDate:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_endDate - The inclusive end of the range from which to query historical data,
expressed in seconds in Unix epoch time.
BatchGetAssetPropertyAggregatesErrorEntry
data BatchGetAssetPropertyAggregatesErrorEntry Source #
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
See: newBatchGetAssetPropertyAggregatesErrorEntry smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesErrorEntry' BatchGetAssetPropertyAggregatesErrorCode Text Text |
Instances
newBatchGetAssetPropertyAggregatesErrorEntry Source #
Arguments
| :: BatchGetAssetPropertyAggregatesErrorCode | |
| -> Text |
|
| -> Text | |
| -> BatchGetAssetPropertyAggregatesErrorEntry |
Create a value of BatchGetAssetPropertyAggregatesErrorEntry 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:BatchGetAssetPropertyAggregatesErrorEntry', batchGetAssetPropertyAggregatesErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchGetAssetPropertyAggregatesErrorEntry', batchGetAssetPropertyAggregatesErrorEntry_errorMessage - The associated error message.
$sel:entryId:BatchGetAssetPropertyAggregatesErrorEntry', batchGetAssetPropertyAggregatesErrorEntry_entryId - The ID of the entry.
BatchGetAssetPropertyAggregatesErrorInfo
data BatchGetAssetPropertyAggregatesErrorInfo Source #
Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
See: newBatchGetAssetPropertyAggregatesErrorInfo smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesErrorInfo' BatchGetAssetPropertyAggregatesErrorCode POSIX |
Instances
newBatchGetAssetPropertyAggregatesErrorInfo Source #
Arguments
| :: BatchGetAssetPropertyAggregatesErrorCode | |
| -> UTCTime |
|
| -> BatchGetAssetPropertyAggregatesErrorInfo |
Create a value of BatchGetAssetPropertyAggregatesErrorInfo 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:BatchGetAssetPropertyAggregatesErrorInfo', batchGetAssetPropertyAggregatesErrorInfo_errorCode - The error code.
$sel:errorTimestamp:BatchGetAssetPropertyAggregatesErrorInfo', batchGetAssetPropertyAggregatesErrorInfo_errorTimestamp - The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyAggregatesSkippedEntry
data BatchGetAssetPropertyAggregatesSkippedEntry Source #
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
See: newBatchGetAssetPropertyAggregatesSkippedEntry smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesSkippedEntry' (Maybe BatchGetAssetPropertyAggregatesErrorInfo) Text BatchEntryCompletionStatus |
Instances
newBatchGetAssetPropertyAggregatesSkippedEntry Source #
Arguments
| :: Text | |
| -> BatchEntryCompletionStatus |
|
| -> BatchGetAssetPropertyAggregatesSkippedEntry |
Create a value of BatchGetAssetPropertyAggregatesSkippedEntry 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:errorInfo:BatchGetAssetPropertyAggregatesSkippedEntry', batchGetAssetPropertyAggregatesSkippedEntry_errorInfo - The error information, such as the error code and the timestamp.
$sel:entryId:BatchGetAssetPropertyAggregatesSkippedEntry', batchGetAssetPropertyAggregatesSkippedEntry_entryId - The ID of the entry.
$sel:completionStatus:BatchGetAssetPropertyAggregatesSkippedEntry', batchGetAssetPropertyAggregatesSkippedEntry_completionStatus - The completion status of each entry that is associated with the
BatchGetAssetPropertyAggregates
API.
BatchGetAssetPropertyAggregatesSuccessEntry
data BatchGetAssetPropertyAggregatesSuccessEntry Source #
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
See: newBatchGetAssetPropertyAggregatesSuccessEntry smart constructor.
Constructors
| BatchGetAssetPropertyAggregatesSuccessEntry' Text [AggregatedValue] |
Instances
newBatchGetAssetPropertyAggregatesSuccessEntry Source #
Arguments
| :: Text | |
| -> BatchGetAssetPropertyAggregatesSuccessEntry |
Create a value of BatchGetAssetPropertyAggregatesSuccessEntry 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:BatchGetAssetPropertyAggregatesSuccessEntry', batchGetAssetPropertyAggregatesSuccessEntry_entryId - The ID of the entry.
$sel:aggregatedValues:BatchGetAssetPropertyAggregatesSuccessEntry', batchGetAssetPropertyAggregatesSuccessEntry_aggregatedValues - The requested aggregated asset property values (for example, average,
minimum, and maximum).
BatchGetAssetPropertyValueEntry
data BatchGetAssetPropertyValueEntry Source #
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
- The
assetIdandpropertyIdof an asset property. - A
propertyAlias, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
See: newBatchGetAssetPropertyValueEntry smart constructor.
Instances
newBatchGetAssetPropertyValueEntry Source #
Create a value of BatchGetAssetPropertyValueEntry 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:BatchGetAssetPropertyValueEntry', batchGetAssetPropertyValueEntry_assetId - The ID of the asset in which the asset property was created.
$sel:propertyAlias:BatchGetAssetPropertyValueEntry', batchGetAssetPropertyValueEntry_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:BatchGetAssetPropertyValueEntry', batchGetAssetPropertyValueEntry_propertyId - The ID of the asset property.
$sel:entryId:BatchGetAssetPropertyValueEntry', batchGetAssetPropertyValueEntry_entryId - The ID of the entry.
BatchGetAssetPropertyValueErrorEntry
data BatchGetAssetPropertyValueErrorEntry Source #
Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
See: newBatchGetAssetPropertyValueErrorEntry smart constructor.
Instances
newBatchGetAssetPropertyValueErrorEntry Source #
Arguments
| :: BatchGetAssetPropertyValueErrorCode | |
| -> Text | |
| -> Text | |
| -> BatchGetAssetPropertyValueErrorEntry |
Create a value of BatchGetAssetPropertyValueErrorEntry 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:BatchGetAssetPropertyValueErrorEntry', batchGetAssetPropertyValueErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchGetAssetPropertyValueErrorEntry', batchGetAssetPropertyValueErrorEntry_errorMessage - The associated error message.
$sel:entryId:BatchGetAssetPropertyValueErrorEntry', batchGetAssetPropertyValueErrorEntry_entryId - The ID of the entry.
BatchGetAssetPropertyValueErrorInfo
data BatchGetAssetPropertyValueErrorInfo Source #
The error information, such as the error code and the timestamp.
See: newBatchGetAssetPropertyValueErrorInfo smart constructor.
Instances
newBatchGetAssetPropertyValueErrorInfo Source #
Create a value of BatchGetAssetPropertyValueErrorInfo 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:BatchGetAssetPropertyValueErrorInfo', batchGetAssetPropertyValueErrorInfo_errorCode - The error code.
$sel:errorTimestamp:BatchGetAssetPropertyValueErrorInfo', batchGetAssetPropertyValueErrorInfo_errorTimestamp - The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyValueHistoryEntry
data BatchGetAssetPropertyValueHistoryEntry Source #
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
- The
assetIdandpropertyIdof an asset property. - A
propertyAlias, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
See: newBatchGetAssetPropertyValueHistoryEntry smart constructor.
Constructors
| BatchGetAssetPropertyValueHistoryEntry' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Quality)) (Maybe POSIX) (Maybe TimeOrdering) Text |
Instances
newBatchGetAssetPropertyValueHistoryEntry Source #
Arguments
| :: Text | |
| -> BatchGetAssetPropertyValueHistoryEntry |
Create a value of BatchGetAssetPropertyValueHistoryEntry 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:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_assetId - The ID of the asset in which the asset property was created.
$sel:endDate:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_endDate - The inclusive end of the range from which to query historical data,
expressed in seconds in Unix epoch time.
$sel:propertyAlias:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_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:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_propertyId - The ID of the asset property.
$sel:qualities:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_qualities - The quality by which to filter asset data.
$sel:startDate:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_startDate - The exclusive start of the range from which to query historical data,
expressed in seconds in Unix epoch time.
$sel:timeOrdering:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_timeOrdering - The chronological sorting order of the requested information.
Default: ASCENDING
$sel:entryId:BatchGetAssetPropertyValueHistoryEntry', batchGetAssetPropertyValueHistoryEntry_entryId - The ID of the entry.
BatchGetAssetPropertyValueHistoryErrorEntry
data BatchGetAssetPropertyValueHistoryErrorEntry Source #
A list of the errors (if any) associated with the batch request. Each
error entry contains the entryId of the entry that failed.
See: newBatchGetAssetPropertyValueHistoryErrorEntry smart constructor.
Constructors
| BatchGetAssetPropertyValueHistoryErrorEntry' BatchGetAssetPropertyValueHistoryErrorCode Text Text |
Instances
newBatchGetAssetPropertyValueHistoryErrorEntry Source #
Arguments
| :: BatchGetAssetPropertyValueHistoryErrorCode | |
| -> Text |
|
| -> Text | |
| -> BatchGetAssetPropertyValueHistoryErrorEntry |
Create a value of BatchGetAssetPropertyValueHistoryErrorEntry 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:BatchGetAssetPropertyValueHistoryErrorEntry', batchGetAssetPropertyValueHistoryErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchGetAssetPropertyValueHistoryErrorEntry', batchGetAssetPropertyValueHistoryErrorEntry_errorMessage - The associated error message.
$sel:entryId:BatchGetAssetPropertyValueHistoryErrorEntry', batchGetAssetPropertyValueHistoryErrorEntry_entryId - The ID of the entry.
BatchGetAssetPropertyValueHistoryErrorInfo
data BatchGetAssetPropertyValueHistoryErrorInfo Source #
The error information, such as the error code and the timestamp.
See: newBatchGetAssetPropertyValueHistoryErrorInfo smart constructor.
Constructors
| BatchGetAssetPropertyValueHistoryErrorInfo' BatchGetAssetPropertyValueHistoryErrorCode POSIX |
Instances
newBatchGetAssetPropertyValueHistoryErrorInfo Source #
Arguments
| :: BatchGetAssetPropertyValueHistoryErrorCode | |
| -> UTCTime |
|
| -> BatchGetAssetPropertyValueHistoryErrorInfo |
Create a value of BatchGetAssetPropertyValueHistoryErrorInfo 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:BatchGetAssetPropertyValueHistoryErrorInfo', batchGetAssetPropertyValueHistoryErrorInfo_errorCode - The error code.
$sel:errorTimestamp:BatchGetAssetPropertyValueHistoryErrorInfo', batchGetAssetPropertyValueHistoryErrorInfo_errorTimestamp - The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyValueHistorySkippedEntry
data BatchGetAssetPropertyValueHistorySkippedEntry Source #
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
See: newBatchGetAssetPropertyValueHistorySkippedEntry smart constructor.
Constructors
| BatchGetAssetPropertyValueHistorySkippedEntry' (Maybe BatchGetAssetPropertyValueHistoryErrorInfo) Text BatchEntryCompletionStatus |
Instances
newBatchGetAssetPropertyValueHistorySkippedEntry Source #
Arguments
| :: Text | |
| -> BatchEntryCompletionStatus |
|
| -> BatchGetAssetPropertyValueHistorySkippedEntry |
Create a value of BatchGetAssetPropertyValueHistorySkippedEntry 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:errorInfo:BatchGetAssetPropertyValueHistorySkippedEntry', batchGetAssetPropertyValueHistorySkippedEntry_errorInfo - The error information, such as the error code and the timestamp.
$sel:entryId:BatchGetAssetPropertyValueHistorySkippedEntry', batchGetAssetPropertyValueHistorySkippedEntry_entryId - The ID of the entry.
$sel:completionStatus:BatchGetAssetPropertyValueHistorySkippedEntry', batchGetAssetPropertyValueHistorySkippedEntry_completionStatus - The completion status of each entry that is associated with the
BatchGetAssetPropertyValueHistory
API.
BatchGetAssetPropertyValueHistorySuccessEntry
data BatchGetAssetPropertyValueHistorySuccessEntry Source #
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
See: newBatchGetAssetPropertyValueHistorySuccessEntry smart constructor.
Instances
newBatchGetAssetPropertyValueHistorySuccessEntry Source #
Arguments
| :: Text | |
| -> BatchGetAssetPropertyValueHistorySuccessEntry |
Create a value of BatchGetAssetPropertyValueHistorySuccessEntry 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:BatchGetAssetPropertyValueHistorySuccessEntry', batchGetAssetPropertyValueHistorySuccessEntry_entryId - The ID of the entry.
$sel:assetPropertyValueHistory:BatchGetAssetPropertyValueHistorySuccessEntry', batchGetAssetPropertyValueHistorySuccessEntry_assetPropertyValueHistory - The requested historical values for the specified asset property.
BatchGetAssetPropertyValueSkippedEntry
data BatchGetAssetPropertyValueSkippedEntry Source #
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
See: newBatchGetAssetPropertyValueSkippedEntry smart constructor.
Constructors
| BatchGetAssetPropertyValueSkippedEntry' (Maybe BatchGetAssetPropertyValueErrorInfo) Text BatchEntryCompletionStatus |
Instances
newBatchGetAssetPropertyValueSkippedEntry Source #
Arguments
| :: Text | |
| -> BatchEntryCompletionStatus |
|
| -> BatchGetAssetPropertyValueSkippedEntry |
Create a value of BatchGetAssetPropertyValueSkippedEntry 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:errorInfo:BatchGetAssetPropertyValueSkippedEntry', batchGetAssetPropertyValueSkippedEntry_errorInfo - The error information, such as the error code and the timestamp.
$sel:entryId:BatchGetAssetPropertyValueSkippedEntry', batchGetAssetPropertyValueSkippedEntry_entryId - The ID of the entry.
$sel:completionStatus:BatchGetAssetPropertyValueSkippedEntry', batchGetAssetPropertyValueSkippedEntry_completionStatus - The completion status of each entry that is associated with the
BatchGetAssetPropertyValue
request.
BatchGetAssetPropertyValueSuccessEntry
data BatchGetAssetPropertyValueSuccessEntry Source #
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
See: newBatchGetAssetPropertyValueSuccessEntry smart constructor.
Constructors
| BatchGetAssetPropertyValueSuccessEntry' (Maybe AssetPropertyValue) Text |
Instances
newBatchGetAssetPropertyValueSuccessEntry Source #
Arguments
| :: Text | |
| -> BatchGetAssetPropertyValueSuccessEntry |
Create a value of BatchGetAssetPropertyValueSuccessEntry 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:assetPropertyValue:BatchGetAssetPropertyValueSuccessEntry', batchGetAssetPropertyValueSuccessEntry_assetPropertyValue - Undocumented member.
$sel:entryId:BatchGetAssetPropertyValueSuccessEntry', batchGetAssetPropertyValueSuccessEntry_entryId - The ID of the entry.
BatchPutAssetPropertyError
data BatchPutAssetPropertyError Source #
Contains error information from updating a batch of asset property values.
See: newBatchPutAssetPropertyError smart constructor.
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.
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' Text [BatchPutAssetPropertyError] |
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.
CompositeModelProperty
data CompositeModelProperty Source #
Contains information about a composite model property on an asset.
See: newCompositeModelProperty smart constructor.
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:
CompositeModelProperty, compositeModelProperty_id - The ID of the composite model that contains the property.
CompositeModelProperty, compositeModelProperty_name - The name of the property.
CompositeModelProperty, compositeModelProperty_type - The type of the composite model that defines this property.
$sel:assetProperty:CompositeModelProperty', compositeModelProperty_assetProperty - Undocumented member.
ConfigurationErrorDetails
data ConfigurationErrorDetails Source #
Contains the details of an IoT SiteWise configuration error.
See: newConfigurationErrorDetails smart constructor.
Constructors
| ConfigurationErrorDetails' ErrorCode Text |
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.
ConfigurationStatus
data ConfigurationStatus Source #
Contains current status information for the configuration.
See: newConfigurationStatus smart constructor.
Constructors
| ConfigurationStatus' (Maybe ConfigurationErrorDetails) ConfigurationState |
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.
Csv
A .csv file.
See: newCsv smart constructor.
Constructors
| Csv' (Maybe [ColumnName]) |
Instances
| FromJSON Csv Source # | |
| ToJSON Csv Source # | |
Defined in Amazonka.IoTSiteWise.Types.Csv | |
| Generic Csv Source # | |
| Read Csv Source # | |
| Show Csv Source # | |
| NFData Csv Source # | |
Defined in Amazonka.IoTSiteWise.Types.Csv | |
| Eq Csv Source # | |
| Hashable Csv Source # | |
Defined in Amazonka.IoTSiteWise.Types.Csv | |
| type Rep Csv Source # | |
Defined in Amazonka.IoTSiteWise.Types.Csv type Rep Csv = D1 ('MetaData "Csv" "Amazonka.IoTSiteWise.Types.Csv" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "Csv'" 'PrefixI 'True) (S1 ('MetaSel ('Just "columnNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnName])))) | |
Create a value of Csv 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:columnNames:Csv', csv_columnNames - The column names specified in the .csv file.
CustomerManagedS3Storage
data CustomerManagedS3Storage Source #
Contains information about a customer managed Amazon S3 bucket.
See: newCustomerManagedS3Storage smart constructor.
Constructors
| CustomerManagedS3Storage' Text Text |
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.
DashboardSummary
data DashboardSummary Source #
Contains a dashboard summary.
See: newDashboardSummary smart constructor.
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:creationDate:DashboardSummary', dashboardSummary_creationDate - The date the dashboard was created, in Unix epoch time.
$sel:description:DashboardSummary', dashboardSummary_description - The dashboard's description.
$sel:lastUpdateDate:DashboardSummary', dashboardSummary_lastUpdateDate - The date the dashboard was last updated, in Unix epoch time.
$sel:id:DashboardSummary', dashboardSummary_id - The ID of the dashboard.
$sel:name:DashboardSummary', dashboardSummary_name - The name of the dashboard
DetailedError
data DetailedError Source #
Contains detailed error information.
See: newDetailedError smart constructor.
Constructors
| DetailedError' DetailedErrorCode Text |
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.
ErrorDetails
data ErrorDetails Source #
Contains the details of an IoT SiteWise error.
See: newErrorDetails smart constructor.
Constructors
| ErrorDetails' (Maybe [DetailedError]) ErrorCode Text |
Instances
Arguments
| :: ErrorCode | |
| -> Text | |
| -> ErrorDetails |
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.
ErrorDetails, errorDetails_code - The error code.
ErrorDetails, errorDetails_message - The error message.
ErrorReportLocation
data ErrorReportLocation Source #
The Amazon S3 destination where errors associated with the job creation request are saved.
See: newErrorReportLocation smart constructor.
Constructors
| ErrorReportLocation' Text Text |
Instances
newErrorReportLocation Source #
Arguments
| :: Text | |
| -> Text | |
| -> ErrorReportLocation |
Create a value of ErrorReportLocation 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:bucket:ErrorReportLocation', errorReportLocation_bucket - The name of the Amazon S3 bucket to which errors associated with the
bulk import job are sent.
$sel:prefix:ErrorReportLocation', errorReportLocation_prefix - Amazon S3 uses the prefix as a folder name to organize data in the
bucket. Each Amazon S3 object has a key that is its unique identifier in
the bucket. Each object in a bucket has exactly one key. The prefix must
end with a forward slash (/). For more information, see
Organizing objects using prefixes
in the Amazon Simple Storage Service User Guide.
ExpressionVariable
data ExpressionVariable Source #
Contains expression variable information.
See: newExpressionVariable smart constructor.
Constructors
| ExpressionVariable' Text VariableValue |
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.
File
The file in Amazon S3 where your data is saved.
See: newFile smart constructor.
Instances
| FromJSON File Source # | |
| ToJSON File Source # | |
Defined in Amazonka.IoTSiteWise.Types.File | |
| Generic File Source # | |
| Read File Source # | |
| Show File Source # | |
| NFData File Source # | |
Defined in Amazonka.IoTSiteWise.Types.File | |
| Eq File Source # | |
| Hashable File Source # | |
Defined in Amazonka.IoTSiteWise.Types.File | |
| type Rep File Source # | |
Defined in Amazonka.IoTSiteWise.Types.File type Rep File = D1 ('MetaData "File" "Amazonka.IoTSiteWise.Types.File" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "File'" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of File 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:versionId:File', file_versionId - The version ID to identify a specific version of the Amazon S3 object
that contains your data.
$sel:bucket:File', file_bucket - The name of the Amazon S3 bucket from which data is imported.
$sel:key:File', file_key - The key of the Amazon S3 object that contains your data. Each object has
a key that is a unique identifier. Each object has exactly one key.
FileFormat
data FileFormat Source #
The file format of the data.
See: newFileFormat smart constructor.
Constructors
| FileFormat' (Maybe Csv) |
Instances
newFileFormat :: FileFormat Source #
Create a value of FileFormat 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:csv:FileFormat', fileFormat_csv - The .csv file format.
ForwardingConfig
data ForwardingConfig Source #
The forwarding configuration for a given property.
See: newForwardingConfig smart constructor.
Constructors
| ForwardingConfig' ForwardingConfigState |
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.
GatewayCapabilitySummary
data GatewayCapabilitySummary Source #
Contains a summary of a gateway capability configuration.
See: newGatewayCapabilitySummary smart constructor.
Constructors
| GatewayCapabilitySummary' Text CapabilitySyncStatus |
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.
GatewayPlatform
data GatewayPlatform Source #
Contains a gateway's platform information.
See: newGatewayPlatform smart constructor.
Constructors
| GatewayPlatform' (Maybe Greengrass) (Maybe GreengrassV2) |
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.
GatewaySummary
data GatewaySummary Source #
Contains a summary of a gateway.
See: newGatewaySummary smart constructor.
Constructors
| GatewaySummary' (Maybe [GatewayCapabilitySummary]) (Maybe GatewayPlatform) Text Text POSIX POSIX |
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: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:gatewayPlatform:GatewaySummary', gatewaySummary_gatewayPlatform - Undocumented member.
$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.
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' Text |
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.
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' Text |
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.
GroupIdentity
data GroupIdentity Source #
Contains information for a group identity in an access policy.
See: newGroupIdentity smart constructor.
Constructors
| GroupIdentity' Text |
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 IAM Identity Center 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' Text |
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.
IAMUserIdentity
data IAMUserIdentity Source #
Contains information about an Identity and Access Management user.
See: newIAMUserIdentity smart constructor.
Constructors
| IAMUserIdentity' Text |
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.
Identity
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
See: newIdentity smart constructor.
Constructors
| Identity' (Maybe GroupIdentity) (Maybe IAMRoleIdentity) (Maybe IAMUserIdentity) (Maybe UserIdentity) |
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:group':Identity', identity_group - An IAM Identity Center group identity.
$sel:iamRole:Identity', identity_iamRole - An IAM role identity.
$sel:iamUser:Identity', identity_iamUser - An IAM user identity.
$sel:user:Identity', identity_user - An IAM Identity Center user 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.
Instances
| ToJSON Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image | |
| Generic Image Source # | |
| Read Image Source # | |
| Show Image Source # | |
| NFData Image Source # | |
Defined in Amazonka.IoTSiteWise.Types.Image | |
| Eq Image Source # | |
| Hashable 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" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "Image'" 'PrefixI 'True) (S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageFile)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
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:file:Image', image_file - Undocumented member.
$sel:id:Image', image_id - 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' Base64 ImageFileType |
Instances
| ToJSON ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile | |
| Generic ImageFile Source # | |
| Read ImageFile Source # | |
| Show ImageFile Source # | |
| NFData ImageFile Source # | |
Defined in Amazonka.IoTSiteWise.Types.ImageFile | |
| Eq ImageFile Source # | |
| Hashable 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" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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.
ImageLocation
data ImageLocation Source #
Contains an image that is uploaded to IoT SiteWise and available at a URL.
See: newImageLocation smart constructor.
Constructors
| ImageLocation' Text Text |
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
InterpolatedAssetPropertyValue
data InterpolatedAssetPropertyValue Source #
Contains information about an interpolated asset property value.
See: newInterpolatedAssetPropertyValue smart constructor.
Constructors
| InterpolatedAssetPropertyValue' TimeInNanos Variant |
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.
JobConfiguration
data JobConfiguration Source #
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
See: newJobConfiguration smart constructor.
Constructors
| JobConfiguration' FileFormat |
Instances
Arguments
| :: FileFormat | |
| -> JobConfiguration |
Create a value of JobConfiguration 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:fileFormat:JobConfiguration', jobConfiguration_fileFormat - The file format of the data in Amazon S3.
JobSummary
data JobSummary Source #
Contains a job summary information.
See: newJobSummary smart constructor.
Constructors
| JobSummary' Text Text JobStatus |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> JobStatus | |
| -> JobSummary |
Create a value of JobSummary 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:JobSummary', jobSummary_id - The ID of the job.
$sel:name:JobSummary', jobSummary_name - The unique name that helps identify the job request.
$sel:status:JobSummary', jobSummary_status - The status of the bulk import job can be one of following values.
PENDING– IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED– The bulk import job has been canceled.RUNNING– IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED– IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED– IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES– IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
LoggingOptions
data LoggingOptions Source #
Contains logging options.
See: newLoggingOptions smart constructor.
Constructors
| LoggingOptions' LoggingLevel |
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.
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' (Maybe MeasurementProcessingConfig) |
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.
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' ForwardingConfig |
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.
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' (Maybe MetricProcessingConfig) Text [ExpressionVariable] MetricWindow |
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.
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' ComputeLocation |
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.
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' (Maybe TumblingWindow) |
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.
MonitorErrorDetails
data MonitorErrorDetails Source #
Contains IoT SiteWise Monitor error details.
See: newMonitorErrorDetails smart constructor.
Constructors
| MonitorErrorDetails' (Maybe MonitorErrorCode) (Maybe Text) |
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.
MultiLayerStorage
data MultiLayerStorage Source #
Contains information about the storage destination.
See: newMultiLayerStorage smart constructor.
Constructors
| MultiLayerStorage' CustomerManagedS3Storage |
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.
PortalResource
data PortalResource Source #
Identifies an IoT SiteWise Monitor portal.
See: newPortalResource smart constructor.
Constructors
| PortalResource' Text |
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.
PortalStatus
data PortalStatus Source #
Contains information about the current status of a portal.
See: newPortalStatus smart constructor.
Constructors
| PortalStatus' (Maybe MonitorErrorDetails) PortalState |
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.
PortalSummary
data PortalSummary Source #
Contains a portal summary.
See: newPortalSummary smart constructor.
Constructors
| PortalSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) Text Text Text PortalStatus |
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:creationDate:PortalSummary', portalSummary_creationDate - The date the portal was created, in Unix epoch time.
$sel:description:PortalSummary', portalSummary_description - The portal's description.
$sel:lastUpdateDate:PortalSummary', portalSummary_lastUpdateDate - The date the portal was last updated, in Unix epoch time.
$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 IAM Identity Center 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.
ProjectResource
data ProjectResource Source #
Identifies a specific IoT SiteWise Monitor project.
See: newProjectResource smart constructor.
Constructors
| ProjectResource' Text |
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.
ProjectSummary
data ProjectSummary Source #
Contains project summary information.
See: newProjectSummary smart constructor.
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:creationDate:ProjectSummary', projectSummary_creationDate - The date the project was created, in Unix epoch time.
$sel:description:ProjectSummary', projectSummary_description - The project's description.
$sel:lastUpdateDate:ProjectSummary', projectSummary_lastUpdateDate - The date the project was last updated, in Unix epoch time.
$sel:id:ProjectSummary', projectSummary_id - The ID of the project.
$sel:name:ProjectSummary', projectSummary_name - The name of the project.
Property
Contains asset property information.
See: newProperty smart constructor.
Constructors
| Property' (Maybe Text) (Maybe PropertyNotification) (Maybe PropertyType) (Maybe Text) Text Text PropertyDataType |
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: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:notification:Property', property_notification - The asset property's notification topic and state. For more
information, see
UpdateAssetProperty.
$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.
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' Text PropertyNotificationState |
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.
PropertyType
data PropertyType Source #
Contains a property type, which can be one of attribute,
measurement, metric, or transform.
See: newPropertyType smart constructor.
Constructors
| PropertyType' (Maybe Attribute) (Maybe Measurement) (Maybe Metric) (Maybe Transform) |
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: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.
$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: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.
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' (Maybe Text) (Maybe Text) (Maybe Text) Text [AssetPropertyValue] |
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:assetId:PutAssetPropertyValueEntry', putAssetPropertyValueEntry_assetId - The ID of the asset to update.
$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: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.
Resource
Contains an IoT SiteWise Monitor resource ID for a portal or project.
See: newResource smart constructor.
Constructors
| Resource' (Maybe PortalResource) (Maybe ProjectResource) |
Instances
| FromJSON Resource Source # | |
| ToJSON Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| Generic Resource Source # | |
| Read Resource Source # | |
| Show Resource Source # | |
| NFData Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| Eq Resource Source # | |
| Hashable Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource | |
| type Rep Resource Source # | |
Defined in Amazonka.IoTSiteWise.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.IoTSiteWise.Types.Resource" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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.
RetentionPeriod
data RetentionPeriod Source #
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
See: newRetentionPeriod smart constructor.
Constructors
| RetentionPeriod' (Maybe Natural) (Maybe Bool) |
Instances
newRetentionPeriod :: RetentionPeriod Source #
Create a value of RetentionPeriod 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:numberOfDays:RetentionPeriod', retentionPeriod_numberOfDays - The number of days that your data is kept.
If you specified a value for this parameter, the unlimited parameter
must be false.
$sel:unlimited:RetentionPeriod', retentionPeriod_unlimited - If true, your data is kept indefinitely.
If configured to true, you must not specify a value for the
numberOfDays parameter.
TimeInNanos
data TimeInNanos Source #
Contains a timestamp with optional nanosecond granularity.
See: newTimeInNanos smart constructor.
Constructors
| TimeInNanos' (Maybe Natural) Natural |
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.
TimeSeriesSummary
data TimeSeriesSummary Source #
Contains a summary of a time series (data stream).
See: newTimeSeriesSummary smart constructor.
Constructors
| TimeSeriesSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text PropertyDataType POSIX POSIX |
Instances
Arguments
| :: Text | |
| -> PropertyDataType | |
| -> UTCTime | |
| -> UTCTime | |
| -> TimeSeriesSummary |
Create a value of TimeSeriesSummary 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:alias:TimeSeriesSummary', timeSeriesSummary_alias - The alias that identifies the time series.
$sel:assetId:TimeSeriesSummary', timeSeriesSummary_assetId - The ID of the asset in which the asset property was created.
$sel:dataTypeSpec:TimeSeriesSummary', timeSeriesSummary_dataTypeSpec - The data type of the structure for this time series. This parameter is
required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model
in which you created the asset property that is associated with your
time series. Use AWS/ALARM_STATE for alarm state in alarm composite
models.
$sel:propertyId:TimeSeriesSummary', timeSeriesSummary_propertyId - The ID of the asset property.
$sel:timeSeriesId:TimeSeriesSummary', timeSeriesSummary_timeSeriesId - The ID of the time series.
$sel:dataType:TimeSeriesSummary', timeSeriesSummary_dataType - The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to
identify the type of the structure for this time series.
$sel:timeSeriesCreationDate:TimeSeriesSummary', timeSeriesSummary_timeSeriesCreationDate - The date that the time series was created, in Unix epoch time.
$sel:timeSeriesLastUpdateDate:TimeSeriesSummary', timeSeriesSummary_timeSeriesLastUpdateDate - The date that the time series was last updated, in Unix epoch time.
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' (Maybe TransformProcessingConfig) Text [ExpressionVariable] |
Instances
| FromJSON Transform Source # | |
| ToJSON Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| Generic Transform Source # | |
| Read Transform Source # | |
| Show Transform Source # | |
| NFData Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| Eq Transform Source # | |
| Hashable Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform | |
| type Rep Transform Source # | |
Defined in Amazonka.IoTSiteWise.Types.Transform type Rep Transform = D1 ('MetaData "Transform" "Amazonka.IoTSiteWise.Types.Transform" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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.
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' (Maybe ForwardingConfig) ComputeLocation |
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.
TumblingWindow
data TumblingWindow Source #
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can 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, h represents hours, d
represents days, 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 5 seconds, PT5M represents 5 minutes, and PT5H
represents 5 hours.
See: newTumblingWindow smart constructor.
Constructors
| TumblingWindow' (Maybe Text) Text |
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 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 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 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 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:00foroffset,5mforinterval, 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 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 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.
UserIdentity
data UserIdentity Source #
Contains information for a user identity in an access policy.
See: newUserIdentity smart constructor.
Constructors
| UserIdentity' Text |
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 IAM Identity Center ID of the user.
VariableValue
data VariableValue Source #
Identifies a property value used in an expression.
See: newVariableValue smart constructor.
Constructors
| VariableValue' (Maybe Text) Text |
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.
Variant
Contains an asset property value (of a single type only).
See: newVariant smart constructor.
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:booleanValue:Variant', variant_booleanValue - Asset property data of type Boolean (true or false).
$sel:doubleValue:Variant', variant_doubleValue - Asset property data of type double (floating point number).
$sel:integerValue:Variant', variant_integerValue - Asset property data of type integer (whole number).
$sel:stringValue:Variant', variant_stringValue - Asset property data of type string (sequence of characters).