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.IotTwinMaker
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchPutPropertyValues
- CreateComponentType
- CreateEntity
- CreateScene
- CreateSyncJob
- CreateWorkspace
- DeleteComponentType
- DeleteEntity
- DeleteScene
- DeleteSyncJob
- DeleteWorkspace
- ExecuteQuery
- GetComponentType
- GetEntity
- GetPricingPlan
- GetPropertyValue
- GetPropertyValueHistory
- GetScene
- GetSyncJob
- GetWorkspace
- ListComponentTypes
- ListEntities
- ListScenes
- ListSyncJobs
- ListSyncResources
- ListTagsForResource
- ListWorkspaces
- TagResource
- UntagResource
- UpdateComponentType
- UpdateEntity
- UpdatePricingPlan
- UpdateScene
- UpdateWorkspace
- Types
- ColumnType
- ComponentUpdateType
- ErrorCode
- GroupType
- InterpolationType
- Order
- OrderByTime
- ParentEntityUpdateType
- PricingMode
- PricingTier
- PropertyGroupUpdateType
- PropertyUpdateType
- Scope
- State
- SyncJobState
- SyncResourceState
- SyncResourceType
- Type
- UpdateReason
- BatchPutPropertyError
- BatchPutPropertyErrorEntry
- BundleInformation
- ColumnDescription
- ComponentPropertyGroupRequest
- ComponentPropertyGroupResponse
- ComponentRequest
- ComponentResponse
- ComponentTypeSummary
- ComponentUpdateRequest
- DataConnector
- DataType
- DataValue
- EntityPropertyReference
- EntitySummary
- ErrorDetails
- FunctionRequest
- FunctionResponse
- InterpolationParameters
- LambdaFunction
- ListComponentTypesFilter
- ListEntitiesFilter
- OrderBy
- ParentEntityUpdateRequest
- PricingPlan
- PropertyDefinitionRequest
- PropertyDefinitionResponse
- PropertyFilter
- PropertyGroupRequest
- PropertyGroupResponse
- PropertyLatestValue
- PropertyRequest
- PropertyResponse
- PropertyValue
- PropertyValueEntry
- PropertyValueHistory
- QueryResultValue
- Relationship
- RelationshipValue
- Row
- SceneSummary
- Status
- SyncJobStatus
- SyncJobSummary
- SyncResourceFilter
- SyncResourceStatus
- SyncResourceSummary
- TabularConditions
- WorkspaceSummary
Description
Derived from API version 2021-11-29
of the AWS service descriptions, licensed under Apache 2.0.
IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ConnectorFailureException :: AsError a => Fold a ServiceError
- _ConnectorTimeoutException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _QueryTimeoutException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchPutPropertyValues = BatchPutPropertyValues' Text (NonEmpty PropertyValueEntry)
- newBatchPutPropertyValues :: Text -> NonEmpty PropertyValueEntry -> BatchPutPropertyValues
- data BatchPutPropertyValuesResponse = BatchPutPropertyValuesResponse' Int (NonEmpty BatchPutPropertyErrorEntry)
- newBatchPutPropertyValuesResponse :: Int -> NonEmpty BatchPutPropertyErrorEntry -> BatchPutPropertyValuesResponse
- data CreateComponentType = CreateComponentType' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionRequest)) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionRequest)) (Maybe (HashMap Text PropertyGroupRequest)) (Maybe (HashMap Text Text)) Text Text
- newCreateComponentType :: Text -> Text -> CreateComponentType
- data CreateComponentTypeResponse = CreateComponentTypeResponse' Int Text POSIX State
- newCreateComponentTypeResponse :: Int -> Text -> UTCTime -> State -> CreateComponentTypeResponse
- data CreateEntity = CreateEntity' (Maybe (HashMap Text ComponentRequest)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateEntity :: Text -> Text -> CreateEntity
- data CreateEntityResponse = CreateEntityResponse' Int Text Text POSIX State
- newCreateEntityResponse :: Int -> Text -> Text -> UTCTime -> State -> CreateEntityResponse
- data CreateScene = CreateScene' (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newCreateScene :: Text -> Text -> Text -> CreateScene
- data CreateSceneResponse = CreateSceneResponse' Int Text POSIX
- newCreateSceneResponse :: Int -> Text -> UTCTime -> CreateSceneResponse
- data CreateSyncJob = CreateSyncJob' (Maybe (HashMap Text Text)) Text Text Text
- newCreateSyncJob :: Text -> Text -> Text -> CreateSyncJob
- data CreateSyncJobResponse = CreateSyncJobResponse' Int Text POSIX SyncJobState
- newCreateSyncJobResponse :: Int -> Text -> UTCTime -> SyncJobState -> CreateSyncJobResponse
- data CreateWorkspace = CreateWorkspace' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newCreateWorkspace :: Text -> Text -> Text -> CreateWorkspace
- data CreateWorkspaceResponse = CreateWorkspaceResponse' Int Text POSIX
- newCreateWorkspaceResponse :: Int -> Text -> UTCTime -> CreateWorkspaceResponse
- data DeleteComponentType = DeleteComponentType' Text Text
- newDeleteComponentType :: Text -> Text -> DeleteComponentType
- data DeleteComponentTypeResponse = DeleteComponentTypeResponse' Int State
- newDeleteComponentTypeResponse :: Int -> State -> DeleteComponentTypeResponse
- data DeleteEntity = DeleteEntity' (Maybe Bool) Text Text
- newDeleteEntity :: Text -> Text -> DeleteEntity
- data DeleteEntityResponse = DeleteEntityResponse' Int State
- newDeleteEntityResponse :: Int -> State -> DeleteEntityResponse
- data DeleteScene = DeleteScene' Text Text
- newDeleteScene :: Text -> Text -> DeleteScene
- data DeleteSceneResponse = DeleteSceneResponse' Int
- newDeleteSceneResponse :: Int -> DeleteSceneResponse
- data DeleteSyncJob = DeleteSyncJob' Text Text
- newDeleteSyncJob :: Text -> Text -> DeleteSyncJob
- data DeleteSyncJobResponse = DeleteSyncJobResponse' Int SyncJobState
- newDeleteSyncJobResponse :: Int -> SyncJobState -> DeleteSyncJobResponse
- data DeleteWorkspace = DeleteWorkspace' Text
- newDeleteWorkspace :: Text -> DeleteWorkspace
- data DeleteWorkspaceResponse = DeleteWorkspaceResponse' Int
- newDeleteWorkspaceResponse :: Int -> DeleteWorkspaceResponse
- data ExecuteQuery = ExecuteQuery' (Maybe Natural) (Maybe Text) Text Text
- newExecuteQuery :: Text -> Text -> ExecuteQuery
- data ExecuteQueryResponse = ExecuteQueryResponse' (Maybe [ColumnDescription]) (Maybe Text) (Maybe [Row]) Int
- newExecuteQueryResponse :: Int -> ExecuteQueryResponse
- data GetComponentType = GetComponentType' Text Text
- newGetComponentType :: Text -> Text -> GetComponentType
- data GetComponentTypeResponse = GetComponentTypeResponse' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionResponse)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionResponse)) (Maybe (HashMap Text PropertyGroupResponse)) (Maybe Status) (Maybe Text) Int Text Text POSIX POSIX Text
- newGetComponentTypeResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> Text -> GetComponentTypeResponse
- data GetEntity = GetEntity' Text Text
- newGetEntity :: Text -> Text -> GetEntity
- data GetEntityResponse = GetEntityResponse' (Maybe (HashMap Text ComponentResponse)) (Maybe Text) (Maybe Text) Int Text Text Text Status Text Text Bool POSIX POSIX
- newGetEntityResponse :: Int -> Text -> Text -> Text -> Status -> Text -> Text -> Bool -> UTCTime -> UTCTime -> GetEntityResponse
- data GetPricingPlan = GetPricingPlan' {
- newGetPricingPlan :: GetPricingPlan
- data GetPricingPlanResponse = GetPricingPlanResponse' (Maybe PricingPlan) Int PricingPlan
- newGetPricingPlanResponse :: Int -> PricingPlan -> GetPricingPlanResponse
- data GetPropertyValue = GetPropertyValue' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe TabularConditions) (NonEmpty Text) Text
- newGetPropertyValue :: NonEmpty Text -> Text -> GetPropertyValue
- data GetPropertyValueResponse = GetPropertyValueResponse' (Maybe Text) (Maybe (HashMap Text PropertyLatestValue)) (Maybe [[HashMap Text DataValue]]) Int
- newGetPropertyValueResponse :: Int -> GetPropertyValueResponse
- data GetPropertyValueHistory = GetPropertyValueHistory' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe InterpolationParameters) (Maybe Natural) (Maybe Text) (Maybe OrderByTime) (Maybe (NonEmpty PropertyFilter)) (Maybe POSIX) (Maybe Text) Text (NonEmpty Text)
- newGetPropertyValueHistory :: Text -> NonEmpty Text -> GetPropertyValueHistory
- data GetPropertyValueHistoryResponse = GetPropertyValueHistoryResponse' (Maybe Text) Int [PropertyValueHistory]
- newGetPropertyValueHistoryResponse :: Int -> GetPropertyValueHistoryResponse
- data GetScene = GetScene' Text Text
- newGetScene :: Text -> Text -> GetScene
- data GetSceneResponse = GetSceneResponse' (Maybe [Text]) (Maybe Text) Int Text Text Text Text POSIX POSIX
- newGetSceneResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetSceneResponse
- data GetSyncJob = GetSyncJob' (Maybe Text) Text
- newGetSyncJob :: Text -> GetSyncJob
- data GetSyncJobResponse = GetSyncJobResponse' Int Text Text Text Text SyncJobStatus POSIX POSIX
- newGetSyncJobResponse :: Int -> Text -> Text -> Text -> Text -> SyncJobStatus -> UTCTime -> UTCTime -> GetSyncJobResponse
- data GetWorkspace = GetWorkspace' Text
- newGetWorkspace :: Text -> GetWorkspace
- data GetWorkspaceResponse = GetWorkspaceResponse' (Maybe Text) Int Text Text Text Text POSIX POSIX
- newGetWorkspaceResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetWorkspaceResponse
- data ListComponentTypes = ListComponentTypes' (Maybe [ListComponentTypesFilter]) (Maybe Natural) (Maybe Text) Text
- newListComponentTypes :: Text -> ListComponentTypes
- data ListComponentTypesResponse = ListComponentTypesResponse' (Maybe Natural) (Maybe Text) Int Text [ComponentTypeSummary]
- newListComponentTypesResponse :: Int -> Text -> ListComponentTypesResponse
- data ListEntities = ListEntities' (Maybe [ListEntitiesFilter]) (Maybe Natural) (Maybe Text) Text
- newListEntities :: Text -> ListEntities
- data ListEntitiesResponse = ListEntitiesResponse' (Maybe [EntitySummary]) (Maybe Text) Int
- newListEntitiesResponse :: Int -> ListEntitiesResponse
- data ListScenes = ListScenes' (Maybe Natural) (Maybe Text) Text
- newListScenes :: Text -> ListScenes
- data ListScenesResponse = ListScenesResponse' (Maybe Text) (Maybe [SceneSummary]) Int
- newListScenesResponse :: Int -> ListScenesResponse
- data ListSyncJobs = ListSyncJobs' (Maybe Natural) (Maybe Text) Text
- newListSyncJobs :: Text -> ListSyncJobs
- data ListSyncJobsResponse = ListSyncJobsResponse' (Maybe Text) (Maybe [SyncJobSummary]) Int
- newListSyncJobsResponse :: Int -> ListSyncJobsResponse
- data ListSyncResources = ListSyncResources' (Maybe [SyncResourceFilter]) (Maybe Natural) (Maybe Text) Text Text
- newListSyncResources :: Text -> Text -> ListSyncResources
- data ListSyncResourcesResponse = ListSyncResourcesResponse' (Maybe Text) (Maybe [SyncResourceSummary]) Int
- newListSyncResourcesResponse :: Int -> ListSyncResourcesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWorkspaces = ListWorkspaces' (Maybe Natural) (Maybe Text)
- newListWorkspaces :: ListWorkspaces
- data ListWorkspacesResponse = ListWorkspacesResponse' (Maybe Text) (Maybe [WorkspaceSummary]) Int
- newListWorkspacesResponse :: Int -> ListWorkspacesResponse
- 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 UpdateComponentType = UpdateComponentType' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionRequest)) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionRequest)) (Maybe (HashMap Text PropertyGroupRequest)) Text Text
- newUpdateComponentType :: Text -> Text -> UpdateComponentType
- data UpdateComponentTypeResponse = UpdateComponentTypeResponse' Int Text Text Text State
- newUpdateComponentTypeResponse :: Int -> Text -> Text -> Text -> State -> UpdateComponentTypeResponse
- data UpdateEntity = UpdateEntity' (Maybe (HashMap Text ComponentUpdateRequest)) (Maybe Text) (Maybe Text) (Maybe ParentEntityUpdateRequest) Text Text
- newUpdateEntity :: Text -> Text -> UpdateEntity
- data UpdateEntityResponse = UpdateEntityResponse' Int POSIX State
- newUpdateEntityResponse :: Int -> UTCTime -> State -> UpdateEntityResponse
- data UpdatePricingPlan = UpdatePricingPlan' (Maybe (NonEmpty Text)) PricingMode
- newUpdatePricingPlan :: PricingMode -> UpdatePricingPlan
- data UpdatePricingPlanResponse = UpdatePricingPlanResponse' (Maybe PricingPlan) Int PricingPlan
- newUpdatePricingPlanResponse :: Int -> PricingPlan -> UpdatePricingPlanResponse
- data UpdateScene = UpdateScene' (Maybe [Text]) (Maybe Text) (Maybe Text) Text Text
- newUpdateScene :: Text -> Text -> UpdateScene
- data UpdateSceneResponse = UpdateSceneResponse' Int POSIX
- newUpdateSceneResponse :: Int -> UTCTime -> UpdateSceneResponse
- data UpdateWorkspace = UpdateWorkspace' (Maybe Text) (Maybe Text) Text
- newUpdateWorkspace :: Text -> UpdateWorkspace
- data UpdateWorkspaceResponse = UpdateWorkspaceResponse' Int POSIX
- newUpdateWorkspaceResponse :: Int -> UTCTime -> UpdateWorkspaceResponse
- newtype ColumnType where
- ColumnType' { }
- pattern ColumnType_EDGE :: ColumnType
- pattern ColumnType_NODE :: ColumnType
- pattern ColumnType_VALUE :: ColumnType
- newtype ComponentUpdateType where
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_INTERNAL_FAILURE :: ErrorCode
- pattern ErrorCode_SYNC_CREATING_ERROR :: ErrorCode
- pattern ErrorCode_SYNC_INITIALIZING_ERROR :: ErrorCode
- pattern ErrorCode_SYNC_PROCESSING_ERROR :: ErrorCode
- pattern ErrorCode_VALIDATION_ERROR :: ErrorCode
- newtype GroupType where
- GroupType' { }
- pattern GroupType_TABULAR :: GroupType
- newtype InterpolationType where
- InterpolationType' { }
- pattern InterpolationType_LINEAR :: InterpolationType
- newtype Order where
- Order' { }
- pattern Order_ASCENDING :: Order
- pattern Order_DESCENDING :: Order
- newtype OrderByTime where
- OrderByTime' { }
- pattern OrderByTime_ASCENDING :: OrderByTime
- pattern OrderByTime_DESCENDING :: OrderByTime
- newtype ParentEntityUpdateType where
- newtype PricingMode where
- PricingMode' { }
- pattern PricingMode_BASIC :: PricingMode
- pattern PricingMode_STANDARD :: PricingMode
- pattern PricingMode_TIERED_BUNDLE :: PricingMode
- newtype PricingTier where
- PricingTier' { }
- pattern PricingTier_TIER_1 :: PricingTier
- pattern PricingTier_TIER_2 :: PricingTier
- pattern PricingTier_TIER_3 :: PricingTier
- pattern PricingTier_TIER_4 :: PricingTier
- newtype PropertyGroupUpdateType where
- newtype PropertyUpdateType where
- PropertyUpdateType' { }
- pattern PropertyUpdateType_CREATE :: PropertyUpdateType
- pattern PropertyUpdateType_DELETE :: PropertyUpdateType
- pattern PropertyUpdateType_UPDATE :: PropertyUpdateType
- newtype Scope where
- Scope' { }
- pattern Scope_ENTITY :: Scope
- pattern Scope_WORKSPACE :: Scope
- newtype State where
- State' { }
- pattern State_ACTIVE :: State
- pattern State_CREATING :: State
- pattern State_DELETING :: State
- pattern State_ERROR :: State
- pattern State_UPDATING :: State
- newtype SyncJobState where
- SyncJobState' { }
- pattern SyncJobState_ACTIVE :: SyncJobState
- pattern SyncJobState_CREATING :: SyncJobState
- pattern SyncJobState_DELETING :: SyncJobState
- pattern SyncJobState_ERROR :: SyncJobState
- pattern SyncJobState_INITIALIZING :: SyncJobState
- newtype SyncResourceState where
- SyncResourceState' { }
- pattern SyncResourceState_DELETED :: SyncResourceState
- pattern SyncResourceState_ERROR :: SyncResourceState
- pattern SyncResourceState_INITIALIZING :: SyncResourceState
- pattern SyncResourceState_IN_SYNC :: SyncResourceState
- pattern SyncResourceState_PROCESSING :: SyncResourceState
- newtype SyncResourceType where
- SyncResourceType' { }
- pattern SyncResourceType_COMPONENT_TYPE :: SyncResourceType
- pattern SyncResourceType_ENTITY :: SyncResourceType
- newtype Type where
- Type' { }
- pattern Type_BOOLEAN :: Type
- pattern Type_DOUBLE :: Type
- pattern Type_INTEGER :: Type
- pattern Type_LIST :: Type
- pattern Type_LONG :: Type
- pattern Type_MAP :: Type
- pattern Type_RELATIONSHIP :: Type
- pattern Type_STRING :: Type
- newtype UpdateReason where
- UpdateReason' { }
- pattern UpdateReason_DEFAULT :: UpdateReason
- pattern UpdateReason_ENTITY_COUNT_UPDATE :: UpdateReason
- pattern UpdateReason_OVERWRITTEN :: UpdateReason
- pattern UpdateReason_PRICING_MODE_UPDATE :: UpdateReason
- pattern UpdateReason_PRICING_TIER_UPDATE :: UpdateReason
- data BatchPutPropertyError = BatchPutPropertyError' Text Text PropertyValueEntry
- newBatchPutPropertyError :: Text -> Text -> PropertyValueEntry -> BatchPutPropertyError
- data BatchPutPropertyErrorEntry = BatchPutPropertyErrorEntry' (NonEmpty BatchPutPropertyError)
- newBatchPutPropertyErrorEntry :: NonEmpty BatchPutPropertyError -> BatchPutPropertyErrorEntry
- data BundleInformation = BundleInformation' (Maybe PricingTier) (NonEmpty Text)
- newBundleInformation :: NonEmpty Text -> BundleInformation
- data ColumnDescription = ColumnDescription' (Maybe Text) (Maybe ColumnType)
- newColumnDescription :: ColumnDescription
- data ComponentPropertyGroupRequest = ComponentPropertyGroupRequest' (Maybe GroupType) (Maybe [Text]) (Maybe PropertyGroupUpdateType)
- newComponentPropertyGroupRequest :: ComponentPropertyGroupRequest
- data ComponentPropertyGroupResponse = ComponentPropertyGroupResponse' GroupType [Text] Bool
- newComponentPropertyGroupResponse :: GroupType -> Bool -> ComponentPropertyGroupResponse
- data ComponentRequest = ComponentRequest' (Maybe Text) (Maybe Text) (Maybe (HashMap Text PropertyRequest)) (Maybe (HashMap Text ComponentPropertyGroupRequest))
- newComponentRequest :: ComponentRequest
- data ComponentResponse = ComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text PropertyResponse)) (Maybe (HashMap Text ComponentPropertyGroupResponse)) (Maybe Status) (Maybe Text)
- newComponentResponse :: ComponentResponse
- data ComponentTypeSummary = ComponentTypeSummary' (Maybe Text) (Maybe Text) (Maybe Status) Text Text POSIX POSIX
- newComponentTypeSummary :: Text -> Text -> UTCTime -> UTCTime -> ComponentTypeSummary
- data ComponentUpdateRequest = ComponentUpdateRequest' (Maybe Text) (Maybe Text) (Maybe (HashMap Text ComponentPropertyGroupRequest)) (Maybe (HashMap Text PropertyRequest)) (Maybe ComponentUpdateType)
- newComponentUpdateRequest :: ComponentUpdateRequest
- data DataConnector = DataConnector' (Maybe Bool) (Maybe LambdaFunction)
- newDataConnector :: DataConnector
- data DataType = DataType' (Maybe [DataValue]) (Maybe DataType) (Maybe Relationship) (Maybe Text) Type
- newDataType :: Type -> DataType
- data DataValue = DataValue' (Maybe Bool) (Maybe Double) (Maybe Text) (Maybe Int) (Maybe [DataValue]) (Maybe Integer) (Maybe (HashMap Text DataValue)) (Maybe RelationshipValue) (Maybe Text)
- newDataValue :: DataValue
- data EntityPropertyReference = EntityPropertyReference' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newEntityPropertyReference :: Text -> EntityPropertyReference
- data EntitySummary = EntitySummary' (Maybe Text) (Maybe Bool) (Maybe Text) Text Text Text Status POSIX POSIX
- newEntitySummary :: Text -> Text -> Text -> Status -> UTCTime -> UTCTime -> EntitySummary
- data ErrorDetails = ErrorDetails' (Maybe ErrorCode) (Maybe Text)
- newErrorDetails :: ErrorDetails
- data FunctionRequest = FunctionRequest' (Maybe DataConnector) (Maybe [Text]) (Maybe Scope)
- newFunctionRequest :: FunctionRequest
- data FunctionResponse = FunctionResponse' (Maybe DataConnector) (Maybe Bool) (Maybe [Text]) (Maybe Scope)
- newFunctionResponse :: FunctionResponse
- data InterpolationParameters = InterpolationParameters' (Maybe InterpolationType) (Maybe Integer)
- newInterpolationParameters :: InterpolationParameters
- data LambdaFunction = LambdaFunction' Text
- newLambdaFunction :: Text -> LambdaFunction
- data ListComponentTypesFilter = ListComponentTypesFilter' (Maybe Text) (Maybe Bool) (Maybe Text)
- newListComponentTypesFilter :: ListComponentTypesFilter
- data ListEntitiesFilter = ListEntitiesFilter' (Maybe Text) (Maybe Text) (Maybe Text)
- newListEntitiesFilter :: ListEntitiesFilter
- data OrderBy = OrderBy' (Maybe Order) Text
- newOrderBy :: Text -> OrderBy
- data ParentEntityUpdateRequest = ParentEntityUpdateRequest' (Maybe Text) ParentEntityUpdateType
- newParentEntityUpdateRequest :: ParentEntityUpdateType -> ParentEntityUpdateRequest
- data PricingPlan = PricingPlan' (Maybe Integer) (Maybe BundleInformation) POSIX PricingMode POSIX UpdateReason
- newPricingPlan :: UTCTime -> PricingMode -> UTCTime -> UpdateReason -> PricingPlan
- data PropertyDefinitionRequest = PropertyDefinitionRequest' (Maybe (HashMap Text Text)) (Maybe DataType) (Maybe DataValue) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newPropertyDefinitionRequest :: PropertyDefinitionRequest
- data PropertyDefinitionResponse = PropertyDefinitionResponse' (Maybe (HashMap Text Text)) (Maybe DataValue) (Maybe Text) DataType Bool Bool Bool Bool Bool Bool Bool
- newPropertyDefinitionResponse :: DataType -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> PropertyDefinitionResponse
- data PropertyFilter = PropertyFilter' (Maybe Text) (Maybe Text) (Maybe DataValue)
- newPropertyFilter :: PropertyFilter
- data PropertyGroupRequest = PropertyGroupRequest' (Maybe GroupType) (Maybe [Text])
- newPropertyGroupRequest :: PropertyGroupRequest
- data PropertyGroupResponse = PropertyGroupResponse' GroupType [Text] Bool
- newPropertyGroupResponse :: GroupType -> Bool -> PropertyGroupResponse
- data PropertyLatestValue = PropertyLatestValue' (Maybe DataValue) EntityPropertyReference
- newPropertyLatestValue :: EntityPropertyReference -> PropertyLatestValue
- data PropertyRequest = PropertyRequest' (Maybe PropertyDefinitionRequest) (Maybe PropertyUpdateType) (Maybe DataValue)
- newPropertyRequest :: PropertyRequest
- data PropertyResponse = PropertyResponse' (Maybe PropertyDefinitionResponse) (Maybe DataValue)
- newPropertyResponse :: PropertyResponse
- data PropertyValue = PropertyValue' (Maybe Text) (Maybe POSIX) DataValue
- newPropertyValue :: DataValue -> PropertyValue
- data PropertyValueEntry = PropertyValueEntry' (Maybe (NonEmpty PropertyValue)) EntityPropertyReference
- newPropertyValueEntry :: EntityPropertyReference -> PropertyValueEntry
- data PropertyValueHistory = PropertyValueHistory' (Maybe [PropertyValue]) EntityPropertyReference
- newPropertyValueHistory :: EntityPropertyReference -> PropertyValueHistory
- data QueryResultValue = QueryResultValue' {
- newQueryResultValue :: QueryResultValue
- data Relationship = Relationship' (Maybe Text) (Maybe Text)
- newRelationship :: Relationship
- data RelationshipValue = RelationshipValue' (Maybe Text) (Maybe Text)
- newRelationshipValue :: RelationshipValue
- data Row = Row' (Maybe [QueryResultValue])
- newRow :: Row
- data SceneSummary = SceneSummary' (Maybe Text) Text Text Text POSIX POSIX
- newSceneSummary :: Text -> Text -> Text -> UTCTime -> UTCTime -> SceneSummary
- data Status = Status' (Maybe ErrorDetails) (Maybe State)
- newStatus :: Status
- data SyncJobStatus = SyncJobStatus' (Maybe ErrorDetails) (Maybe SyncJobState)
- newSyncJobStatus :: SyncJobStatus
- data SyncJobSummary = SyncJobSummary' (Maybe Text) (Maybe POSIX) (Maybe SyncJobStatus) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newSyncJobSummary :: SyncJobSummary
- data SyncResourceFilter = SyncResourceFilter' (Maybe Text) (Maybe Text) (Maybe SyncResourceType) (Maybe SyncResourceState)
- newSyncResourceFilter :: SyncResourceFilter
- data SyncResourceStatus = SyncResourceStatus' (Maybe ErrorDetails) (Maybe SyncResourceState)
- newSyncResourceStatus :: SyncResourceStatus
- data SyncResourceSummary = SyncResourceSummary' (Maybe Text) (Maybe Text) (Maybe SyncResourceType) (Maybe SyncResourceStatus) (Maybe POSIX)
- newSyncResourceSummary :: SyncResourceSummary
- data TabularConditions = TabularConditions' (Maybe (NonEmpty OrderBy)) (Maybe (NonEmpty PropertyFilter))
- newTabularConditions :: TabularConditions
- data WorkspaceSummary = WorkspaceSummary' (Maybe Text) Text Text POSIX POSIX
- newWorkspaceSummary :: Text -> Text -> UTCTime -> UTCTime -> WorkspaceSummary
Service Configuration
defaultService :: Service Source #
API version 2021-11-29
of the Amazon IoT TwinMaker 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 IotTwinMaker
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access is denied.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A conflict occurred.
ConnectorFailureException
_ConnectorFailureException :: AsError a => Fold a ServiceError Source #
The connector failed.
ConnectorTimeoutException
_ConnectorTimeoutException :: AsError a => Fold a ServiceError Source #
The connector timed out.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An unexpected error has occurred.
QueryTimeoutException
_QueryTimeoutException :: AsError a => Fold a ServiceError Source #
The query timeout exception.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource wasn't found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service quota was exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The rate exceeds the limit.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The number of tags exceeds the limit.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Failed
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchPutPropertyValues
data BatchPutPropertyValues Source #
See: newBatchPutPropertyValues
smart constructor.
Constructors
BatchPutPropertyValues' Text (NonEmpty PropertyValueEntry) |
Instances
newBatchPutPropertyValues Source #
Arguments
:: Text | |
-> NonEmpty PropertyValueEntry | |
-> BatchPutPropertyValues |
Create a value of BatchPutPropertyValues
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchPutPropertyValues
, batchPutPropertyValues_workspaceId
- The ID of the workspace that contains the properties to set.
$sel:entries:BatchPutPropertyValues'
, batchPutPropertyValues_entries
- An object that maps strings to the property value entries to set. Each
string in the mapping must be unique to this object.
data BatchPutPropertyValuesResponse Source #
See: newBatchPutPropertyValuesResponse
smart constructor.
Constructors
BatchPutPropertyValuesResponse' Int (NonEmpty BatchPutPropertyErrorEntry) |
Instances
newBatchPutPropertyValuesResponse Source #
Arguments
:: Int | |
-> NonEmpty BatchPutPropertyErrorEntry | |
-> BatchPutPropertyValuesResponse |
Create a value of BatchPutPropertyValuesResponse
with all optional fields omitted.
Use 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:BatchPutPropertyValuesResponse'
, batchPutPropertyValuesResponse_httpStatus
- The response's http status code.
$sel:errorEntries:BatchPutPropertyValuesResponse'
, batchPutPropertyValuesResponse_errorEntries
- Entries that caused errors in the batch put operation.
CreateComponentType
data CreateComponentType Source #
See: newCreateComponentType
smart constructor.
Constructors
CreateComponentType' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionRequest)) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionRequest)) (Maybe (HashMap Text PropertyGroupRequest)) (Maybe (HashMap Text Text)) Text Text |
Instances
newCreateComponentType Source #
Arguments
:: Text | |
-> Text | |
-> CreateComponentType |
Create a value of CreateComponentType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateComponentType
, createComponentType_componentTypeName
- A friendly name for the component type.
CreateComponentType
, createComponentType_description
- The description of the component type.
CreateComponentType
, createComponentType_extendsFrom
- Specifies the parent component type to extend.
$sel:functions:CreateComponentType'
, createComponentType_functions
- An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
$sel:isSingleton:CreateComponentType'
, createComponentType_isSingleton
- A Boolean value that specifies whether an entity can have more than one
component of this type.
$sel:propertyDefinitions:CreateComponentType'
, createComponentType_propertyDefinitions
- An object that maps strings to the property definitions in the component
type. Each string in the mapping must be unique to this object.
CreateComponentType
, createComponentType_propertyGroups
-
$sel:tags:CreateComponentType'
, createComponentType_tags
- Metadata that you can use to manage the component type.
CreateComponentType
, createComponentType_workspaceId
- The ID of the workspace that contains the component type.
CreateComponentType
, createComponentType_componentTypeId
- The ID of the component type.
data CreateComponentTypeResponse Source #
See: newCreateComponentTypeResponse
smart constructor.
Constructors
CreateComponentTypeResponse' Int Text POSIX State |
Instances
newCreateComponentTypeResponse Source #
Arguments
:: Int | |
-> Text | |
-> UTCTime | |
-> State | |
-> CreateComponentTypeResponse |
Create a value of CreateComponentTypeResponse
with all optional fields omitted.
Use 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:CreateComponentTypeResponse'
, createComponentTypeResponse_httpStatus
- The response's http status code.
CreateComponentTypeResponse
, createComponentTypeResponse_arn
- The ARN of the component type.
CreateComponentTypeResponse
, createComponentTypeResponse_creationDateTime
- The date and time when the entity was created.
CreateComponentTypeResponse
, createComponentTypeResponse_state
- The current state of the component type.
CreateEntity
data CreateEntity Source #
See: newCreateEntity
smart constructor.
Constructors
CreateEntity' (Maybe (HashMap Text ComponentRequest)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateEntity |
Create a value of CreateEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:components:CreateEntity'
, createEntity_components
- An object that maps strings to the components in the entity. Each string
in the mapping must be unique to this object.
CreateEntity
, createEntity_description
- The description of the entity.
CreateEntity
, createEntity_entityId
- The ID of the entity.
CreateEntity
, createEntity_parentEntityId
- The ID of the entity's parent entity.
$sel:tags:CreateEntity'
, createEntity_tags
- Metadata that you can use to manage the entity.
CreateEntity
, createEntity_workspaceId
- The ID of the workspace that contains the entity.
CreateEntity
, createEntity_entityName
- The name of the entity.
data CreateEntityResponse Source #
See: newCreateEntityResponse
smart constructor.
Instances
newCreateEntityResponse Source #
Create a value of CreateEntityResponse
with all optional fields omitted.
Use 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:CreateEntityResponse'
, createEntityResponse_httpStatus
- The response's http status code.
CreateEntity
, createEntityResponse_entityId
- The ID of the entity.
CreateEntityResponse
, createEntityResponse_arn
- The ARN of the entity.
CreateEntityResponse
, createEntityResponse_creationDateTime
- The date and time when the entity was created.
CreateEntityResponse
, createEntityResponse_state
- The current state of the entity.
CreateScene
data CreateScene Source #
See: newCreateScene
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateScene |
Create a value of CreateScene
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:CreateScene'
, createScene_capabilities
- A list of capabilities that the scene uses to render itself.
CreateScene
, createScene_description
- The description for this scene.
$sel:tags:CreateScene'
, createScene_tags
- Metadata that you can use to manage the scene.
CreateScene
, createScene_workspaceId
- The ID of the workspace that contains the scene.
CreateScene
, createScene_sceneId
- The ID of the scene.
CreateScene
, createScene_contentLocation
- The relative path that specifies the location of the content definition
file.
data CreateSceneResponse Source #
See: newCreateSceneResponse
smart constructor.
Constructors
CreateSceneResponse' Int Text POSIX |
Instances
newCreateSceneResponse Source #
Arguments
:: Int | |
-> Text | |
-> UTCTime | |
-> CreateSceneResponse |
Create a value of CreateSceneResponse
with all optional fields omitted.
Use 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:CreateSceneResponse'
, createSceneResponse_httpStatus
- The response's http status code.
CreateSceneResponse
, createSceneResponse_arn
- The ARN of the scene.
CreateSceneResponse
, createSceneResponse_creationDateTime
- The date and time when the scene was created.
CreateSyncJob
data CreateSyncJob Source #
See: newCreateSyncJob
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateSyncJob |
Create a value of CreateSyncJob
with all optional fields omitted.
Use 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:CreateSyncJob'
, createSyncJob_tags
- The SyncJob tags.
CreateSyncJob
, createSyncJob_workspaceId
- The workspace Id.
CreateSyncJob
, createSyncJob_syncSource
- The sync source.
Currently the only supported syncSoucre is SITEWISE
.
$sel:syncRole:CreateSyncJob'
, createSyncJob_syncRole
- The SyncJob IAM role. This IAM role is used by the sync job to read from
the syncSource, and create, update or delete the corresponding
resources.
data CreateSyncJobResponse Source #
See: newCreateSyncJobResponse
smart constructor.
Constructors
CreateSyncJobResponse' Int Text POSIX SyncJobState |
Instances
newCreateSyncJobResponse Source #
Arguments
:: Int | |
-> Text | |
-> UTCTime | |
-> SyncJobState | |
-> CreateSyncJobResponse |
Create a value of CreateSyncJobResponse
with all optional fields omitted.
Use 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:CreateSyncJobResponse'
, createSyncJobResponse_httpStatus
- The response's http status code.
CreateSyncJobResponse
, createSyncJobResponse_arn
- The SyncJob ARN.
CreateSyncJobResponse
, createSyncJobResponse_creationDateTime
- The date and time for the SyncJob creation.
CreateSyncJobResponse
, createSyncJobResponse_state
- The SyncJob response state.
CreateWorkspace
data CreateWorkspace Source #
See: newCreateWorkspace
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateWorkspace |
Create a value of CreateWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorkspace
, createWorkspace_description
- The description of the workspace.
$sel:tags:CreateWorkspace'
, createWorkspace_tags
- Metadata that you can use to manage the workspace
CreateWorkspace
, createWorkspace_workspaceId
- The ID of the workspace.
$sel:s3Location:CreateWorkspace'
, createWorkspace_s3Location
- The ARN of the S3 bucket where resources associated with the workspace
are stored.
$sel:role':CreateWorkspace'
, createWorkspace_role
- The ARN of the execution role associated with the workspace.
data CreateWorkspaceResponse Source #
See: newCreateWorkspaceResponse
smart constructor.
Constructors
CreateWorkspaceResponse' Int Text POSIX |
Instances
newCreateWorkspaceResponse Source #
Arguments
:: Int | |
-> Text | |
-> UTCTime | |
-> CreateWorkspaceResponse |
Create a value of CreateWorkspaceResponse
with all optional fields omitted.
Use 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:CreateWorkspaceResponse'
, createWorkspaceResponse_httpStatus
- The response's http status code.
CreateWorkspaceResponse
, createWorkspaceResponse_arn
- The ARN of the workspace.
CreateWorkspaceResponse
, createWorkspaceResponse_creationDateTime
- The date and time when the workspace was created.
DeleteComponentType
data DeleteComponentType Source #
See: newDeleteComponentType
smart constructor.
Constructors
DeleteComponentType' Text Text |
Instances
newDeleteComponentType Source #
Arguments
:: Text | |
-> Text | |
-> DeleteComponentType |
Create a value of DeleteComponentType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteComponentType
, deleteComponentType_workspaceId
- The ID of the workspace that contains the component type.
DeleteComponentType
, deleteComponentType_componentTypeId
- The ID of the component type to delete.
data DeleteComponentTypeResponse Source #
See: newDeleteComponentTypeResponse
smart constructor.
Constructors
DeleteComponentTypeResponse' Int State |
Instances
newDeleteComponentTypeResponse Source #
Arguments
:: Int | |
-> State | |
-> DeleteComponentTypeResponse |
Create a value of DeleteComponentTypeResponse
with all optional fields omitted.
Use 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:DeleteComponentTypeResponse'
, deleteComponentTypeResponse_httpStatus
- The response's http status code.
DeleteComponentTypeResponse
, deleteComponentTypeResponse_state
- The current state of the component type to be deleted.
DeleteEntity
data DeleteEntity Source #
See: newDeleteEntity
smart constructor.
Constructors
DeleteEntity' (Maybe Bool) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteEntity |
Create a value of DeleteEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isRecursive:DeleteEntity'
, deleteEntity_isRecursive
- A Boolean value that specifies whether the operation deletes child
entities.
DeleteEntity
, deleteEntity_workspaceId
- The ID of the workspace that contains the entity to delete.
DeleteEntity
, deleteEntity_entityId
- The ID of the entity to delete.
data DeleteEntityResponse Source #
See: newDeleteEntityResponse
smart constructor.
Constructors
DeleteEntityResponse' Int State |
Instances
newDeleteEntityResponse Source #
Arguments
:: Int | |
-> State | |
-> DeleteEntityResponse |
Create a value of DeleteEntityResponse
with all optional fields omitted.
Use 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:DeleteEntityResponse'
, deleteEntityResponse_httpStatus
- The response's http status code.
DeleteEntityResponse
, deleteEntityResponse_state
- The current state of the deleted entity.
DeleteScene
data DeleteScene Source #
See: newDeleteScene
smart constructor.
Constructors
DeleteScene' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteScene |
Create a value of DeleteScene
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteScene
, deleteScene_workspaceId
- The ID of the workspace.
DeleteScene
, deleteScene_sceneId
- The ID of the scene to delete.
data DeleteSceneResponse Source #
See: newDeleteSceneResponse
smart constructor.
Constructors
DeleteSceneResponse' Int |
Instances
newDeleteSceneResponse Source #
Arguments
:: Int | |
-> DeleteSceneResponse |
Create a value of DeleteSceneResponse
with all optional fields omitted.
Use 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:DeleteSceneResponse'
, deleteSceneResponse_httpStatus
- The response's http status code.
DeleteSyncJob
data DeleteSyncJob Source #
See: newDeleteSyncJob
smart constructor.
Constructors
DeleteSyncJob' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteSyncJob |
Create a value of DeleteSyncJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSyncJob
, deleteSyncJob_workspaceId
- The workspace Id.
DeleteSyncJob
, deleteSyncJob_syncSource
- The sync source.
Currently the only supported syncSoucre is SITEWISE
.
data DeleteSyncJobResponse Source #
See: newDeleteSyncJobResponse
smart constructor.
Constructors
DeleteSyncJobResponse' Int SyncJobState |
Instances
newDeleteSyncJobResponse Source #
Arguments
:: Int | |
-> SyncJobState | |
-> DeleteSyncJobResponse |
Create a value of DeleteSyncJobResponse
with all optional fields omitted.
Use 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:DeleteSyncJobResponse'
, deleteSyncJobResponse_httpStatus
- The response's http status code.
DeleteSyncJobResponse
, deleteSyncJobResponse_state
- The SyncJob response state.
DeleteWorkspace
data DeleteWorkspace Source #
See: newDeleteWorkspace
smart constructor.
Constructors
DeleteWorkspace' Text |
Instances
Arguments
:: Text | |
-> DeleteWorkspace |
Create a value of DeleteWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorkspace
, deleteWorkspace_workspaceId
- The ID of the workspace to delete.
data DeleteWorkspaceResponse Source #
See: newDeleteWorkspaceResponse
smart constructor.
Constructors
DeleteWorkspaceResponse' Int |
Instances
newDeleteWorkspaceResponse Source #
Create a value of DeleteWorkspaceResponse
with all optional fields omitted.
Use 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:DeleteWorkspaceResponse'
, deleteWorkspaceResponse_httpStatus
- The response's http status code.
ExecuteQuery
data ExecuteQuery Source #
See: newExecuteQuery
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> ExecuteQuery |
Create a value of ExecuteQuery
with all optional fields omitted.
Use 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:ExecuteQuery'
, executeQuery_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ExecuteQuery
, executeQuery_nextToken
- The string that specifies the next page of results.
ExecuteQuery
, executeQuery_workspaceId
- The ID of the workspace.
$sel:queryStatement:ExecuteQuery'
, executeQuery_queryStatement
- The query statement.
data ExecuteQueryResponse Source #
See: newExecuteQueryResponse
smart constructor.
Constructors
ExecuteQueryResponse' (Maybe [ColumnDescription]) (Maybe Text) (Maybe [Row]) Int |
Instances
newExecuteQueryResponse Source #
Arguments
:: Int | |
-> ExecuteQueryResponse |
Create a value of ExecuteQueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnDescriptions:ExecuteQueryResponse'
, executeQueryResponse_columnDescriptions
- A list of ColumnDescription objects.
ExecuteQuery
, executeQueryResponse_nextToken
- The string that specifies the next page of results.
$sel:rows:ExecuteQueryResponse'
, executeQueryResponse_rows
- Represents a single row in the query results.
$sel:httpStatus:ExecuteQueryResponse'
, executeQueryResponse_httpStatus
- The response's http status code.
GetComponentType
data GetComponentType Source #
See: newGetComponentType
smart constructor.
Constructors
GetComponentType' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> GetComponentType |
Create a value of GetComponentType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetComponentType
, getComponentType_workspaceId
- The ID of the workspace that contains the component type.
GetComponentType
, getComponentType_componentTypeId
- The ID of the component type.
data GetComponentTypeResponse Source #
See: newGetComponentTypeResponse
smart constructor.
Constructors
GetComponentTypeResponse' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionResponse)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionResponse)) (Maybe (HashMap Text PropertyGroupResponse)) (Maybe Status) (Maybe Text) Int Text Text POSIX POSIX Text |
Instances
newGetComponentTypeResponse Source #
Create a value of GetComponentTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetComponentTypeResponse
, getComponentTypeResponse_componentTypeName
- The component type name.
GetComponentTypeResponse
, getComponentTypeResponse_description
- The description of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_extendsFrom
- The name of the parent component type that this component type extends.
$sel:functions:GetComponentTypeResponse'
, getComponentTypeResponse_functions
- An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
GetComponentTypeResponse
, getComponentTypeResponse_isAbstract
- A Boolean value that specifies whether the component type is abstract.
$sel:isSchemaInitialized:GetComponentTypeResponse'
, getComponentTypeResponse_isSchemaInitialized
- A Boolean value that specifies whether the component type has a schema
initializer and that the schema initializer has run.
$sel:isSingleton:GetComponentTypeResponse'
, getComponentTypeResponse_isSingleton
- A Boolean value that specifies whether an entity can have more than one
component of this type.
$sel:propertyDefinitions:GetComponentTypeResponse'
, getComponentTypeResponse_propertyDefinitions
- An object that maps strings to the property definitions in the component
type. Each string in the mapping must be unique to this object.
GetComponentTypeResponse
, getComponentTypeResponse_propertyGroups
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
GetComponentTypeResponse
, getComponentTypeResponse_status
- The current status of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_syncSource
- The syncSource of the sync job, if this entity was created by a sync
job.
$sel:httpStatus:GetComponentTypeResponse'
, getComponentTypeResponse_httpStatus
- The response's http status code.
GetComponentType
, getComponentTypeResponse_workspaceId
- The ID of the workspace that contains the component type.
GetComponentType
, getComponentTypeResponse_componentTypeId
- The ID of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_creationDateTime
- The date and time when the component type was created.
GetComponentTypeResponse
, getComponentTypeResponse_updateDateTime
- The date and time when the component was last updated.
GetComponentTypeResponse
, getComponentTypeResponse_arn
- The ARN of the component type.
GetEntity
See: newGetEntity
smart constructor.
Constructors
GetEntity' Text Text |
Instances
Create a value of GetEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEntity
, getEntity_workspaceId
- The ID of the workspace.
GetEntity
, getEntity_entityId
- The ID of the entity.
data GetEntityResponse Source #
See: newGetEntityResponse
smart constructor.
Constructors
GetEntityResponse' (Maybe (HashMap Text ComponentResponse)) (Maybe Text) (Maybe Text) Int Text Text Text Status Text Text Bool POSIX POSIX |
Instances
Arguments
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Status | |
-> Text | |
-> Text | |
-> Bool | |
-> UTCTime | |
-> UTCTime | |
-> GetEntityResponse |
Create a value of GetEntityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:components:GetEntityResponse'
, getEntityResponse_components
- An object that maps strings to the components in the entity. Each string
in the mapping must be unique to this object.
GetEntityResponse
, getEntityResponse_description
- The description of the entity.
GetEntityResponse
, getEntityResponse_syncSource
- The syncSource of the sync job, if this entity was created by a sync
job.
$sel:httpStatus:GetEntityResponse'
, getEntityResponse_httpStatus
- The response's http status code.
GetEntity
, getEntityResponse_entityId
- The ID of the entity.
GetEntityResponse
, getEntityResponse_entityName
- The name of the entity.
GetEntityResponse
, getEntityResponse_arn
- The ARN of the entity.
GetEntityResponse
, getEntityResponse_status
- The current status of the entity.
GetEntity
, getEntityResponse_workspaceId
- The ID of the workspace.
GetEntityResponse
, getEntityResponse_parentEntityId
- The ID of the parent entity for this entity.
GetEntityResponse
, getEntityResponse_hasChildEntities
- A Boolean value that specifies whether the entity has associated child
entities.
GetEntityResponse
, getEntityResponse_creationDateTime
- The date and time when the entity was created.
GetEntityResponse
, getEntityResponse_updateDateTime
- The date and time when the entity was last updated.
GetPricingPlan
data GetPricingPlan Source #
See: newGetPricingPlan
smart constructor.
Constructors
GetPricingPlan' | |
Instances
newGetPricingPlan :: GetPricingPlan Source #
Create a value of GetPricingPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetPricingPlanResponse Source #
See: newGetPricingPlanResponse
smart constructor.
Constructors
GetPricingPlanResponse' (Maybe PricingPlan) Int PricingPlan |
Instances
newGetPricingPlanResponse Source #
Arguments
:: Int | |
-> PricingPlan | |
-> GetPricingPlanResponse |
Create a value of GetPricingPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingPricingPlan:GetPricingPlanResponse'
, getPricingPlanResponse_pendingPricingPlan
- The pending pricing plan.
$sel:httpStatus:GetPricingPlanResponse'
, getPricingPlanResponse_httpStatus
- The response's http status code.
$sel:currentPricingPlan:GetPricingPlanResponse'
, getPricingPlanResponse_currentPricingPlan
- The chosen pricing plan for the current billing cycle.
GetPropertyValue
data GetPropertyValue Source #
See: newGetPropertyValue
smart constructor.
Constructors
GetPropertyValue' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe TabularConditions) (NonEmpty Text) Text |
Instances
Arguments
:: NonEmpty Text | |
-> Text | |
-> GetPropertyValue |
Create a value of GetPropertyValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPropertyValue
, getPropertyValue_componentName
- The name of the component whose property values the operation returns.
GetPropertyValue
, getPropertyValue_componentTypeId
- The ID of the component type whose property values the operation
returns.
GetPropertyValue
, getPropertyValue_entityId
- The ID of the entity whose property values the operation returns.
$sel:maxResults:GetPropertyValue'
, getPropertyValue_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
GetPropertyValue
, getPropertyValue_nextToken
- The string that specifies the next page of results.
$sel:propertyGroupName:GetPropertyValue'
, getPropertyValue_propertyGroupName
- The property group name.
$sel:tabularConditions:GetPropertyValue'
, getPropertyValue_tabularConditions
- The tabular conditions.
$sel:selectedProperties:GetPropertyValue'
, getPropertyValue_selectedProperties
- The properties whose values the operation returns.
GetPropertyValue
, getPropertyValue_workspaceId
- The ID of the workspace whose values the operation returns.
data GetPropertyValueResponse Source #
See: newGetPropertyValueResponse
smart constructor.
Constructors
GetPropertyValueResponse' (Maybe Text) (Maybe (HashMap Text PropertyLatestValue)) (Maybe [[HashMap Text DataValue]]) Int |
Instances
newGetPropertyValueResponse Source #
Create a value of GetPropertyValueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPropertyValue
, getPropertyValueResponse_nextToken
- The string that specifies the next page of results.
GetPropertyValueResponse
, getPropertyValueResponse_propertyValues
- An object that maps strings to the properties and latest property values
in the response. Each string in the mapping must be unique to this
object.
$sel:tabularPropertyValues:GetPropertyValueResponse'
, getPropertyValueResponse_tabularPropertyValues
- A table of property values.
$sel:httpStatus:GetPropertyValueResponse'
, getPropertyValueResponse_httpStatus
- The response's http status code.
GetPropertyValueHistory
data GetPropertyValueHistory Source #
See: newGetPropertyValueHistory
smart constructor.
Constructors
GetPropertyValueHistory' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe InterpolationParameters) (Maybe Natural) (Maybe Text) (Maybe OrderByTime) (Maybe (NonEmpty PropertyFilter)) (Maybe POSIX) (Maybe Text) Text (NonEmpty Text) |
Instances
newGetPropertyValueHistory Source #
Arguments
:: Text | |
-> NonEmpty Text | |
-> GetPropertyValueHistory |
Create a value of GetPropertyValueHistory
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPropertyValueHistory
, getPropertyValueHistory_componentName
- The name of the component.
GetPropertyValueHistory
, getPropertyValueHistory_componentTypeId
- The ID of the component type.
$sel:endDateTime:GetPropertyValueHistory'
, getPropertyValueHistory_endDateTime
- The date and time of the latest property value to return.
$sel:endTime:GetPropertyValueHistory'
, getPropertyValueHistory_endTime
- The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
GetPropertyValueHistory
, getPropertyValueHistory_entityId
- The ID of the entity.
$sel:interpolation:GetPropertyValueHistory'
, getPropertyValueHistory_interpolation
- An object that specifies the interpolation type and the interval over
which to interpolate data.
$sel:maxResults:GetPropertyValueHistory'
, getPropertyValueHistory_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
GetPropertyValueHistory
, getPropertyValueHistory_nextToken
- The string that specifies the next page of results.
$sel:orderByTime:GetPropertyValueHistory'
, getPropertyValueHistory_orderByTime
- The time direction to use in the result order.
GetPropertyValueHistory
, getPropertyValueHistory_propertyFilters
- A list of objects that filter the property value history request.
$sel:startDateTime:GetPropertyValueHistory'
, getPropertyValueHistory_startDateTime
- The date and time of the earliest property value to return.
$sel:startTime:GetPropertyValueHistory'
, getPropertyValueHistory_startTime
- The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
GetPropertyValueHistory
, getPropertyValueHistory_workspaceId
- The ID of the workspace.
$sel:selectedProperties:GetPropertyValueHistory'
, getPropertyValueHistory_selectedProperties
- A list of properties whose value histories the request retrieves.
data GetPropertyValueHistoryResponse Source #
See: newGetPropertyValueHistoryResponse
smart constructor.
Constructors
GetPropertyValueHistoryResponse' (Maybe Text) Int [PropertyValueHistory] |
Instances
newGetPropertyValueHistoryResponse Source #
Create a value of GetPropertyValueHistoryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPropertyValueHistory
, getPropertyValueHistoryResponse_nextToken
- The string that specifies the next page of results.
$sel:httpStatus:GetPropertyValueHistoryResponse'
, getPropertyValueHistoryResponse_httpStatus
- The response's http status code.
GetPropertyValueHistoryResponse
, getPropertyValueHistoryResponse_propertyValues
- An object that maps strings to the property definitions in the component
type. Each string in the mapping must be unique to this object.
GetScene
See: newGetScene
smart constructor.
Instances
Create a value of GetScene
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetScene
, getScene_workspaceId
- The ID of the workspace that contains the scene.
GetScene
, getScene_sceneId
- The ID of the scene.
data GetSceneResponse Source #
See: newGetSceneResponse
smart constructor.
Instances
Create a value of GetSceneResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:GetSceneResponse'
, getSceneResponse_capabilities
- A list of capabilities that the scene uses to render.
GetSceneResponse
, getSceneResponse_description
- The description of the scene.
$sel:httpStatus:GetSceneResponse'
, getSceneResponse_httpStatus
- The response's http status code.
GetScene
, getSceneResponse_workspaceId
- The ID of the workspace that contains the scene.
GetScene
, getSceneResponse_sceneId
- The ID of the scene.
GetSceneResponse
, getSceneResponse_contentLocation
- The relative path that specifies the location of the content definition
file.
GetSceneResponse
, getSceneResponse_arn
- The ARN of the scene.
GetSceneResponse
, getSceneResponse_creationDateTime
- The date and time when the scene was created.
GetSceneResponse
, getSceneResponse_updateDateTime
- The date and time when the scene was last updated.
GetSyncJob
data GetSyncJob Source #
See: newGetSyncJob
smart constructor.
Constructors
GetSyncJob' (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> GetSyncJob |
Create a value of GetSyncJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSyncJob
, getSyncJob_workspaceId
- The workspace Id.
GetSyncJob
, getSyncJob_syncSource
- The sync soucre.
Currently the only supported syncSoucre is SITEWISE
.
data GetSyncJobResponse Source #
See: newGetSyncJobResponse
smart constructor.
Constructors
GetSyncJobResponse' Int Text Text Text Text SyncJobStatus POSIX POSIX |
Instances
newGetSyncJobResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> SyncJobStatus | |
-> UTCTime | |
-> UTCTime | |
-> GetSyncJobResponse |
Create a value of GetSyncJobResponse
with all optional fields omitted.
Use 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:GetSyncJobResponse'
, getSyncJobResponse_httpStatus
- The response's http status code.
GetSyncJobResponse
, getSyncJobResponse_arn
- The sync job ARN.
GetSyncJob
, getSyncJobResponse_workspaceId
- The ID of the workspace that contains the sync job.
GetSyncJob
, getSyncJobResponse_syncSource
- The sync soucre.
Currently the only supported syncSoucre is SITEWISE
.
$sel:syncRole:GetSyncJobResponse'
, getSyncJobResponse_syncRole
- The sync IAM role.
GetSyncJobResponse
, getSyncJobResponse_status
- The SyncJob response status.
GetSyncJobResponse
, getSyncJobResponse_creationDateTime
- The creation date and time.
GetSyncJobResponse
, getSyncJobResponse_updateDateTime
- The update date and time.
GetWorkspace
data GetWorkspace Source #
See: newGetWorkspace
smart constructor.
Constructors
GetWorkspace' Text |
Instances
Arguments
:: Text | |
-> GetWorkspace |
Create a value of GetWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkspace
, getWorkspace_workspaceId
- The ID of the workspace.
data GetWorkspaceResponse Source #
See: newGetWorkspaceResponse
smart constructor.
Instances
newGetWorkspaceResponse Source #
Create a value of GetWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkspaceResponse
, getWorkspaceResponse_description
- The description of the workspace.
$sel:httpStatus:GetWorkspaceResponse'
, getWorkspaceResponse_httpStatus
- The response's http status code.
GetWorkspace
, getWorkspaceResponse_workspaceId
- The ID of the workspace.
GetWorkspaceResponse
, getWorkspaceResponse_arn
- The ARN of the workspace.
$sel:s3Location:GetWorkspaceResponse'
, getWorkspaceResponse_s3Location
- The ARN of the S3 bucket where resources associated with the workspace
are stored.
$sel:role':GetWorkspaceResponse'
, getWorkspaceResponse_role
- The ARN of the execution role associated with the workspace.
GetWorkspaceResponse
, getWorkspaceResponse_creationDateTime
- The date and time when the workspace was created.
GetWorkspaceResponse
, getWorkspaceResponse_updateDateTime
- The date and time when the workspace was last updated.
ListComponentTypes
data ListComponentTypes Source #
See: newListComponentTypes
smart constructor.
Constructors
ListComponentTypes' (Maybe [ListComponentTypesFilter]) (Maybe Natural) (Maybe Text) Text |
Instances
newListComponentTypes Source #
Arguments
:: Text | |
-> ListComponentTypes |
Create a value of ListComponentTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListComponentTypes'
, listComponentTypes_filters
- A list of objects that filter the request.
ListComponentTypes
, listComponentTypes_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ListComponentTypes
, listComponentTypes_nextToken
- The string that specifies the next page of results.
ListComponentTypes
, listComponentTypes_workspaceId
- The ID of the workspace.
data ListComponentTypesResponse Source #
See: newListComponentTypesResponse
smart constructor.
Constructors
ListComponentTypesResponse' (Maybe Natural) (Maybe Text) Int Text [ComponentTypeSummary] |
Instances
newListComponentTypesResponse Source #
Arguments
:: Int | |
-> Text | |
-> ListComponentTypesResponse |
Create a value of ListComponentTypesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListComponentTypes
, listComponentTypesResponse_maxResults
- Specifies the maximum number of results to display.
ListComponentTypes
, listComponentTypesResponse_nextToken
- The string that specifies the next page of results.
$sel:httpStatus:ListComponentTypesResponse'
, listComponentTypesResponse_httpStatus
- The response's http status code.
ListComponentTypes
, listComponentTypesResponse_workspaceId
- The ID of the workspace.
$sel:componentTypeSummaries:ListComponentTypesResponse'
, listComponentTypesResponse_componentTypeSummaries
- A list of objects that contain information about the component types.
ListEntities
data ListEntities Source #
See: newListEntities
smart constructor.
Constructors
ListEntities' (Maybe [ListEntitiesFilter]) (Maybe Natural) (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> ListEntities |
Create a value of ListEntities
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListEntities'
, listEntities_filters
- A list of objects that filter the request.
Only one object is accepted as a valid input.
$sel:maxResults:ListEntities'
, listEntities_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ListEntities
, listEntities_nextToken
- The string that specifies the next page of results.
ListEntities
, listEntities_workspaceId
- The ID of the workspace.
data ListEntitiesResponse Source #
See: newListEntitiesResponse
smart constructor.
Constructors
ListEntitiesResponse' (Maybe [EntitySummary]) (Maybe Text) Int |
Instances
newListEntitiesResponse Source #
Arguments
:: Int | |
-> ListEntitiesResponse |
Create a value of ListEntitiesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitySummaries:ListEntitiesResponse'
, listEntitiesResponse_entitySummaries
- A list of objects that contain information about the entities.
ListEntities
, listEntitiesResponse_nextToken
- The string that specifies the next page of results.
$sel:httpStatus:ListEntitiesResponse'
, listEntitiesResponse_httpStatus
- The response's http status code.
ListScenes
data ListScenes Source #
See: newListScenes
smart constructor.
Instances
Arguments
:: Text | |
-> ListScenes |
Create a value of ListScenes
with all optional fields omitted.
Use 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:ListScenes'
, listScenes_maxResults
- Specifies the maximum number of results to display.
ListScenes
, listScenes_nextToken
- The string that specifies the next page of results.
ListScenes
, listScenes_workspaceId
- The ID of the workspace that contains the scenes.
data ListScenesResponse Source #
See: newListScenesResponse
smart constructor.
Constructors
ListScenesResponse' (Maybe Text) (Maybe [SceneSummary]) Int |
Instances
newListScenesResponse Source #
Arguments
:: Int | |
-> ListScenesResponse |
Create a value of ListScenesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListScenes
, listScenesResponse_nextToken
- The string that specifies the next page of results.
$sel:sceneSummaries:ListScenesResponse'
, listScenesResponse_sceneSummaries
- A list of objects that contain information about the scenes.
$sel:httpStatus:ListScenesResponse'
, listScenesResponse_httpStatus
- The response's http status code.
ListSyncJobs
data ListSyncJobs Source #
See: newListSyncJobs
smart constructor.
Instances
Arguments
:: Text | |
-> ListSyncJobs |
Create a value of ListSyncJobs
with all optional fields omitted.
Use 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:ListSyncJobs'
, listSyncJobs_maxResults
- The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
ListSyncJobs
, listSyncJobs_nextToken
- The string that specifies the next page of results.
ListSyncJobs
, listSyncJobs_workspaceId
- The ID of the workspace that contains the sync job.
data ListSyncJobsResponse Source #
See: newListSyncJobsResponse
smart constructor.
Constructors
ListSyncJobsResponse' (Maybe Text) (Maybe [SyncJobSummary]) Int |
Instances
newListSyncJobsResponse Source #
Arguments
:: Int | |
-> ListSyncJobsResponse |
Create a value of ListSyncJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSyncJobs
, listSyncJobsResponse_nextToken
- The string that specifies the next page of results.
$sel:syncJobSummaries:ListSyncJobsResponse'
, listSyncJobsResponse_syncJobSummaries
- The listed SyncJob summaries.
$sel:httpStatus:ListSyncJobsResponse'
, listSyncJobsResponse_httpStatus
- The response's http status code.
ListSyncResources
data ListSyncResources Source #
See: newListSyncResources
smart constructor.
Constructors
ListSyncResources' (Maybe [SyncResourceFilter]) (Maybe Natural) (Maybe Text) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> ListSyncResources |
Create a value of ListSyncResources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSyncResources'
, listSyncResources_filters
- A list of objects that filter the request.
$sel:maxResults:ListSyncResources'
, listSyncResources_maxResults
- The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
ListSyncResources
, listSyncResources_nextToken
- The string that specifies the next page of results.
ListSyncResources
, listSyncResources_workspaceId
- The ID of the workspace that contains the sync job.
ListSyncResources
, listSyncResources_syncSource
- The sync soucre.
Currently the only supported syncSoucre is SITEWISE
.
data ListSyncResourcesResponse Source #
See: newListSyncResourcesResponse
smart constructor.
Constructors
ListSyncResourcesResponse' (Maybe Text) (Maybe [SyncResourceSummary]) Int |
Instances
newListSyncResourcesResponse Source #
Create a value of ListSyncResourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSyncResources
, listSyncResourcesResponse_nextToken
- The string that specifies the next page of results.
$sel:syncResources:ListSyncResourcesResponse'
, listSyncResourcesResponse_syncResources
- The sync resources.
$sel:httpStatus:ListSyncResourcesResponse'
, listSyncResourcesResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
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:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ListTagsForResource
, listTagsForResource_nextToken
- The string that specifies the next page of results.
$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:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- The string that specifies the next page of results.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- Metadata that you can use to manage a resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWorkspaces
data ListWorkspaces Source #
See: newListWorkspaces
smart constructor.
Constructors
ListWorkspaces' (Maybe Natural) (Maybe Text) |
Instances
newListWorkspaces :: ListWorkspaces Source #
Create a value of ListWorkspaces
with all optional fields omitted.
Use 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:ListWorkspaces'
, listWorkspaces_maxResults
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
ListWorkspaces
, listWorkspaces_nextToken
- The string that specifies the next page of results.
data ListWorkspacesResponse Source #
See: newListWorkspacesResponse
smart constructor.
Constructors
ListWorkspacesResponse' (Maybe Text) (Maybe [WorkspaceSummary]) Int |
Instances
newListWorkspacesResponse Source #
Create a value of ListWorkspacesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkspaces
, listWorkspacesResponse_nextToken
- The string that specifies the next page of results.
$sel:workspaceSummaries:ListWorkspacesResponse'
, listWorkspacesResponse_workspaceSummaries
- A list of objects that contain information about the workspaces.
$sel:httpStatus:ListWorkspacesResponse'
, listWorkspacesResponse_httpStatus
- The response's http status code.
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.
$sel:tags:TagResource'
, tagResource_tags
- Metadata to add to this resource.
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.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of tag key names to remove from the resource. You don't specify
the value. Both the key and its associated value are removed.
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.
UpdateComponentType
data UpdateComponentType Source #
See: newUpdateComponentType
smart constructor.
Constructors
UpdateComponentType' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text FunctionRequest)) (Maybe Bool) (Maybe (HashMap Text PropertyDefinitionRequest)) (Maybe (HashMap Text PropertyGroupRequest)) Text Text |
Instances
newUpdateComponentType Source #
Arguments
:: Text | |
-> Text | |
-> UpdateComponentType |
Create a value of UpdateComponentType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateComponentType
, updateComponentType_componentTypeName
- The component type name.
UpdateComponentType
, updateComponentType_description
- The description of the component type.
UpdateComponentType
, updateComponentType_extendsFrom
- Specifies the component type that this component type extends.
$sel:functions:UpdateComponentType'
, updateComponentType_functions
- An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
$sel:isSingleton:UpdateComponentType'
, updateComponentType_isSingleton
- A Boolean value that specifies whether an entity can have more than one
component of this type.
$sel:propertyDefinitions:UpdateComponentType'
, updateComponentType_propertyDefinitions
- An object that maps strings to the property definitions in the component
type. Each string in the mapping must be unique to this object.
UpdateComponentType
, updateComponentType_propertyGroups
- The property groups
UpdateComponentType
, updateComponentType_workspaceId
- The ID of the workspace.
UpdateComponentType
, updateComponentType_componentTypeId
- The ID of the component type.
data UpdateComponentTypeResponse Source #
See: newUpdateComponentTypeResponse
smart constructor.
Instances
newUpdateComponentTypeResponse Source #
Create a value of UpdateComponentTypeResponse
with all optional fields omitted.
Use 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:UpdateComponentTypeResponse'
, updateComponentTypeResponse_httpStatus
- The response's http status code.
UpdateComponentType
, updateComponentTypeResponse_workspaceId
- The ID of the workspace that contains the component type.
UpdateComponentTypeResponse
, updateComponentTypeResponse_arn
- The ARN of the component type.
UpdateComponentType
, updateComponentTypeResponse_componentTypeId
- The ID of the component type.
UpdateComponentTypeResponse
, updateComponentTypeResponse_state
- The current state of the component type.
UpdateEntity
data UpdateEntity Source #
See: newUpdateEntity
smart constructor.
Constructors
UpdateEntity' (Maybe (HashMap Text ComponentUpdateRequest)) (Maybe Text) (Maybe Text) (Maybe ParentEntityUpdateRequest) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateEntity |
Create a value of UpdateEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentUpdates:UpdateEntity'
, updateEntity_componentUpdates
- An object that maps strings to the component updates in the request.
Each string in the mapping must be unique to this object.
UpdateEntity
, updateEntity_description
- The description of the entity.
UpdateEntity
, updateEntity_entityName
- The name of the entity.
$sel:parentEntityUpdate:UpdateEntity'
, updateEntity_parentEntityUpdate
- An object that describes the update request for a parent entity.
UpdateEntity
, updateEntity_workspaceId
- The ID of the workspace that contains the entity.
UpdateEntity
, updateEntity_entityId
- The ID of the entity.
data UpdateEntityResponse Source #
See: newUpdateEntityResponse
smart constructor.
Constructors
UpdateEntityResponse' Int POSIX State |
Instances
newUpdateEntityResponse Source #
Arguments
:: Int | |
-> UTCTime | |
-> State | |
-> UpdateEntityResponse |
Create a value of UpdateEntityResponse
with all optional fields omitted.
Use 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:UpdateEntityResponse'
, updateEntityResponse_httpStatus
- The response's http status code.
UpdateEntityResponse
, updateEntityResponse_updateDateTime
- The date and time when the entity was last updated.
UpdateEntityResponse
, updateEntityResponse_state
- The current state of the entity update.
UpdatePricingPlan
data UpdatePricingPlan Source #
See: newUpdatePricingPlan
smart constructor.
Constructors
UpdatePricingPlan' (Maybe (NonEmpty Text)) PricingMode |
Instances
Arguments
:: PricingMode | |
-> UpdatePricingPlan |
Create a value of UpdatePricingPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdatePricingPlan
, updatePricingPlan_bundleNames
- The bundle names.
UpdatePricingPlan
, updatePricingPlan_pricingMode
- The pricing mode.
data UpdatePricingPlanResponse Source #
See: newUpdatePricingPlanResponse
smart constructor.
Constructors
UpdatePricingPlanResponse' (Maybe PricingPlan) Int PricingPlan |
Instances
newUpdatePricingPlanResponse Source #
Arguments
:: Int | |
-> PricingPlan | |
-> UpdatePricingPlanResponse |
Create a value of UpdatePricingPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingPricingPlan:UpdatePricingPlanResponse'
, updatePricingPlanResponse_pendingPricingPlan
- Update the pending pricing plan.
$sel:httpStatus:UpdatePricingPlanResponse'
, updatePricingPlanResponse_httpStatus
- The response's http status code.
$sel:currentPricingPlan:UpdatePricingPlanResponse'
, updatePricingPlanResponse_currentPricingPlan
- Update the current pricing plan.
UpdateScene
data UpdateScene Source #
See: newUpdateScene
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateScene |
Create a value of UpdateScene
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:UpdateScene'
, updateScene_capabilities
- A list of capabilities that the scene uses to render.
UpdateScene
, updateScene_contentLocation
- The relative path that specifies the location of the content definition
file.
UpdateScene
, updateScene_description
- The description of this scene.
UpdateScene
, updateScene_workspaceId
- The ID of the workspace that contains the scene.
UpdateScene
, updateScene_sceneId
- The ID of the scene.
data UpdateSceneResponse Source #
See: newUpdateSceneResponse
smart constructor.
Constructors
UpdateSceneResponse' Int POSIX |
Instances
newUpdateSceneResponse Source #
Arguments
:: Int | |
-> UTCTime | |
-> UpdateSceneResponse |
Create a value of UpdateSceneResponse
with all optional fields omitted.
Use 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:UpdateSceneResponse'
, updateSceneResponse_httpStatus
- The response's http status code.
UpdateSceneResponse
, updateSceneResponse_updateDateTime
- The date and time when the scene was last updated.
UpdateWorkspace
data UpdateWorkspace Source #
See: newUpdateWorkspace
smart constructor.
Instances
Arguments
:: Text | |
-> UpdateWorkspace |
Create a value of UpdateWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkspace
, updateWorkspace_description
- The description of the workspace.
$sel:role':UpdateWorkspace'
, updateWorkspace_role
- The ARN of the execution role associated with the workspace.
UpdateWorkspace
, updateWorkspace_workspaceId
- The ID of the workspace.
data UpdateWorkspaceResponse Source #
See: newUpdateWorkspaceResponse
smart constructor.
Constructors
UpdateWorkspaceResponse' Int POSIX |
Instances
newUpdateWorkspaceResponse Source #
Arguments
:: Int | |
-> UTCTime | |
-> UpdateWorkspaceResponse |
Create a value of UpdateWorkspaceResponse
with all optional fields omitted.
Use 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:UpdateWorkspaceResponse'
, updateWorkspaceResponse_httpStatus
- The response's http status code.
UpdateWorkspaceResponse
, updateWorkspaceResponse_updateDateTime
- The date and time of the current update.
Types
ColumnType
newtype ColumnType Source #
Constructors
ColumnType' | |
Fields |
Bundled Patterns
pattern ColumnType_EDGE :: ColumnType | |
pattern ColumnType_NODE :: ColumnType | |
pattern ColumnType_VALUE :: ColumnType |
Instances
ComponentUpdateType
newtype ComponentUpdateType Source #
Constructors
ComponentUpdateType' | |
Fields |
Bundled Patterns
pattern ComponentUpdateType_CREATE :: ComponentUpdateType | |
pattern ComponentUpdateType_DELETE :: ComponentUpdateType | |
pattern ComponentUpdateType_UPDATE :: ComponentUpdateType |
Instances
ErrorCode
Constructors
ErrorCode' | |
Fields |
Bundled Patterns
pattern ErrorCode_INTERNAL_FAILURE :: ErrorCode | |
pattern ErrorCode_SYNC_CREATING_ERROR :: ErrorCode | |
pattern ErrorCode_SYNC_INITIALIZING_ERROR :: ErrorCode | |
pattern ErrorCode_SYNC_PROCESSING_ERROR :: ErrorCode | |
pattern ErrorCode_VALIDATION_ERROR :: ErrorCode |
Instances
GroupType
Constructors
GroupType' | |
Fields |
Bundled Patterns
pattern GroupType_TABULAR :: GroupType |
Instances
InterpolationType
newtype InterpolationType Source #
Constructors
InterpolationType' | |
Fields |
Bundled Patterns
pattern InterpolationType_LINEAR :: InterpolationType |
Instances
Order
Bundled Patterns
pattern Order_ASCENDING :: Order | |
pattern Order_DESCENDING :: Order |
Instances
OrderByTime
newtype OrderByTime Source #
Constructors
OrderByTime' | |
Fields |
Bundled Patterns
pattern OrderByTime_ASCENDING :: OrderByTime | |
pattern OrderByTime_DESCENDING :: OrderByTime |
Instances
ParentEntityUpdateType
newtype ParentEntityUpdateType Source #
Constructors
ParentEntityUpdateType' | |
Fields |
Bundled Patterns
pattern ParentEntityUpdateType_DELETE :: ParentEntityUpdateType | |
pattern ParentEntityUpdateType_UPDATE :: ParentEntityUpdateType |
Instances
PricingMode
newtype PricingMode Source #
Constructors
PricingMode' | |
Fields |
Bundled Patterns
pattern PricingMode_BASIC :: PricingMode | |
pattern PricingMode_STANDARD :: PricingMode | |
pattern PricingMode_TIERED_BUNDLE :: PricingMode |
Instances
PricingTier
newtype PricingTier Source #
Constructors
PricingTier' | |
Fields |
Bundled Patterns
pattern PricingTier_TIER_1 :: PricingTier | |
pattern PricingTier_TIER_2 :: PricingTier | |
pattern PricingTier_TIER_3 :: PricingTier | |
pattern PricingTier_TIER_4 :: PricingTier |
Instances
PropertyGroupUpdateType
newtype PropertyGroupUpdateType Source #
Constructors
PropertyGroupUpdateType' | |
Fields |
Bundled Patterns
pattern PropertyGroupUpdateType_CREATE :: PropertyGroupUpdateType | |
pattern PropertyGroupUpdateType_DELETE :: PropertyGroupUpdateType | |
pattern PropertyGroupUpdateType_UPDATE :: PropertyGroupUpdateType |
Instances
PropertyUpdateType
newtype PropertyUpdateType Source #
Constructors
PropertyUpdateType' | |
Fields |
Bundled Patterns
pattern PropertyUpdateType_CREATE :: PropertyUpdateType | |
pattern PropertyUpdateType_DELETE :: PropertyUpdateType | |
pattern PropertyUpdateType_UPDATE :: PropertyUpdateType |
Instances
Scope
Bundled Patterns
pattern Scope_ENTITY :: Scope | |
pattern Scope_WORKSPACE :: Scope |
Instances
State
Bundled Patterns
pattern State_ACTIVE :: State | |
pattern State_CREATING :: State | |
pattern State_DELETING :: State | |
pattern State_ERROR :: State | |
pattern State_UPDATING :: State |
Instances
SyncJobState
newtype SyncJobState Source #
Constructors
SyncJobState' | |
Fields |
Bundled Patterns
pattern SyncJobState_ACTIVE :: SyncJobState | |
pattern SyncJobState_CREATING :: SyncJobState | |
pattern SyncJobState_DELETING :: SyncJobState | |
pattern SyncJobState_ERROR :: SyncJobState | |
pattern SyncJobState_INITIALIZING :: SyncJobState |
Instances
SyncResourceState
newtype SyncResourceState Source #
Constructors
SyncResourceState' | |
Fields |
Bundled Patterns
pattern SyncResourceState_DELETED :: SyncResourceState | |
pattern SyncResourceState_ERROR :: SyncResourceState | |
pattern SyncResourceState_INITIALIZING :: SyncResourceState | |
pattern SyncResourceState_IN_SYNC :: SyncResourceState | |
pattern SyncResourceState_PROCESSING :: SyncResourceState |
Instances
SyncResourceType
newtype SyncResourceType Source #
Constructors
SyncResourceType' | |
Fields |
Bundled Patterns
pattern SyncResourceType_COMPONENT_TYPE :: SyncResourceType | |
pattern SyncResourceType_ENTITY :: SyncResourceType |
Instances
Type
Bundled Patterns
pattern Type_BOOLEAN :: Type | |
pattern Type_DOUBLE :: Type | |
pattern Type_INTEGER :: Type | |
pattern Type_LIST :: Type | |
pattern Type_LONG :: Type | |
pattern Type_MAP :: Type | |
pattern Type_RELATIONSHIP :: Type | |
pattern Type_STRING :: Type |
Instances
UpdateReason
newtype UpdateReason Source #
Constructors
UpdateReason' | |
Fields |
Bundled Patterns
pattern UpdateReason_DEFAULT :: UpdateReason | |
pattern UpdateReason_ENTITY_COUNT_UPDATE :: UpdateReason | |
pattern UpdateReason_OVERWRITTEN :: UpdateReason | |
pattern UpdateReason_PRICING_MODE_UPDATE :: UpdateReason | |
pattern UpdateReason_PRICING_TIER_UPDATE :: UpdateReason |
Instances
BatchPutPropertyError
data BatchPutPropertyError Source #
An error returned by the BatchPutProperty
action.
See: newBatchPutPropertyError
smart constructor.
Constructors
BatchPutPropertyError' Text Text PropertyValueEntry |
Instances
newBatchPutPropertyError Source #
Arguments
:: Text | |
-> Text | |
-> PropertyValueEntry | |
-> BatchPutPropertyError |
Create a value of BatchPutPropertyError
with all optional fields omitted.
Use 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:BatchPutPropertyError'
, batchPutPropertyError_errorCode
- The error code.
$sel:errorMessage:BatchPutPropertyError'
, batchPutPropertyError_errorMessage
- The error message.
$sel:entry:BatchPutPropertyError'
, batchPutPropertyError_entry
- An object that contains information about errors returned by the
BatchPutProperty
action.
BatchPutPropertyErrorEntry
data BatchPutPropertyErrorEntry Source #
An object that contains information about errors returned by the
BatchPutProperty
action.
See: newBatchPutPropertyErrorEntry
smart constructor.
Constructors
BatchPutPropertyErrorEntry' (NonEmpty BatchPutPropertyError) |
Instances
newBatchPutPropertyErrorEntry Source #
Arguments
:: NonEmpty BatchPutPropertyError | |
-> BatchPutPropertyErrorEntry |
Create a value of BatchPutPropertyErrorEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchPutPropertyErrorEntry'
, batchPutPropertyErrorEntry_errors
- A list of objects that contain information about errors returned by the
BatchPutProperty
action.
BundleInformation
data BundleInformation Source #
Information about pricing bundle.
See: newBundleInformation
smart constructor.
Constructors
BundleInformation' (Maybe PricingTier) (NonEmpty Text) |
Instances
Arguments
:: NonEmpty Text | |
-> BundleInformation |
Create a value of BundleInformation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingTier:BundleInformation'
, bundleInformation_pricingTier
- The pricing tier.
$sel:bundleNames:BundleInformation'
, bundleInformation_bundleNames
- The bundle names.
ColumnDescription
data ColumnDescription Source #
A description of the column in the query results.
See: newColumnDescription
smart constructor.
Constructors
ColumnDescription' (Maybe Text) (Maybe ColumnType) |
Instances
newColumnDescription :: ColumnDescription Source #
Create a value of ColumnDescription
with all optional fields omitted.
Use 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:ColumnDescription'
, columnDescription_name
- The name of the column description.
$sel:type':ColumnDescription'
, columnDescription_type
- The type of the column description.
ComponentPropertyGroupRequest
data ComponentPropertyGroupRequest Source #
See: newComponentPropertyGroupRequest
smart constructor.
Constructors
ComponentPropertyGroupRequest' (Maybe GroupType) (Maybe [Text]) (Maybe PropertyGroupUpdateType) |
Instances
newComponentPropertyGroupRequest :: ComponentPropertyGroupRequest Source #
Create a value of ComponentPropertyGroupRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupType:ComponentPropertyGroupRequest'
, componentPropertyGroupRequest_groupType
- The group type.
$sel:propertyNames:ComponentPropertyGroupRequest'
, componentPropertyGroupRequest_propertyNames
- The property names.
$sel:updateType:ComponentPropertyGroupRequest'
, componentPropertyGroupRequest_updateType
- The update type.
ComponentPropertyGroupResponse
data ComponentPropertyGroupResponse Source #
The component property group response.
See: newComponentPropertyGroupResponse
smart constructor.
Constructors
ComponentPropertyGroupResponse' GroupType [Text] Bool |
Instances
newComponentPropertyGroupResponse Source #
Arguments
:: GroupType | |
-> Bool | |
-> ComponentPropertyGroupResponse |
Create a value of ComponentPropertyGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupType:ComponentPropertyGroupResponse'
, componentPropertyGroupResponse_groupType
- The group type.
$sel:propertyNames:ComponentPropertyGroupResponse'
, componentPropertyGroupResponse_propertyNames
- The names of properties
$sel:isInherited:ComponentPropertyGroupResponse'
, componentPropertyGroupResponse_isInherited
- A Boolean value that specifies whether the property group is inherited
from a parent entity
ComponentRequest
data ComponentRequest Source #
An object that sets information about a component type create or update request.
See: newComponentRequest
smart constructor.
Constructors
ComponentRequest' (Maybe Text) (Maybe Text) (Maybe (HashMap Text PropertyRequest)) (Maybe (HashMap Text ComponentPropertyGroupRequest)) |
Instances
newComponentRequest :: ComponentRequest Source #
Create a value of ComponentRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentTypeId:ComponentRequest'
, componentRequest_componentTypeId
- The ID of the component type.
$sel:description:ComponentRequest'
, componentRequest_description
- The description of the component request.
$sel:properties:ComponentRequest'
, componentRequest_properties
- An object that maps strings to the properties to set in the component
type. Each string in the mapping must be unique to this object.
$sel:propertyGroups:ComponentRequest'
, componentRequest_propertyGroups
- The property groups.
ComponentResponse
data ComponentResponse Source #
An object that returns information about a component type create or update request.
See: newComponentResponse
smart constructor.
Constructors
ComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text PropertyResponse)) (Maybe (HashMap Text ComponentPropertyGroupResponse)) (Maybe Status) (Maybe Text) |
Instances
newComponentResponse :: ComponentResponse Source #
Create a value of ComponentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentName:ComponentResponse'
, componentResponse_componentName
- The name of the component.
$sel:componentTypeId:ComponentResponse'
, componentResponse_componentTypeId
- The ID of the component type.
$sel:definedIn:ComponentResponse'
, componentResponse_definedIn
- The name of the property definition set in the request.
$sel:description:ComponentResponse'
, componentResponse_description
- The description of the component type.
$sel:properties:ComponentResponse'
, componentResponse_properties
- An object that maps strings to the properties to set in the component
type. Each string in the mapping must be unique to this object.
$sel:propertyGroups:ComponentResponse'
, componentResponse_propertyGroups
- The property groups.
$sel:status:ComponentResponse'
, componentResponse_status
- The status of the component type.
$sel:syncSource:ComponentResponse'
, componentResponse_syncSource
- The syncSource of the sync job, if this entity was created by a sync
job.
ComponentTypeSummary
data ComponentTypeSummary Source #
An object that contains information about a component type.
See: newComponentTypeSummary
smart constructor.
Instances
newComponentTypeSummary Source #
Arguments
:: Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> ComponentTypeSummary |
Create a value of ComponentTypeSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentTypeName:ComponentTypeSummary'
, componentTypeSummary_componentTypeName
- The component type name.
$sel:description:ComponentTypeSummary'
, componentTypeSummary_description
- The description of the component type.
$sel:status:ComponentTypeSummary'
, componentTypeSummary_status
- The current status of the component type.
$sel:arn:ComponentTypeSummary'
, componentTypeSummary_arn
- The ARN of the component type.
$sel:componentTypeId:ComponentTypeSummary'
, componentTypeSummary_componentTypeId
- The ID of the component type.
$sel:creationDateTime:ComponentTypeSummary'
, componentTypeSummary_creationDateTime
- The date and time when the component type was created.
$sel:updateDateTime:ComponentTypeSummary'
, componentTypeSummary_updateDateTime
- The date and time when the component type was last updated.
ComponentUpdateRequest
data ComponentUpdateRequest Source #
The component update request.
See: newComponentUpdateRequest
smart constructor.
Constructors
ComponentUpdateRequest' (Maybe Text) (Maybe Text) (Maybe (HashMap Text ComponentPropertyGroupRequest)) (Maybe (HashMap Text PropertyRequest)) (Maybe ComponentUpdateType) |
Instances
newComponentUpdateRequest :: ComponentUpdateRequest Source #
Create a value of ComponentUpdateRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentTypeId:ComponentUpdateRequest'
, componentUpdateRequest_componentTypeId
- The ID of the component type.
$sel:description:ComponentUpdateRequest'
, componentUpdateRequest_description
- The description of the component type.
$sel:propertyGroupUpdates:ComponentUpdateRequest'
, componentUpdateRequest_propertyGroupUpdates
- The property group updates.
$sel:propertyUpdates:ComponentUpdateRequest'
, componentUpdateRequest_propertyUpdates
- An object that maps strings to the properties to set in the component
type update. Each string in the mapping must be unique to this object.
ComponentUpdateRequest
, componentUpdateRequest_updateType
- The update type of the component update request.
DataConnector
data DataConnector Source #
The data connector.
See: newDataConnector
smart constructor.
Constructors
DataConnector' (Maybe Bool) (Maybe LambdaFunction) |
Instances
newDataConnector :: DataConnector Source #
Create a value of DataConnector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isNative:DataConnector'
, dataConnector_isNative
- A Boolean value that specifies whether the data connector is native to
IoT TwinMaker.
$sel:lambda:DataConnector'
, dataConnector_lambda
- The Lambda function associated with this data connector.
DataType
An object that specifies the data type of a property.
See: newDataType
smart constructor.
Instances
Create a value of DataType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedValues:DataType'
, dataType_allowedValues
- The allowed values for this data type.
$sel:nestedType:DataType'
, dataType_nestedType
- The nested type in the data type.
$sel:relationship:DataType'
, dataType_relationship
- A relationship that associates a component with another component.
$sel:unitOfMeasure:DataType'
, dataType_unitOfMeasure
- The unit of measure used in this data type.
$sel:type':DataType'
, dataType_type
- The underlying type of the data type.
DataValue
An object that specifies a value for a property.
See: newDataValue
smart constructor.
Constructors
DataValue' (Maybe Bool) (Maybe Double) (Maybe Text) (Maybe Int) (Maybe [DataValue]) (Maybe Integer) (Maybe (HashMap Text DataValue)) (Maybe RelationshipValue) (Maybe Text) |
Instances
newDataValue :: DataValue Source #
Create a value of DataValue
with all optional fields omitted.
Use 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:DataValue'
, dataValue_booleanValue
- A Boolean value.
$sel:doubleValue:DataValue'
, dataValue_doubleValue
- A double value.
$sel:expression:DataValue'
, dataValue_expression
- An expression that produces the value.
$sel:integerValue:DataValue'
, dataValue_integerValue
- An integer value.
$sel:listValue:DataValue'
, dataValue_listValue
- A list of multiple values.
$sel:longValue:DataValue'
, dataValue_longValue
- A long value.
$sel:mapValue:DataValue'
, dataValue_mapValue
- An object that maps strings to multiple DataValue
objects.
$sel:relationshipValue:DataValue'
, dataValue_relationshipValue
- A value that relates a component to another component.
$sel:stringValue:DataValue'
, dataValue_stringValue
- A string value.
EntityPropertyReference
data EntityPropertyReference Source #
An object that uniquely identifies an entity property.
See: newEntityPropertyReference
smart constructor.
Instances
newEntityPropertyReference Source #
Create a value of EntityPropertyReference
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentName:EntityPropertyReference'
, entityPropertyReference_componentName
- The name of the component.
$sel:entityId:EntityPropertyReference'
, entityPropertyReference_entityId
- The ID of the entity.
$sel:externalIdProperty:EntityPropertyReference'
, entityPropertyReference_externalIdProperty
- A mapping of external IDs to property names. External IDs uniquely
identify properties from external data stores.
$sel:propertyName:EntityPropertyReference'
, entityPropertyReference_propertyName
- The name of the property.
EntitySummary
data EntitySummary Source #
An object that contains information about an entity.
See: newEntitySummary
smart constructor.
Instances
Create a value of EntitySummary
with all optional fields omitted.
Use 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:EntitySummary'
, entitySummary_description
- The description of the entity.
$sel:hasChildEntities:EntitySummary'
, entitySummary_hasChildEntities
- A Boolean value that specifies whether the entity has child entities or
not.
$sel:parentEntityId:EntitySummary'
, entitySummary_parentEntityId
- The ID of the parent entity.
$sel:entityId:EntitySummary'
, entitySummary_entityId
- The ID of the entity.
$sel:entityName:EntitySummary'
, entitySummary_entityName
- The name of the entity.
$sel:arn:EntitySummary'
, entitySummary_arn
- The ARN of the entity.
$sel:status:EntitySummary'
, entitySummary_status
- The current status of the entity.
$sel:creationDateTime:EntitySummary'
, entitySummary_creationDateTime
- The date and time when the entity was created.
$sel:updateDateTime:EntitySummary'
, entitySummary_updateDateTime
- The last date and time when the entity was updated.
ErrorDetails
data ErrorDetails Source #
The error details.
See: newErrorDetails
smart constructor.
Constructors
ErrorDetails' (Maybe ErrorCode) (Maybe Text) |
Instances
newErrorDetails :: ErrorDetails Source #
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:code:ErrorDetails'
, errorDetails_code
- The error code.
$sel:message:ErrorDetails'
, errorDetails_message
- The error message.
FunctionRequest
data FunctionRequest Source #
The function request body.
See: newFunctionRequest
smart constructor.
Constructors
FunctionRequest' (Maybe DataConnector) (Maybe [Text]) (Maybe Scope) |
Instances
newFunctionRequest :: FunctionRequest Source #
Create a value of FunctionRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:implementedBy:FunctionRequest'
, functionRequest_implementedBy
- The data connector.
$sel:requiredProperties:FunctionRequest'
, functionRequest_requiredProperties
- The required properties of the function.
$sel:scope:FunctionRequest'
, functionRequest_scope
- The scope of the function.
FunctionResponse
data FunctionResponse Source #
The function response.
See: newFunctionResponse
smart constructor.
Constructors
FunctionResponse' (Maybe DataConnector) (Maybe Bool) (Maybe [Text]) (Maybe Scope) |
Instances
newFunctionResponse :: FunctionResponse Source #
Create a value of FunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:implementedBy:FunctionResponse'
, functionResponse_implementedBy
- The data connector.
$sel:isInherited:FunctionResponse'
, functionResponse_isInherited
- Indicates whether this function is inherited.
$sel:requiredProperties:FunctionResponse'
, functionResponse_requiredProperties
- The required properties of the function.
$sel:scope:FunctionResponse'
, functionResponse_scope
- The scope of the function.
InterpolationParameters
data InterpolationParameters Source #
An object that specifies how to interpolate data in a list.
See: newInterpolationParameters
smart constructor.
Constructors
InterpolationParameters' (Maybe InterpolationType) (Maybe Integer) |
Instances
newInterpolationParameters :: InterpolationParameters Source #
Create a value of InterpolationParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:interpolationType:InterpolationParameters'
, interpolationParameters_interpolationType
- The interpolation type.
$sel:intervalInSeconds:InterpolationParameters'
, interpolationParameters_intervalInSeconds
- The interpolation time interval in seconds.
LambdaFunction
data LambdaFunction Source #
The Lambda function.
See: newLambdaFunction
smart constructor.
Constructors
LambdaFunction' Text |
Instances
Arguments
:: Text | |
-> LambdaFunction |
Create a value of LambdaFunction
with all optional fields omitted.
Use 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:LambdaFunction'
, lambdaFunction_arn
- The ARN of the Lambda function.
ListComponentTypesFilter
data ListComponentTypesFilter Source #
An object that filters items in a list of component types.
Only one object is accepted as a valid input.
See: newListComponentTypesFilter
smart constructor.
Instances
newListComponentTypesFilter :: ListComponentTypesFilter Source #
Create a value of ListComponentTypesFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:extendsFrom:ListComponentTypesFilter'
, listComponentTypesFilter_extendsFrom
- The component type that the component types in the list extend.
$sel:isAbstract:ListComponentTypesFilter'
, listComponentTypesFilter_isAbstract
- A Boolean value that specifies whether the component types in the list
are abstract.
$sel:namespace:ListComponentTypesFilter'
, listComponentTypesFilter_namespace
- The namespace to which the component types in the list belong.
ListEntitiesFilter
data ListEntitiesFilter Source #
An object that filters items in a list of entities.
See: newListEntitiesFilter
smart constructor.
Instances
newListEntitiesFilter :: ListEntitiesFilter Source #
Create a value of ListEntitiesFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:componentTypeId:ListEntitiesFilter'
, listEntitiesFilter_componentTypeId
- The ID of the component type in the entities in the list.
$sel:externalId:ListEntitiesFilter'
, listEntitiesFilter_externalId
- The external-Id property of a component. The external-Id property is the
primary key of an external storage system.
$sel:parentEntityId:ListEntitiesFilter'
, listEntitiesFilter_parentEntityId
- The parent of the entities in the list.
OrderBy
Filter criteria that orders the return output. It can be sorted in ascending or descending order.
See: newOrderBy
smart constructor.
Instances
ToJSON OrderBy Source # | |
Defined in Amazonka.IotTwinMaker.Types.OrderBy | |
Generic OrderBy Source # | |
Read OrderBy Source # | |
Show OrderBy Source # | |
NFData OrderBy Source # | |
Defined in Amazonka.IotTwinMaker.Types.OrderBy | |
Eq OrderBy Source # | |
Hashable OrderBy Source # | |
Defined in Amazonka.IotTwinMaker.Types.OrderBy | |
type Rep OrderBy Source # | |
Defined in Amazonka.IotTwinMaker.Types.OrderBy type Rep OrderBy = D1 ('MetaData "OrderBy" "Amazonka.IotTwinMaker.Types.OrderBy" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "OrderBy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :*: S1 ('MetaSel ('Just "propertyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of OrderBy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:order:OrderBy'
, orderBy_order
- The set order that filters results.
$sel:propertyName:OrderBy'
, orderBy_propertyName
- The property name.
ParentEntityUpdateRequest
data ParentEntityUpdateRequest Source #
The parent entity update request.
See: newParentEntityUpdateRequest
smart constructor.
Constructors
ParentEntityUpdateRequest' (Maybe Text) ParentEntityUpdateType |
Instances
newParentEntityUpdateRequest Source #
Arguments
:: ParentEntityUpdateType | |
-> ParentEntityUpdateRequest |
Create a value of ParentEntityUpdateRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parentEntityId:ParentEntityUpdateRequest'
, parentEntityUpdateRequest_parentEntityId
- The ID of the parent entity.
$sel:updateType:ParentEntityUpdateRequest'
, parentEntityUpdateRequest_updateType
- The type of the update.
PricingPlan
data PricingPlan Source #
The pricing plan.
See: newPricingPlan
smart constructor.
Constructors
PricingPlan' (Maybe Integer) (Maybe BundleInformation) POSIX PricingMode POSIX UpdateReason |
Instances
Arguments
:: UTCTime | |
-> PricingMode | |
-> UTCTime | |
-> UpdateReason | |
-> PricingPlan |
Create a value of PricingPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billableEntityCount:PricingPlan'
, pricingPlan_billableEntityCount
- The billable entity count.
$sel:bundleInformation:PricingPlan'
, pricingPlan_bundleInformation
- The pricing plan's bundle information.
$sel:effectiveDateTime:PricingPlan'
, pricingPlan_effectiveDateTime
- The effective date and time of the pricing plan.
$sel:pricingMode:PricingPlan'
, pricingPlan_pricingMode
- The pricing mode.
$sel:updateDateTime:PricingPlan'
, pricingPlan_updateDateTime
- The set date and time for updating a pricing plan.
$sel:updateReason:PricingPlan'
, pricingPlan_updateReason
- The update reason, for changing a pricing plan.
PropertyDefinitionRequest
data PropertyDefinitionRequest Source #
An object that sets information about a property.
See: newPropertyDefinitionRequest
smart constructor.
Constructors
PropertyDefinitionRequest' (Maybe (HashMap Text Text)) (Maybe DataType) (Maybe DataValue) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
Instances
newPropertyDefinitionRequest :: PropertyDefinitionRequest Source #
Create a value of PropertyDefinitionRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:PropertyDefinitionRequest'
, propertyDefinitionRequest_configuration
- A mapping that specifies configuration information about the property.
Use this field to specify information that you read from and write to an
external source.
$sel:dataType:PropertyDefinitionRequest'
, propertyDefinitionRequest_dataType
- An object that contains information about the data type.
$sel:defaultValue:PropertyDefinitionRequest'
, propertyDefinitionRequest_defaultValue
- An object that contains the default value.
$sel:displayName:PropertyDefinitionRequest'
, propertyDefinitionRequest_displayName
- A friendly name for the property.
$sel:isExternalId:PropertyDefinitionRequest'
, propertyDefinitionRequest_isExternalId
- A Boolean value that specifies whether the property ID comes from an
external data store.
$sel:isRequiredInEntity:PropertyDefinitionRequest'
, propertyDefinitionRequest_isRequiredInEntity
- A Boolean value that specifies whether the property is required.
$sel:isStoredExternally:PropertyDefinitionRequest'
, propertyDefinitionRequest_isStoredExternally
- A Boolean value that specifies whether the property is stored
externally.
$sel:isTimeSeries:PropertyDefinitionRequest'
, propertyDefinitionRequest_isTimeSeries
- A Boolean value that specifies whether the property consists of time
series data.
PropertyDefinitionResponse
data PropertyDefinitionResponse Source #
An object that contains response data from a property definition request.
See: newPropertyDefinitionResponse
smart constructor.
Constructors
PropertyDefinitionResponse' (Maybe (HashMap Text Text)) (Maybe DataValue) (Maybe Text) DataType Bool Bool Bool Bool Bool Bool Bool |
Instances
newPropertyDefinitionResponse Source #
Create a value of PropertyDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:PropertyDefinitionResponse'
, propertyDefinitionResponse_configuration
- A mapping that specifies configuration information about the property.
$sel:defaultValue:PropertyDefinitionResponse'
, propertyDefinitionResponse_defaultValue
- An object that contains the default value.
$sel:displayName:PropertyDefinitionResponse'
, propertyDefinitionResponse_displayName
- A friendly name for the property.
$sel:dataType:PropertyDefinitionResponse'
, propertyDefinitionResponse_dataType
- An object that contains information about the data type.
$sel:isTimeSeries:PropertyDefinitionResponse'
, propertyDefinitionResponse_isTimeSeries
- A Boolean value that specifies whether the property consists of time
series data.
$sel:isRequiredInEntity:PropertyDefinitionResponse'
, propertyDefinitionResponse_isRequiredInEntity
- A Boolean value that specifies whether the property is required in an
entity.
$sel:isExternalId:PropertyDefinitionResponse'
, propertyDefinitionResponse_isExternalId
- A Boolean value that specifies whether the property ID comes from an
external data store.
$sel:isStoredExternally:PropertyDefinitionResponse'
, propertyDefinitionResponse_isStoredExternally
- A Boolean value that specifies whether the property is stored
externally.
$sel:isImported:PropertyDefinitionResponse'
, propertyDefinitionResponse_isImported
- A Boolean value that specifies whether the property definition is
imported from an external data store.
$sel:isFinal:PropertyDefinitionResponse'
, propertyDefinitionResponse_isFinal
- A Boolean value that specifies whether the property definition can be
updated.
$sel:isInherited:PropertyDefinitionResponse'
, propertyDefinitionResponse_isInherited
- A Boolean value that specifies whether the property definition is
inherited from a parent entity.
PropertyFilter
data PropertyFilter Source #
An object that filters items returned by a property request.
See: newPropertyFilter
smart constructor.
Instances
newPropertyFilter :: PropertyFilter Source #
Create a value of PropertyFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:operator:PropertyFilter'
, propertyFilter_operator
- The operator associated with this property filter.
$sel:propertyName:PropertyFilter'
, propertyFilter_propertyName
- The property name associated with this property filter.
$sel:value:PropertyFilter'
, propertyFilter_value
- The value associated with this property filter.
PropertyGroupRequest
data PropertyGroupRequest Source #
See: newPropertyGroupRequest
smart constructor.
Constructors
PropertyGroupRequest' (Maybe GroupType) (Maybe [Text]) |
Instances
newPropertyGroupRequest :: PropertyGroupRequest Source #
Create a value of PropertyGroupRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupType:PropertyGroupRequest'
, propertyGroupRequest_groupType
- The group type.
$sel:propertyNames:PropertyGroupRequest'
, propertyGroupRequest_propertyNames
- The names of properties.
PropertyGroupResponse
data PropertyGroupResponse Source #
The property group response
See: newPropertyGroupResponse
smart constructor.
Constructors
PropertyGroupResponse' GroupType [Text] Bool |
Instances
newPropertyGroupResponse Source #
Arguments
:: GroupType | |
-> Bool | |
-> PropertyGroupResponse |
Create a value of PropertyGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupType:PropertyGroupResponse'
, propertyGroupResponse_groupType
- The group types.
$sel:propertyNames:PropertyGroupResponse'
, propertyGroupResponse_propertyNames
- The names of properties.
$sel:isInherited:PropertyGroupResponse'
, propertyGroupResponse_isInherited
- A Boolean value that specifies whether the property group is inherited
from a parent entity
PropertyLatestValue
data PropertyLatestValue Source #
The latest value of the property.
See: newPropertyLatestValue
smart constructor.
Constructors
PropertyLatestValue' (Maybe DataValue) EntityPropertyReference |
Instances
newPropertyLatestValue Source #
Arguments
:: EntityPropertyReference | |
-> PropertyLatestValue |
Create a value of PropertyLatestValue
with all optional fields omitted.
Use 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:PropertyLatestValue'
, propertyLatestValue_propertyValue
- The value of the property.
$sel:propertyReference:PropertyLatestValue'
, propertyLatestValue_propertyReference
- An object that specifies information about a property.>
PropertyRequest
data PropertyRequest Source #
An object that sets information about a property.
See: newPropertyRequest
smart constructor.
Constructors
PropertyRequest' (Maybe PropertyDefinitionRequest) (Maybe PropertyUpdateType) (Maybe DataValue) |
Instances
newPropertyRequest :: PropertyRequest Source #
Create a value of PropertyRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:definition:PropertyRequest'
, propertyRequest_definition
- An object that specifies information about a property.
$sel:updateType:PropertyRequest'
, propertyRequest_updateType
- The update type of the update property request.
$sel:value:PropertyRequest'
, propertyRequest_value
- The value of the property.
PropertyResponse
data PropertyResponse Source #
An object that contains information about a property response.
See: newPropertyResponse
smart constructor.
Constructors
PropertyResponse' (Maybe PropertyDefinitionResponse) (Maybe DataValue) |
Instances
newPropertyResponse :: PropertyResponse Source #
Create a value of PropertyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:definition:PropertyResponse'
, propertyResponse_definition
- An object that specifies information about a property.
$sel:value:PropertyResponse'
, propertyResponse_value
- The value of the property.
PropertyValue
data PropertyValue Source #
An object that contains information about a value for a time series property.
See: newPropertyValue
smart constructor.
Instances
Arguments
:: DataValue | |
-> PropertyValue |
Create a value of PropertyValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:time:PropertyValue'
, propertyValue_time
- ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].
- [YYYY]: year
- [MM]: month
- [DD]: day
- [hh]: hour
- [mm]: minute
- [ss]: seconds
- [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
- Z: default timezone UTC
- ± HH:mm: time zone offset in Hours and Minutes.
Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
$sel:timestamp:PropertyValue'
, propertyValue_timestamp
- The timestamp of a value for a time series property.
$sel:value:PropertyValue'
, propertyValue_value
- An object that specifies a value for a time series property.
PropertyValueEntry
data PropertyValueEntry Source #
An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
See: newPropertyValueEntry
smart constructor.
Constructors
PropertyValueEntry' (Maybe (NonEmpty PropertyValue)) EntityPropertyReference |
Instances
newPropertyValueEntry Source #
Arguments
:: EntityPropertyReference | |
-> PropertyValueEntry |
Create a value of PropertyValueEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:propertyValues:PropertyValueEntry'
, propertyValueEntry_propertyValues
- A list of objects that specify time series property values.
$sel:entityPropertyReference:PropertyValueEntry'
, propertyValueEntry_entityPropertyReference
- An object that contains information about the entity that has the
property.
PropertyValueHistory
data PropertyValueHistory Source #
The history of values for a time series property.
See: newPropertyValueHistory
smart constructor.
Constructors
PropertyValueHistory' (Maybe [PropertyValue]) EntityPropertyReference |
Instances
newPropertyValueHistory Source #
Arguments
:: EntityPropertyReference | |
-> PropertyValueHistory |
Create a value of PropertyValueHistory
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:PropertyValueHistory'
, propertyValueHistory_values
- A list of objects that contain information about the values in the
history of a time series property.
$sel:entityPropertyReference:PropertyValueHistory'
, propertyValueHistory_entityPropertyReference
- An object that uniquely identifies an entity property.
QueryResultValue
data QueryResultValue Source #
See: newQueryResultValue
smart constructor.
Constructors
QueryResultValue' | |
Instances
newQueryResultValue :: QueryResultValue Source #
Create a value of QueryResultValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Relationship
data Relationship Source #
An object that specifies a relationship with another component type.
See: newRelationship
smart constructor.
Constructors
Relationship' (Maybe Text) (Maybe Text) |
Instances
newRelationship :: Relationship Source #
Create a value of Relationship
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relationshipType:Relationship'
, relationship_relationshipType
- The type of the relationship.
$sel:targetComponentTypeId:Relationship'
, relationship_targetComponentTypeId
- The ID of the target component type associated with this relationship.
RelationshipValue
data RelationshipValue Source #
A value that associates a component and an entity.
See: newRelationshipValue
smart constructor.
Constructors
RelationshipValue' (Maybe Text) (Maybe Text) |
Instances
newRelationshipValue :: RelationshipValue Source #
Create a value of RelationshipValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetComponentName:RelationshipValue'
, relationshipValue_targetComponentName
- The name of the target component associated with the relationship value.
$sel:targetEntityId:RelationshipValue'
, relationshipValue_targetEntityId
- The ID of the target entity associated with this relationship value.
Row
Represents a single row in the query results.
See: newRow
smart constructor.
Constructors
Row' (Maybe [QueryResultValue]) |
Instances
FromJSON Row Source # | |
Generic Row Source # | |
Read Row Source # | |
Show Row Source # | |
NFData Row Source # | |
Defined in Amazonka.IotTwinMaker.Types.Row | |
Eq Row Source # | |
Hashable Row Source # | |
Defined in Amazonka.IotTwinMaker.Types.Row | |
type Rep Row Source # | |
Defined in Amazonka.IotTwinMaker.Types.Row type Rep Row = D1 ('MetaData "Row" "Amazonka.IotTwinMaker.Types.Row" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "Row'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rowData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueryResultValue])))) |
Create a value of Row
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rowData:Row'
, row_rowData
- The data in a row of query results.
SceneSummary
data SceneSummary Source #
An object that contains information about a scene.
See: newSceneSummary
smart constructor.
Instances
Create a value of SceneSummary
with all optional fields omitted.
Use 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:SceneSummary'
, sceneSummary_description
- The scene description.
$sel:sceneId:SceneSummary'
, sceneSummary_sceneId
- The ID of the scene.
$sel:contentLocation:SceneSummary'
, sceneSummary_contentLocation
- The relative path that specifies the location of the content definition
file.
$sel:arn:SceneSummary'
, sceneSummary_arn
- The ARN of the scene.
$sel:creationDateTime:SceneSummary'
, sceneSummary_creationDateTime
- The date and time when the scene was created.
$sel:updateDateTime:SceneSummary'
, sceneSummary_updateDateTime
- The date and time when the scene was last updated.
Status
An object that represents the status of an entity, component, component type, or workspace.
See: newStatus
smart constructor.
Constructors
Status' (Maybe ErrorDetails) (Maybe State) |
Instances
FromJSON Status Source # | |
Generic Status Source # | |
Read Status Source # | |
Show Status Source # | |
NFData Status Source # | |
Defined in Amazonka.IotTwinMaker.Types.Status | |
Eq Status Source # | |
Hashable Status Source # | |
Defined in Amazonka.IotTwinMaker.Types.Status | |
type Rep Status Source # | |
Defined in Amazonka.IotTwinMaker.Types.Status type Rep Status = D1 ('MetaData "Status" "Amazonka.IotTwinMaker.Types.Status" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "Status'" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorDetails)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)))) |
Create a value of Status
with all optional fields omitted.
Use 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:Status'
, status_error
- The error message.
$sel:state:Status'
, status_state
- The current state of the entity, component, component type, or
workspace.
SyncJobStatus
data SyncJobStatus Source #
The SyncJob status.
See: newSyncJobStatus
smart constructor.
Constructors
SyncJobStatus' (Maybe ErrorDetails) (Maybe SyncJobState) |
Instances
newSyncJobStatus :: SyncJobStatus Source #
Create a value of SyncJobStatus
with all optional fields omitted.
Use 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:SyncJobStatus'
, syncJobStatus_error
- The SyncJob error.
$sel:state:SyncJobStatus'
, syncJobStatus_state
- The SyncJob status state.
SyncJobSummary
data SyncJobSummary Source #
The SyncJob summary.
See: newSyncJobSummary
smart constructor.
Constructors
SyncJobSummary' (Maybe Text) (Maybe POSIX) (Maybe SyncJobStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newSyncJobSummary :: SyncJobSummary Source #
Create a value of SyncJobSummary
with all optional fields omitted.
Use 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:SyncJobSummary'
, syncJobSummary_arn
- The SyncJob summary ARN.
$sel:creationDateTime:SyncJobSummary'
, syncJobSummary_creationDateTime
- The creation date and time.
$sel:status:SyncJobSummary'
, syncJobSummary_status
- The SyncJob summaries status.
$sel:syncSource:SyncJobSummary'
, syncJobSummary_syncSource
- The sync source.
$sel:updateDateTime:SyncJobSummary'
, syncJobSummary_updateDateTime
- The update date and time.
$sel:workspaceId:SyncJobSummary'
, syncJobSummary_workspaceId
- The ID of the workspace that contains the sync job.
SyncResourceFilter
data SyncResourceFilter Source #
The sync resource filter.
See: newSyncResourceFilter
smart constructor.
Constructors
SyncResourceFilter' (Maybe Text) (Maybe Text) (Maybe SyncResourceType) (Maybe SyncResourceState) |
Instances
newSyncResourceFilter :: SyncResourceFilter Source #
Create a value of SyncResourceFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalId:SyncResourceFilter'
, syncResourceFilter_externalId
- The external Id.
$sel:resourceId:SyncResourceFilter'
, syncResourceFilter_resourceId
- The sync resource filter resource Id.
$sel:resourceType:SyncResourceFilter'
, syncResourceFilter_resourceType
- The sync resource filter resoucre type
$sel:state:SyncResourceFilter'
, syncResourceFilter_state
- The sync resource filter's state.
SyncResourceStatus
data SyncResourceStatus Source #
The sync resource status.
See: newSyncResourceStatus
smart constructor.
Constructors
SyncResourceStatus' (Maybe ErrorDetails) (Maybe SyncResourceState) |
Instances
newSyncResourceStatus :: SyncResourceStatus Source #
Create a value of SyncResourceStatus
with all optional fields omitted.
Use 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:SyncResourceStatus'
, syncResourceStatus_error
- The status error.
$sel:state:SyncResourceStatus'
, syncResourceStatus_state
- The sync resource status state.
SyncResourceSummary
data SyncResourceSummary Source #
The sync resource summary.
See: newSyncResourceSummary
smart constructor.
Constructors
SyncResourceSummary' (Maybe Text) (Maybe Text) (Maybe SyncResourceType) (Maybe SyncResourceStatus) (Maybe POSIX) |
Instances
newSyncResourceSummary :: SyncResourceSummary Source #
Create a value of SyncResourceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalId:SyncResourceSummary'
, syncResourceSummary_externalId
- The external Id.
$sel:resourceId:SyncResourceSummary'
, syncResourceSummary_resourceId
- The resource Id.
$sel:resourceType:SyncResourceSummary'
, syncResourceSummary_resourceType
- The resource type.
$sel:status:SyncResourceSummary'
, syncResourceSummary_status
- The sync resource summary status.
$sel:updateDateTime:SyncResourceSummary'
, syncResourceSummary_updateDateTime
- The update date and time.
TabularConditions
data TabularConditions Source #
The tabular conditions.
See: newTabularConditions
smart constructor.
Constructors
TabularConditions' (Maybe (NonEmpty OrderBy)) (Maybe (NonEmpty PropertyFilter)) |
Instances
newTabularConditions :: TabularConditions Source #
Create a value of TabularConditions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orderBy:TabularConditions'
, tabularConditions_orderBy
- Filter criteria that orders the output. It can be sorted in ascending or
descending order.
$sel:propertyFilters:TabularConditions'
, tabularConditions_propertyFilters
- You can filter the request using various logical operators and a
key-value format. For example:
{"key": "serverType", "value": "webServer"}
WorkspaceSummary
data WorkspaceSummary Source #
An object that contains information about a workspace.
See: newWorkspaceSummary
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> WorkspaceSummary |
Create a value of WorkspaceSummary
with all optional fields omitted.
Use 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:WorkspaceSummary'
, workspaceSummary_description
- The description of the workspace.
$sel:workspaceId:WorkspaceSummary'
, workspaceSummary_workspaceId
- The ID of the workspace.
$sel:arn:WorkspaceSummary'
, workspaceSummary_arn
- The ARN of the workspace.
$sel:creationDateTime:WorkspaceSummary'
, workspaceSummary_creationDateTime
- The date and time when the workspace was created.
$sel:updateDateTime:WorkspaceSummary'
, workspaceSummary_updateDateTime
- The date and time when the workspace was last updated.