amazonka-iottwinmaker-2.0: Amazon IoT TwinMaker SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IotTwinMaker.Lens

Description

 
Synopsis

Operations

BatchPutPropertyValues

batchPutPropertyValues_workspaceId :: Lens' BatchPutPropertyValues Text Source #

The ID of the workspace that contains the properties to set.

batchPutPropertyValues_entries :: Lens' BatchPutPropertyValues (NonEmpty PropertyValueEntry) Source #

An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.

batchPutPropertyValuesResponse_httpStatus :: Lens' BatchPutPropertyValuesResponse Int Source #

The response's http status code.

batchPutPropertyValuesResponse_errorEntries :: Lens' BatchPutPropertyValuesResponse (NonEmpty BatchPutPropertyErrorEntry) Source #

Entries that caused errors in the batch put operation.

CreateComponentType

createComponentType_componentTypeName :: Lens' CreateComponentType (Maybe Text) Source #

A friendly name for the component type.

createComponentType_description :: Lens' CreateComponentType (Maybe Text) Source #

The description of the component type.

createComponentType_extendsFrom :: Lens' CreateComponentType (Maybe [Text]) Source #

Specifies the parent component type to extend.

createComponentType_functions :: Lens' CreateComponentType (Maybe (HashMap Text FunctionRequest)) Source #

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

createComponentType_isSingleton :: Lens' CreateComponentType (Maybe Bool) Source #

A Boolean value that specifies whether an entity can have more than one component of this type.

createComponentType_propertyDefinitions :: Lens' CreateComponentType (Maybe (HashMap Text PropertyDefinitionRequest)) Source #

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_propertyGroups :: Lens' CreateComponentType (Maybe (HashMap Text PropertyGroupRequest)) Source #

createComponentType_tags :: Lens' CreateComponentType (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the component type.

createComponentType_workspaceId :: Lens' CreateComponentType Text Source #

The ID of the workspace that contains the component type.

createComponentType_componentTypeId :: Lens' CreateComponentType Text Source #

The ID of the component type.

createComponentTypeResponse_httpStatus :: Lens' CreateComponentTypeResponse Int Source #

The response's http status code.

createComponentTypeResponse_arn :: Lens' CreateComponentTypeResponse Text Source #

The ARN of the component type.

createComponentTypeResponse_creationDateTime :: Lens' CreateComponentTypeResponse UTCTime Source #

The date and time when the entity was created.

createComponentTypeResponse_state :: Lens' CreateComponentTypeResponse State Source #

The current state of the component type.

CreateEntity

createEntity_components :: Lens' CreateEntity (Maybe (HashMap Text ComponentRequest)) Source #

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

createEntity_description :: Lens' CreateEntity (Maybe Text) Source #

The description of the entity.

createEntity_entityId :: Lens' CreateEntity (Maybe Text) Source #

The ID of the entity.

createEntity_parentEntityId :: Lens' CreateEntity (Maybe Text) Source #

The ID of the entity's parent entity.

createEntity_tags :: Lens' CreateEntity (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the entity.

createEntity_workspaceId :: Lens' CreateEntity Text Source #

The ID of the workspace that contains the entity.

createEntity_entityName :: Lens' CreateEntity Text Source #

The name of the entity.

createEntityResponse_httpStatus :: Lens' CreateEntityResponse Int Source #

The response's http status code.

createEntityResponse_entityId :: Lens' CreateEntityResponse Text Source #

The ID of the entity.

createEntityResponse_arn :: Lens' CreateEntityResponse Text Source #

The ARN of the entity.

createEntityResponse_creationDateTime :: Lens' CreateEntityResponse UTCTime Source #

The date and time when the entity was created.

createEntityResponse_state :: Lens' CreateEntityResponse State Source #

The current state of the entity.

CreateScene

createScene_capabilities :: Lens' CreateScene (Maybe [Text]) Source #

A list of capabilities that the scene uses to render itself.

createScene_description :: Lens' CreateScene (Maybe Text) Source #

The description for this scene.

createScene_tags :: Lens' CreateScene (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the scene.

createScene_workspaceId :: Lens' CreateScene Text Source #

The ID of the workspace that contains the scene.

createScene_sceneId :: Lens' CreateScene Text Source #

The ID of the scene.

createScene_contentLocation :: Lens' CreateScene Text Source #

The relative path that specifies the location of the content definition file.

createSceneResponse_httpStatus :: Lens' CreateSceneResponse Int Source #

The response's http status code.

createSceneResponse_arn :: Lens' CreateSceneResponse Text Source #

The ARN of the scene.

createSceneResponse_creationDateTime :: Lens' CreateSceneResponse UTCTime Source #

The date and time when the scene was created.

CreateSyncJob

createSyncJob_tags :: Lens' CreateSyncJob (Maybe (HashMap Text Text)) Source #

The SyncJob tags.

createSyncJob_workspaceId :: Lens' CreateSyncJob Text Source #

The workspace Id.

createSyncJob_syncSource :: Lens' CreateSyncJob Text Source #

The sync source.

Currently the only supported syncSoucre is SITEWISE .

createSyncJob_syncRole :: Lens' CreateSyncJob Text Source #

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.

createSyncJobResponse_httpStatus :: Lens' CreateSyncJobResponse Int Source #

The response's http status code.

createSyncJobResponse_arn :: Lens' CreateSyncJobResponse Text Source #

The SyncJob ARN.

createSyncJobResponse_creationDateTime :: Lens' CreateSyncJobResponse UTCTime Source #

The date and time for the SyncJob creation.

createSyncJobResponse_state :: Lens' CreateSyncJobResponse SyncJobState Source #

The SyncJob response state.

CreateWorkspace

createWorkspace_description :: Lens' CreateWorkspace (Maybe Text) Source #

The description of the workspace.

createWorkspace_tags :: Lens' CreateWorkspace (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the workspace

createWorkspace_workspaceId :: Lens' CreateWorkspace Text Source #

The ID of the workspace.

createWorkspace_s3Location :: Lens' CreateWorkspace Text Source #

The ARN of the S3 bucket where resources associated with the workspace are stored.

createWorkspace_role :: Lens' CreateWorkspace Text Source #

The ARN of the execution role associated with the workspace.

createWorkspaceResponse_httpStatus :: Lens' CreateWorkspaceResponse Int Source #

The response's http status code.

createWorkspaceResponse_arn :: Lens' CreateWorkspaceResponse Text Source #

The ARN of the workspace.

createWorkspaceResponse_creationDateTime :: Lens' CreateWorkspaceResponse UTCTime Source #

The date and time when the workspace was created.

DeleteComponentType

deleteComponentType_workspaceId :: Lens' DeleteComponentType Text Source #

The ID of the workspace that contains the component type.

deleteComponentType_componentTypeId :: Lens' DeleteComponentType Text Source #

The ID of the component type to delete.

deleteComponentTypeResponse_httpStatus :: Lens' DeleteComponentTypeResponse Int Source #

The response's http status code.

deleteComponentTypeResponse_state :: Lens' DeleteComponentTypeResponse State Source #

The current state of the component type to be deleted.

DeleteEntity

deleteEntity_isRecursive :: Lens' DeleteEntity (Maybe Bool) Source #

A Boolean value that specifies whether the operation deletes child entities.

deleteEntity_workspaceId :: Lens' DeleteEntity Text Source #

The ID of the workspace that contains the entity to delete.

deleteEntity_entityId :: Lens' DeleteEntity Text Source #

The ID of the entity to delete.

deleteEntityResponse_httpStatus :: Lens' DeleteEntityResponse Int Source #

The response's http status code.

deleteEntityResponse_state :: Lens' DeleteEntityResponse State Source #

The current state of the deleted entity.

DeleteScene

deleteScene_workspaceId :: Lens' DeleteScene Text Source #

The ID of the workspace.

deleteScene_sceneId :: Lens' DeleteScene Text Source #

The ID of the scene to delete.

deleteSceneResponse_httpStatus :: Lens' DeleteSceneResponse Int Source #

The response's http status code.

DeleteSyncJob

deleteSyncJob_workspaceId :: Lens' DeleteSyncJob Text Source #

The workspace Id.

deleteSyncJob_syncSource :: Lens' DeleteSyncJob Text Source #

The sync source.

Currently the only supported syncSoucre is SITEWISE .

deleteSyncJobResponse_httpStatus :: Lens' DeleteSyncJobResponse Int Source #

The response's http status code.

deleteSyncJobResponse_state :: Lens' DeleteSyncJobResponse SyncJobState Source #

The SyncJob response state.

DeleteWorkspace

deleteWorkspace_workspaceId :: Lens' DeleteWorkspace Text Source #

The ID of the workspace to delete.

deleteWorkspaceResponse_httpStatus :: Lens' DeleteWorkspaceResponse Int Source #

The response's http status code.

ExecuteQuery

executeQuery_maxResults :: Lens' ExecuteQuery (Maybe Natural) Source #

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_nextToken :: Lens' ExecuteQuery (Maybe Text) Source #

The string that specifies the next page of results.

executeQuery_workspaceId :: Lens' ExecuteQuery Text Source #

The ID of the workspace.

executeQuery_queryStatement :: Lens' ExecuteQuery Text Source #

The query statement.

executeQueryResponse_columnDescriptions :: Lens' ExecuteQueryResponse (Maybe [ColumnDescription]) Source #

A list of ColumnDescription objects.

executeQueryResponse_nextToken :: Lens' ExecuteQueryResponse (Maybe Text) Source #

The string that specifies the next page of results.

executeQueryResponse_rows :: Lens' ExecuteQueryResponse (Maybe [Row]) Source #

Represents a single row in the query results.

executeQueryResponse_httpStatus :: Lens' ExecuteQueryResponse Int Source #

The response's http status code.

GetComponentType

getComponentType_workspaceId :: Lens' GetComponentType Text Source #

The ID of the workspace that contains the component type.

getComponentType_componentTypeId :: Lens' GetComponentType Text Source #

The ID of the component type.

getComponentTypeResponse_componentTypeName :: Lens' GetComponentTypeResponse (Maybe Text) Source #

The component type name.

getComponentTypeResponse_description :: Lens' GetComponentTypeResponse (Maybe Text) Source #

The description of the component type.

getComponentTypeResponse_extendsFrom :: Lens' GetComponentTypeResponse (Maybe [Text]) Source #

The name of the parent component type that this component type extends.

getComponentTypeResponse_functions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text FunctionResponse)) Source #

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

getComponentTypeResponse_isAbstract :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

A Boolean value that specifies whether the component type is abstract.

getComponentTypeResponse_isSchemaInitialized :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

getComponentTypeResponse_isSingleton :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

A Boolean value that specifies whether an entity can have more than one component of this type.

getComponentTypeResponse_propertyDefinitions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyDefinitionResponse)) Source #

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_propertyGroups :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyGroupResponse)) Source #

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_status :: Lens' GetComponentTypeResponse (Maybe Status) Source #

The current status of the component type.

getComponentTypeResponse_syncSource :: Lens' GetComponentTypeResponse (Maybe Text) Source #

The syncSource of the sync job, if this entity was created by a sync job.

getComponentTypeResponse_httpStatus :: Lens' GetComponentTypeResponse Int Source #

The response's http status code.

getComponentTypeResponse_workspaceId :: Lens' GetComponentTypeResponse Text Source #

The ID of the workspace that contains the component type.

getComponentTypeResponse_componentTypeId :: Lens' GetComponentTypeResponse Text Source #

The ID of the component type.

getComponentTypeResponse_creationDateTime :: Lens' GetComponentTypeResponse UTCTime Source #

The date and time when the component type was created.

getComponentTypeResponse_updateDateTime :: Lens' GetComponentTypeResponse UTCTime Source #

The date and time when the component was last updated.

getComponentTypeResponse_arn :: Lens' GetComponentTypeResponse Text Source #

The ARN of the component type.

GetEntity

getEntity_workspaceId :: Lens' GetEntity Text Source #

The ID of the workspace.

getEntity_entityId :: Lens' GetEntity Text Source #

The ID of the entity.

getEntityResponse_components :: Lens' GetEntityResponse (Maybe (HashMap Text ComponentResponse)) Source #

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

getEntityResponse_description :: Lens' GetEntityResponse (Maybe Text) Source #

The description of the entity.

getEntityResponse_syncSource :: Lens' GetEntityResponse (Maybe Text) Source #

The syncSource of the sync job, if this entity was created by a sync job.

getEntityResponse_httpStatus :: Lens' GetEntityResponse Int Source #

The response's http status code.

getEntityResponse_entityId :: Lens' GetEntityResponse Text Source #

The ID of the entity.

getEntityResponse_entityName :: Lens' GetEntityResponse Text Source #

The name of the entity.

getEntityResponse_arn :: Lens' GetEntityResponse Text Source #

The ARN of the entity.

getEntityResponse_status :: Lens' GetEntityResponse Status Source #

The current status of the entity.

getEntityResponse_workspaceId :: Lens' GetEntityResponse Text Source #

The ID of the workspace.

getEntityResponse_parentEntityId :: Lens' GetEntityResponse Text Source #

The ID of the parent entity for this entity.

getEntityResponse_hasChildEntities :: Lens' GetEntityResponse Bool Source #

A Boolean value that specifies whether the entity has associated child entities.

getEntityResponse_creationDateTime :: Lens' GetEntityResponse UTCTime Source #

The date and time when the entity was created.

getEntityResponse_updateDateTime :: Lens' GetEntityResponse UTCTime Source #

The date and time when the entity was last updated.

GetPricingPlan

getPricingPlanResponse_pendingPricingPlan :: Lens' GetPricingPlanResponse (Maybe PricingPlan) Source #

The pending pricing plan.

getPricingPlanResponse_httpStatus :: Lens' GetPricingPlanResponse Int Source #

The response's http status code.

getPricingPlanResponse_currentPricingPlan :: Lens' GetPricingPlanResponse PricingPlan Source #

The chosen pricing plan for the current billing cycle.

GetPropertyValue

getPropertyValue_componentName :: Lens' GetPropertyValue (Maybe Text) Source #

The name of the component whose property values the operation returns.

getPropertyValue_componentTypeId :: Lens' GetPropertyValue (Maybe Text) Source #

The ID of the component type whose property values the operation returns.

getPropertyValue_entityId :: Lens' GetPropertyValue (Maybe Text) Source #

The ID of the entity whose property values the operation returns.

getPropertyValue_maxResults :: Lens' GetPropertyValue (Maybe Natural) Source #

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_nextToken :: Lens' GetPropertyValue (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValue_propertyGroupName :: Lens' GetPropertyValue (Maybe Text) Source #

The property group name.

getPropertyValue_tabularConditions :: Lens' GetPropertyValue (Maybe TabularConditions) Source #

The tabular conditions.

getPropertyValue_selectedProperties :: Lens' GetPropertyValue (NonEmpty Text) Source #

The properties whose values the operation returns.

getPropertyValue_workspaceId :: Lens' GetPropertyValue Text Source #

The ID of the workspace whose values the operation returns.

getPropertyValueResponse_nextToken :: Lens' GetPropertyValueResponse (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueResponse_propertyValues :: Lens' GetPropertyValueResponse (Maybe (HashMap Text PropertyLatestValue)) Source #

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.

getPropertyValueResponse_tabularPropertyValues :: Lens' GetPropertyValueResponse (Maybe [[HashMap Text DataValue]]) Source #

A table of property values.

getPropertyValueResponse_httpStatus :: Lens' GetPropertyValueResponse Int Source #

The response's http status code.

GetPropertyValueHistory

getPropertyValueHistory_componentName :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The name of the component.

getPropertyValueHistory_componentTypeId :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ID of the component type.

getPropertyValueHistory_endDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime) Source #

The date and time of the latest property value to return.

getPropertyValueHistory_endTime :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

getPropertyValueHistory_entityId :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ID of the entity.

getPropertyValueHistory_interpolation :: Lens' GetPropertyValueHistory (Maybe InterpolationParameters) Source #

An object that specifies the interpolation type and the interval over which to interpolate data.

getPropertyValueHistory_maxResults :: Lens' GetPropertyValueHistory (Maybe Natural) Source #

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_nextToken :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueHistory_orderByTime :: Lens' GetPropertyValueHistory (Maybe OrderByTime) Source #

The time direction to use in the result order.

getPropertyValueHistory_propertyFilters :: Lens' GetPropertyValueHistory (Maybe (NonEmpty PropertyFilter)) Source #

A list of objects that filter the property value history request.

getPropertyValueHistory_startDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime) Source #

The date and time of the earliest property value to return.

getPropertyValueHistory_startTime :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

getPropertyValueHistory_workspaceId :: Lens' GetPropertyValueHistory Text Source #

The ID of the workspace.

getPropertyValueHistory_selectedProperties :: Lens' GetPropertyValueHistory (NonEmpty Text) Source #

A list of properties whose value histories the request retrieves.

getPropertyValueHistoryResponse_nextToken :: Lens' GetPropertyValueHistoryResponse (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueHistoryResponse_httpStatus :: Lens' GetPropertyValueHistoryResponse Int Source #

The response's http status code.

getPropertyValueHistoryResponse_propertyValues :: Lens' GetPropertyValueHistoryResponse [PropertyValueHistory] Source #

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

getScene_workspaceId :: Lens' GetScene Text Source #

The ID of the workspace that contains the scene.

getScene_sceneId :: Lens' GetScene Text Source #

The ID of the scene.

getSceneResponse_capabilities :: Lens' GetSceneResponse (Maybe [Text]) Source #

A list of capabilities that the scene uses to render.

getSceneResponse_description :: Lens' GetSceneResponse (Maybe Text) Source #

The description of the scene.

getSceneResponse_httpStatus :: Lens' GetSceneResponse Int Source #

The response's http status code.

getSceneResponse_workspaceId :: Lens' GetSceneResponse Text Source #

The ID of the workspace that contains the scene.

getSceneResponse_sceneId :: Lens' GetSceneResponse Text Source #

The ID of the scene.

getSceneResponse_contentLocation :: Lens' GetSceneResponse Text Source #

The relative path that specifies the location of the content definition file.

getSceneResponse_arn :: Lens' GetSceneResponse Text Source #

The ARN of the scene.

getSceneResponse_creationDateTime :: Lens' GetSceneResponse UTCTime Source #

The date and time when the scene was created.

getSceneResponse_updateDateTime :: Lens' GetSceneResponse UTCTime Source #

The date and time when the scene was last updated.

GetSyncJob

getSyncJob_workspaceId :: Lens' GetSyncJob (Maybe Text) Source #

The workspace Id.

getSyncJob_syncSource :: Lens' GetSyncJob Text Source #

The sync soucre.

Currently the only supported syncSoucre is SITEWISE .

getSyncJobResponse_httpStatus :: Lens' GetSyncJobResponse Int Source #

The response's http status code.

getSyncJobResponse_arn :: Lens' GetSyncJobResponse Text Source #

The sync job ARN.

getSyncJobResponse_workspaceId :: Lens' GetSyncJobResponse Text Source #

The ID of the workspace that contains the sync job.

getSyncJobResponse_syncSource :: Lens' GetSyncJobResponse Text Source #

The sync soucre.

Currently the only supported syncSoucre is SITEWISE .

getSyncJobResponse_syncRole :: Lens' GetSyncJobResponse Text Source #

The sync IAM role.

getSyncJobResponse_status :: Lens' GetSyncJobResponse SyncJobStatus Source #

The SyncJob response status.

getSyncJobResponse_creationDateTime :: Lens' GetSyncJobResponse UTCTime Source #

The creation date and time.

getSyncJobResponse_updateDateTime :: Lens' GetSyncJobResponse UTCTime Source #

The update date and time.

GetWorkspace

getWorkspace_workspaceId :: Lens' GetWorkspace Text Source #

The ID of the workspace.

getWorkspaceResponse_description :: Lens' GetWorkspaceResponse (Maybe Text) Source #

The description of the workspace.

getWorkspaceResponse_httpStatus :: Lens' GetWorkspaceResponse Int Source #

The response's http status code.

getWorkspaceResponse_workspaceId :: Lens' GetWorkspaceResponse Text Source #

The ID of the workspace.

getWorkspaceResponse_arn :: Lens' GetWorkspaceResponse Text Source #

The ARN of the workspace.

getWorkspaceResponse_s3Location :: Lens' GetWorkspaceResponse Text Source #

The ARN of the S3 bucket where resources associated with the workspace are stored.

getWorkspaceResponse_role :: Lens' GetWorkspaceResponse Text Source #

The ARN of the execution role associated with the workspace.

getWorkspaceResponse_creationDateTime :: Lens' GetWorkspaceResponse UTCTime Source #

The date and time when the workspace was created.

getWorkspaceResponse_updateDateTime :: Lens' GetWorkspaceResponse UTCTime Source #

The date and time when the workspace was last updated.

ListComponentTypes

listComponentTypes_filters :: Lens' ListComponentTypes (Maybe [ListComponentTypesFilter]) Source #

A list of objects that filter the request.

listComponentTypes_maxResults :: Lens' ListComponentTypes (Maybe Natural) Source #

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_nextToken :: Lens' ListComponentTypes (Maybe Text) Source #

The string that specifies the next page of results.

listComponentTypes_workspaceId :: Lens' ListComponentTypes Text Source #

The ID of the workspace.

listComponentTypesResponse_maxResults :: Lens' ListComponentTypesResponse (Maybe Natural) Source #

Specifies the maximum number of results to display.

listComponentTypesResponse_nextToken :: Lens' ListComponentTypesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listComponentTypesResponse_httpStatus :: Lens' ListComponentTypesResponse Int Source #

The response's http status code.

listComponentTypesResponse_workspaceId :: Lens' ListComponentTypesResponse Text Source #

The ID of the workspace.

listComponentTypesResponse_componentTypeSummaries :: Lens' ListComponentTypesResponse [ComponentTypeSummary] Source #

A list of objects that contain information about the component types.

ListEntities

listEntities_filters :: Lens' ListEntities (Maybe [ListEntitiesFilter]) Source #

A list of objects that filter the request.

Only one object is accepted as a valid input.

listEntities_maxResults :: Lens' ListEntities (Maybe Natural) Source #

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_nextToken :: Lens' ListEntities (Maybe Text) Source #

The string that specifies the next page of results.

listEntities_workspaceId :: Lens' ListEntities Text Source #

The ID of the workspace.

listEntitiesResponse_entitySummaries :: Lens' ListEntitiesResponse (Maybe [EntitySummary]) Source #

A list of objects that contain information about the entities.

listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int Source #

The response's http status code.

ListScenes

listScenes_maxResults :: Lens' ListScenes (Maybe Natural) Source #

Specifies the maximum number of results to display.

listScenes_nextToken :: Lens' ListScenes (Maybe Text) Source #

The string that specifies the next page of results.

listScenes_workspaceId :: Lens' ListScenes Text Source #

The ID of the workspace that contains the scenes.

listScenesResponse_nextToken :: Lens' ListScenesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listScenesResponse_sceneSummaries :: Lens' ListScenesResponse (Maybe [SceneSummary]) Source #

A list of objects that contain information about the scenes.

listScenesResponse_httpStatus :: Lens' ListScenesResponse Int Source #

The response's http status code.

ListSyncJobs

listSyncJobs_maxResults :: Lens' ListSyncJobs (Maybe Natural) Source #

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_nextToken :: Lens' ListSyncJobs (Maybe Text) Source #

The string that specifies the next page of results.

listSyncJobs_workspaceId :: Lens' ListSyncJobs Text Source #

The ID of the workspace that contains the sync job.

listSyncJobsResponse_nextToken :: Lens' ListSyncJobsResponse (Maybe Text) Source #

The string that specifies the next page of results.

listSyncJobsResponse_syncJobSummaries :: Lens' ListSyncJobsResponse (Maybe [SyncJobSummary]) Source #

The listed SyncJob summaries.

listSyncJobsResponse_httpStatus :: Lens' ListSyncJobsResponse Int Source #

The response's http status code.

ListSyncResources

listSyncResources_filters :: Lens' ListSyncResources (Maybe [SyncResourceFilter]) Source #

A list of objects that filter the request.

listSyncResources_maxResults :: Lens' ListSyncResources (Maybe Natural) Source #

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_nextToken :: Lens' ListSyncResources (Maybe Text) Source #

The string that specifies the next page of results.

listSyncResources_workspaceId :: Lens' ListSyncResources Text Source #

The ID of the workspace that contains the sync job.

listSyncResources_syncSource :: Lens' ListSyncResources Text Source #

The sync soucre.

Currently the only supported syncSoucre is SITEWISE .

listSyncResourcesResponse_nextToken :: Lens' ListSyncResourcesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listSyncResourcesResponse_syncResources :: Lens' ListSyncResourcesResponse (Maybe [SyncResourceSummary]) Source #

The sync resources.

listSyncResourcesResponse_httpStatus :: Lens' ListSyncResourcesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

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_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

The string that specifies the next page of results.

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The ARN of the resource.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The string that specifies the next page of results.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage a resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListWorkspaces

listWorkspaces_maxResults :: Lens' ListWorkspaces (Maybe Natural) Source #

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_nextToken :: Lens' ListWorkspaces (Maybe Text) Source #

The string that specifies the next page of results.

listWorkspacesResponse_nextToken :: Lens' ListWorkspacesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listWorkspacesResponse_workspaceSummaries :: Lens' ListWorkspacesResponse (Maybe [WorkspaceSummary]) Source #

A list of objects that contain information about the workspaces.

listWorkspacesResponse_httpStatus :: Lens' ListWorkspacesResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The ARN of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Metadata to add to this resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The ARN of the resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateComponentType

updateComponentType_componentTypeName :: Lens' UpdateComponentType (Maybe Text) Source #

The component type name.

updateComponentType_description :: Lens' UpdateComponentType (Maybe Text) Source #

The description of the component type.

updateComponentType_extendsFrom :: Lens' UpdateComponentType (Maybe [Text]) Source #

Specifies the component type that this component type extends.

updateComponentType_functions :: Lens' UpdateComponentType (Maybe (HashMap Text FunctionRequest)) Source #

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

updateComponentType_isSingleton :: Lens' UpdateComponentType (Maybe Bool) Source #

A Boolean value that specifies whether an entity can have more than one component of this type.

updateComponentType_propertyDefinitions :: Lens' UpdateComponentType (Maybe (HashMap Text PropertyDefinitionRequest)) Source #

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_propertyGroups :: Lens' UpdateComponentType (Maybe (HashMap Text PropertyGroupRequest)) Source #

The property groups

updateComponentType_workspaceId :: Lens' UpdateComponentType Text Source #

The ID of the workspace.

updateComponentType_componentTypeId :: Lens' UpdateComponentType Text Source #

The ID of the component type.

updateComponentTypeResponse_httpStatus :: Lens' UpdateComponentTypeResponse Int Source #

The response's http status code.

updateComponentTypeResponse_workspaceId :: Lens' UpdateComponentTypeResponse Text Source #

The ID of the workspace that contains the component type.

updateComponentTypeResponse_arn :: Lens' UpdateComponentTypeResponse Text Source #

The ARN of the component type.

updateComponentTypeResponse_componentTypeId :: Lens' UpdateComponentTypeResponse Text Source #

The ID of the component type.

updateComponentTypeResponse_state :: Lens' UpdateComponentTypeResponse State Source #

The current state of the component type.

UpdateEntity

updateEntity_componentUpdates :: Lens' UpdateEntity (Maybe (HashMap Text ComponentUpdateRequest)) Source #

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

updateEntity_description :: Lens' UpdateEntity (Maybe Text) Source #

The description of the entity.

updateEntity_entityName :: Lens' UpdateEntity (Maybe Text) Source #

The name of the entity.

updateEntity_parentEntityUpdate :: Lens' UpdateEntity (Maybe ParentEntityUpdateRequest) Source #

An object that describes the update request for a parent entity.

updateEntity_workspaceId :: Lens' UpdateEntity Text Source #

The ID of the workspace that contains the entity.

updateEntity_entityId :: Lens' UpdateEntity Text Source #

The ID of the entity.

updateEntityResponse_httpStatus :: Lens' UpdateEntityResponse Int Source #

The response's http status code.

updateEntityResponse_updateDateTime :: Lens' UpdateEntityResponse UTCTime Source #

The date and time when the entity was last updated.

updateEntityResponse_state :: Lens' UpdateEntityResponse State Source #

The current state of the entity update.

UpdatePricingPlan

updatePricingPlan_bundleNames :: Lens' UpdatePricingPlan (Maybe (NonEmpty Text)) Source #

The bundle names.

updatePricingPlan_pricingMode :: Lens' UpdatePricingPlan PricingMode Source #

The pricing mode.

updatePricingPlanResponse_pendingPricingPlan :: Lens' UpdatePricingPlanResponse (Maybe PricingPlan) Source #

Update the pending pricing plan.

updatePricingPlanResponse_httpStatus :: Lens' UpdatePricingPlanResponse Int Source #

The response's http status code.

updatePricingPlanResponse_currentPricingPlan :: Lens' UpdatePricingPlanResponse PricingPlan Source #

Update the current pricing plan.

UpdateScene

updateScene_capabilities :: Lens' UpdateScene (Maybe [Text]) Source #

A list of capabilities that the scene uses to render.

updateScene_contentLocation :: Lens' UpdateScene (Maybe Text) Source #

The relative path that specifies the location of the content definition file.

updateScene_description :: Lens' UpdateScene (Maybe Text) Source #

The description of this scene.

updateScene_workspaceId :: Lens' UpdateScene Text Source #

The ID of the workspace that contains the scene.

updateScene_sceneId :: Lens' UpdateScene Text Source #

The ID of the scene.

updateSceneResponse_httpStatus :: Lens' UpdateSceneResponse Int Source #

The response's http status code.

updateSceneResponse_updateDateTime :: Lens' UpdateSceneResponse UTCTime Source #

The date and time when the scene was last updated.

UpdateWorkspace

updateWorkspace_description :: Lens' UpdateWorkspace (Maybe Text) Source #

The description of the workspace.

updateWorkspace_role :: Lens' UpdateWorkspace (Maybe Text) Source #

The ARN of the execution role associated with the workspace.

updateWorkspace_workspaceId :: Lens' UpdateWorkspace Text Source #

The ID of the workspace.

updateWorkspaceResponse_httpStatus :: Lens' UpdateWorkspaceResponse Int Source #

The response's http status code.

updateWorkspaceResponse_updateDateTime :: Lens' UpdateWorkspaceResponse UTCTime Source #

The date and time of the current update.

Types

BatchPutPropertyError

batchPutPropertyError_errorCode :: Lens' BatchPutPropertyError Text Source #

The error code.

batchPutPropertyError_errorMessage :: Lens' BatchPutPropertyError Text Source #

The error message.

batchPutPropertyError_entry :: Lens' BatchPutPropertyError PropertyValueEntry Source #

An object that contains information about errors returned by the BatchPutProperty action.

BatchPutPropertyErrorEntry

batchPutPropertyErrorEntry_errors :: Lens' BatchPutPropertyErrorEntry (NonEmpty BatchPutPropertyError) Source #

A list of objects that contain information about errors returned by the BatchPutProperty action.

BundleInformation

bundleInformation_pricingTier :: Lens' BundleInformation (Maybe PricingTier) Source #

The pricing tier.

bundleInformation_bundleNames :: Lens' BundleInformation (NonEmpty Text) Source #

The bundle names.

ColumnDescription

columnDescription_name :: Lens' ColumnDescription (Maybe Text) Source #

The name of the column description.

columnDescription_type :: Lens' ColumnDescription (Maybe ColumnType) Source #

The type of the column description.

ComponentPropertyGroupRequest

componentPropertyGroupRequest_groupType :: Lens' ComponentPropertyGroupRequest (Maybe GroupType) Source #

The group type.

componentPropertyGroupRequest_propertyNames :: Lens' ComponentPropertyGroupRequest (Maybe [Text]) Source #

The property names.

componentPropertyGroupRequest_updateType :: Lens' ComponentPropertyGroupRequest (Maybe PropertyGroupUpdateType) Source #

The update type.

ComponentPropertyGroupResponse

componentPropertyGroupResponse_groupType :: Lens' ComponentPropertyGroupResponse GroupType Source #

The group type.

componentPropertyGroupResponse_propertyNames :: Lens' ComponentPropertyGroupResponse [Text] Source #

The names of properties

componentPropertyGroupResponse_isInherited :: Lens' ComponentPropertyGroupResponse Bool Source #

A Boolean value that specifies whether the property group is inherited from a parent entity

ComponentRequest

componentRequest_componentTypeId :: Lens' ComponentRequest (Maybe Text) Source #

The ID of the component type.

componentRequest_description :: Lens' ComponentRequest (Maybe Text) Source #

The description of the component request.

componentRequest_properties :: Lens' ComponentRequest (Maybe (HashMap Text PropertyRequest)) Source #

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.

componentRequest_propertyGroups :: Lens' ComponentRequest (Maybe (HashMap Text ComponentPropertyGroupRequest)) Source #

The property groups.

ComponentResponse

componentResponse_componentName :: Lens' ComponentResponse (Maybe Text) Source #

The name of the component.

componentResponse_componentTypeId :: Lens' ComponentResponse (Maybe Text) Source #

The ID of the component type.

componentResponse_definedIn :: Lens' ComponentResponse (Maybe Text) Source #

The name of the property definition set in the request.

componentResponse_description :: Lens' ComponentResponse (Maybe Text) Source #

The description of the component type.

componentResponse_properties :: Lens' ComponentResponse (Maybe (HashMap Text PropertyResponse)) Source #

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.

componentResponse_propertyGroups :: Lens' ComponentResponse (Maybe (HashMap Text ComponentPropertyGroupResponse)) Source #

The property groups.

componentResponse_status :: Lens' ComponentResponse (Maybe Status) Source #

The status of the component type.

componentResponse_syncSource :: Lens' ComponentResponse (Maybe Text) Source #

The syncSource of the sync job, if this entity was created by a sync job.

ComponentTypeSummary

componentTypeSummary_componentTypeName :: Lens' ComponentTypeSummary (Maybe Text) Source #

The component type name.

componentTypeSummary_description :: Lens' ComponentTypeSummary (Maybe Text) Source #

The description of the component type.

componentTypeSummary_status :: Lens' ComponentTypeSummary (Maybe Status) Source #

The current status of the component type.

componentTypeSummary_arn :: Lens' ComponentTypeSummary Text Source #

The ARN of the component type.

componentTypeSummary_componentTypeId :: Lens' ComponentTypeSummary Text Source #

The ID of the component type.

componentTypeSummary_creationDateTime :: Lens' ComponentTypeSummary UTCTime Source #

The date and time when the component type was created.

componentTypeSummary_updateDateTime :: Lens' ComponentTypeSummary UTCTime Source #

The date and time when the component type was last updated.

ComponentUpdateRequest

componentUpdateRequest_componentTypeId :: Lens' ComponentUpdateRequest (Maybe Text) Source #

The ID of the component type.

componentUpdateRequest_description :: Lens' ComponentUpdateRequest (Maybe Text) Source #

The description of the component type.

componentUpdateRequest_propertyGroupUpdates :: Lens' ComponentUpdateRequest (Maybe (HashMap Text ComponentPropertyGroupRequest)) Source #

The property group updates.

componentUpdateRequest_propertyUpdates :: Lens' ComponentUpdateRequest (Maybe (HashMap Text PropertyRequest)) Source #

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_updateType :: Lens' ComponentUpdateRequest (Maybe ComponentUpdateType) Source #

The update type of the component update request.

DataConnector

dataConnector_isNative :: Lens' DataConnector (Maybe Bool) Source #

A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

dataConnector_lambda :: Lens' DataConnector (Maybe LambdaFunction) Source #

The Lambda function associated with this data connector.

DataType

dataType_allowedValues :: Lens' DataType (Maybe [DataValue]) Source #

The allowed values for this data type.

dataType_nestedType :: Lens' DataType (Maybe DataType) Source #

The nested type in the data type.

dataType_relationship :: Lens' DataType (Maybe Relationship) Source #

A relationship that associates a component with another component.

dataType_unitOfMeasure :: Lens' DataType (Maybe Text) Source #

The unit of measure used in this data type.

dataType_type :: Lens' DataType Type Source #

The underlying type of the data type.

DataValue

dataValue_booleanValue :: Lens' DataValue (Maybe Bool) Source #

A Boolean value.

dataValue_doubleValue :: Lens' DataValue (Maybe Double) Source #

A double value.

dataValue_expression :: Lens' DataValue (Maybe Text) Source #

An expression that produces the value.

dataValue_integerValue :: Lens' DataValue (Maybe Int) Source #

An integer value.

dataValue_listValue :: Lens' DataValue (Maybe [DataValue]) Source #

A list of multiple values.

dataValue_longValue :: Lens' DataValue (Maybe Integer) Source #

A long value.

dataValue_mapValue :: Lens' DataValue (Maybe (HashMap Text DataValue)) Source #

An object that maps strings to multiple DataValue objects.

dataValue_relationshipValue :: Lens' DataValue (Maybe RelationshipValue) Source #

A value that relates a component to another component.

dataValue_stringValue :: Lens' DataValue (Maybe Text) Source #

A string value.

EntityPropertyReference

entityPropertyReference_componentName :: Lens' EntityPropertyReference (Maybe Text) Source #

The name of the component.

entityPropertyReference_entityId :: Lens' EntityPropertyReference (Maybe Text) Source #

The ID of the entity.

entityPropertyReference_externalIdProperty :: Lens' EntityPropertyReference (Maybe (HashMap Text Text)) Source #

A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

entityPropertyReference_propertyName :: Lens' EntityPropertyReference Text Source #

The name of the property.

EntitySummary

entitySummary_description :: Lens' EntitySummary (Maybe Text) Source #

The description of the entity.

entitySummary_hasChildEntities :: Lens' EntitySummary (Maybe Bool) Source #

A Boolean value that specifies whether the entity has child entities or not.

entitySummary_parentEntityId :: Lens' EntitySummary (Maybe Text) Source #

The ID of the parent entity.

entitySummary_entityId :: Lens' EntitySummary Text Source #

The ID of the entity.

entitySummary_entityName :: Lens' EntitySummary Text Source #

The name of the entity.

entitySummary_arn :: Lens' EntitySummary Text Source #

The ARN of the entity.

entitySummary_status :: Lens' EntitySummary Status Source #

The current status of the entity.

entitySummary_creationDateTime :: Lens' EntitySummary UTCTime Source #

The date and time when the entity was created.

entitySummary_updateDateTime :: Lens' EntitySummary UTCTime Source #

The last date and time when the entity was updated.

ErrorDetails

errorDetails_code :: Lens' ErrorDetails (Maybe ErrorCode) Source #

The error code.

errorDetails_message :: Lens' ErrorDetails (Maybe Text) Source #

The error message.

FunctionRequest

functionRequest_implementedBy :: Lens' FunctionRequest (Maybe DataConnector) Source #

The data connector.

functionRequest_requiredProperties :: Lens' FunctionRequest (Maybe [Text]) Source #

The required properties of the function.

functionRequest_scope :: Lens' FunctionRequest (Maybe Scope) Source #

The scope of the function.

FunctionResponse

functionResponse_implementedBy :: Lens' FunctionResponse (Maybe DataConnector) Source #

The data connector.

functionResponse_isInherited :: Lens' FunctionResponse (Maybe Bool) Source #

Indicates whether this function is inherited.

functionResponse_requiredProperties :: Lens' FunctionResponse (Maybe [Text]) Source #

The required properties of the function.

functionResponse_scope :: Lens' FunctionResponse (Maybe Scope) Source #

The scope of the function.

InterpolationParameters

interpolationParameters_interpolationType :: Lens' InterpolationParameters (Maybe InterpolationType) Source #

The interpolation type.

interpolationParameters_intervalInSeconds :: Lens' InterpolationParameters (Maybe Integer) Source #

The interpolation time interval in seconds.

LambdaFunction

lambdaFunction_arn :: Lens' LambdaFunction Text Source #

The ARN of the Lambda function.

ListComponentTypesFilter

listComponentTypesFilter_extendsFrom :: Lens' ListComponentTypesFilter (Maybe Text) Source #

The component type that the component types in the list extend.

listComponentTypesFilter_isAbstract :: Lens' ListComponentTypesFilter (Maybe Bool) Source #

A Boolean value that specifies whether the component types in the list are abstract.

listComponentTypesFilter_namespace :: Lens' ListComponentTypesFilter (Maybe Text) Source #

The namespace to which the component types in the list belong.

ListEntitiesFilter

listEntitiesFilter_componentTypeId :: Lens' ListEntitiesFilter (Maybe Text) Source #

The ID of the component type in the entities in the list.

listEntitiesFilter_externalId :: Lens' ListEntitiesFilter (Maybe Text) Source #

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

listEntitiesFilter_parentEntityId :: Lens' ListEntitiesFilter (Maybe Text) Source #

The parent of the entities in the list.

OrderBy

orderBy_order :: Lens' OrderBy (Maybe Order) Source #

The set order that filters results.

orderBy_propertyName :: Lens' OrderBy Text Source #

The property name.

ParentEntityUpdateRequest

parentEntityUpdateRequest_parentEntityId :: Lens' ParentEntityUpdateRequest (Maybe Text) Source #

The ID of the parent entity.

parentEntityUpdateRequest_updateType :: Lens' ParentEntityUpdateRequest ParentEntityUpdateType Source #

The type of the update.

PricingPlan

pricingPlan_billableEntityCount :: Lens' PricingPlan (Maybe Integer) Source #

The billable entity count.

pricingPlan_bundleInformation :: Lens' PricingPlan (Maybe BundleInformation) Source #

The pricing plan's bundle information.

pricingPlan_effectiveDateTime :: Lens' PricingPlan UTCTime Source #

The effective date and time of the pricing plan.

pricingPlan_pricingMode :: Lens' PricingPlan PricingMode Source #

The pricing mode.

pricingPlan_updateDateTime :: Lens' PricingPlan UTCTime Source #

The set date and time for updating a pricing plan.

pricingPlan_updateReason :: Lens' PricingPlan UpdateReason Source #

The update reason, for changing a pricing plan.

PropertyDefinitionRequest

propertyDefinitionRequest_configuration :: Lens' PropertyDefinitionRequest (Maybe (HashMap Text Text)) Source #

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.

propertyDefinitionRequest_dataType :: Lens' PropertyDefinitionRequest (Maybe DataType) Source #

An object that contains information about the data type.

propertyDefinitionRequest_defaultValue :: Lens' PropertyDefinitionRequest (Maybe DataValue) Source #

An object that contains the default value.

propertyDefinitionRequest_displayName :: Lens' PropertyDefinitionRequest (Maybe Text) Source #

A friendly name for the property.

propertyDefinitionRequest_isExternalId :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

A Boolean value that specifies whether the property ID comes from an external data store.

propertyDefinitionRequest_isRequiredInEntity :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

A Boolean value that specifies whether the property is required.

propertyDefinitionRequest_isStoredExternally :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

A Boolean value that specifies whether the property is stored externally.

propertyDefinitionRequest_isTimeSeries :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

A Boolean value that specifies whether the property consists of time series data.

PropertyDefinitionResponse

propertyDefinitionResponse_configuration :: Lens' PropertyDefinitionResponse (Maybe (HashMap Text Text)) Source #

A mapping that specifies configuration information about the property.

propertyDefinitionResponse_defaultValue :: Lens' PropertyDefinitionResponse (Maybe DataValue) Source #

An object that contains the default value.

propertyDefinitionResponse_displayName :: Lens' PropertyDefinitionResponse (Maybe Text) Source #

A friendly name for the property.

propertyDefinitionResponse_dataType :: Lens' PropertyDefinitionResponse DataType Source #

An object that contains information about the data type.

propertyDefinitionResponse_isTimeSeries :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property consists of time series data.

propertyDefinitionResponse_isRequiredInEntity :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property is required in an entity.

propertyDefinitionResponse_isExternalId :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property ID comes from an external data store.

propertyDefinitionResponse_isStoredExternally :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property is stored externally.

propertyDefinitionResponse_isImported :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition is imported from an external data store.

propertyDefinitionResponse_isFinal :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition can be updated.

propertyDefinitionResponse_isInherited :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition is inherited from a parent entity.

PropertyFilter

propertyFilter_operator :: Lens' PropertyFilter (Maybe Text) Source #

The operator associated with this property filter.

propertyFilter_propertyName :: Lens' PropertyFilter (Maybe Text) Source #

The property name associated with this property filter.

propertyFilter_value :: Lens' PropertyFilter (Maybe DataValue) Source #

The value associated with this property filter.

PropertyGroupRequest

propertyGroupRequest_groupType :: Lens' PropertyGroupRequest (Maybe GroupType) Source #

The group type.

propertyGroupRequest_propertyNames :: Lens' PropertyGroupRequest (Maybe [Text]) Source #

The names of properties.

PropertyGroupResponse

propertyGroupResponse_groupType :: Lens' PropertyGroupResponse GroupType Source #

The group types.

propertyGroupResponse_propertyNames :: Lens' PropertyGroupResponse [Text] Source #

The names of properties.

propertyGroupResponse_isInherited :: Lens' PropertyGroupResponse Bool Source #

A Boolean value that specifies whether the property group is inherited from a parent entity

PropertyLatestValue

propertyLatestValue_propertyValue :: Lens' PropertyLatestValue (Maybe DataValue) Source #

The value of the property.

propertyLatestValue_propertyReference :: Lens' PropertyLatestValue EntityPropertyReference Source #

An object that specifies information about a property.>

PropertyRequest

propertyRequest_definition :: Lens' PropertyRequest (Maybe PropertyDefinitionRequest) Source #

An object that specifies information about a property.

propertyRequest_updateType :: Lens' PropertyRequest (Maybe PropertyUpdateType) Source #

The update type of the update property request.

propertyRequest_value :: Lens' PropertyRequest (Maybe DataValue) Source #

The value of the property.

PropertyResponse

propertyResponse_definition :: Lens' PropertyResponse (Maybe PropertyDefinitionResponse) Source #

An object that specifies information about a property.

propertyResponse_value :: Lens' PropertyResponse (Maybe DataValue) Source #

The value of the property.

PropertyValue

propertyValue_time :: Lens' PropertyValue (Maybe Text) Source #

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]

propertyValue_timestamp :: Lens' PropertyValue (Maybe UTCTime) Source #

The timestamp of a value for a time series property.

propertyValue_value :: Lens' PropertyValue DataValue Source #

An object that specifies a value for a time series property.

PropertyValueEntry

propertyValueEntry_propertyValues :: Lens' PropertyValueEntry (Maybe (NonEmpty PropertyValue)) Source #

A list of objects that specify time series property values.

propertyValueEntry_entityPropertyReference :: Lens' PropertyValueEntry EntityPropertyReference Source #

An object that contains information about the entity that has the property.

PropertyValueHistory

propertyValueHistory_values :: Lens' PropertyValueHistory (Maybe [PropertyValue]) Source #

A list of objects that contain information about the values in the history of a time series property.

propertyValueHistory_entityPropertyReference :: Lens' PropertyValueHistory EntityPropertyReference Source #

An object that uniquely identifies an entity property.

QueryResultValue

Relationship

relationship_relationshipType :: Lens' Relationship (Maybe Text) Source #

The type of the relationship.

relationship_targetComponentTypeId :: Lens' Relationship (Maybe Text) Source #

The ID of the target component type associated with this relationship.

RelationshipValue

relationshipValue_targetComponentName :: Lens' RelationshipValue (Maybe Text) Source #

The name of the target component associated with the relationship value.

relationshipValue_targetEntityId :: Lens' RelationshipValue (Maybe Text) Source #

The ID of the target entity associated with this relationship value.

Row

row_rowData :: Lens' Row (Maybe [QueryResultValue]) Source #

The data in a row of query results.

SceneSummary

sceneSummary_description :: Lens' SceneSummary (Maybe Text) Source #

The scene description.

sceneSummary_sceneId :: Lens' SceneSummary Text Source #

The ID of the scene.

sceneSummary_contentLocation :: Lens' SceneSummary Text Source #

The relative path that specifies the location of the content definition file.

sceneSummary_arn :: Lens' SceneSummary Text Source #

The ARN of the scene.

sceneSummary_creationDateTime :: Lens' SceneSummary UTCTime Source #

The date and time when the scene was created.

sceneSummary_updateDateTime :: Lens' SceneSummary UTCTime Source #

The date and time when the scene was last updated.

Status

status_error :: Lens' Status (Maybe ErrorDetails) Source #

The error message.

status_state :: Lens' Status (Maybe State) Source #

The current state of the entity, component, component type, or workspace.

SyncJobStatus

syncJobStatus_error :: Lens' SyncJobStatus (Maybe ErrorDetails) Source #

The SyncJob error.

syncJobStatus_state :: Lens' SyncJobStatus (Maybe SyncJobState) Source #

The SyncJob status state.

SyncJobSummary

syncJobSummary_arn :: Lens' SyncJobSummary (Maybe Text) Source #

The SyncJob summary ARN.

syncJobSummary_creationDateTime :: Lens' SyncJobSummary (Maybe UTCTime) Source #

The creation date and time.

syncJobSummary_status :: Lens' SyncJobSummary (Maybe SyncJobStatus) Source #

The SyncJob summaries status.

syncJobSummary_syncSource :: Lens' SyncJobSummary (Maybe Text) Source #

The sync source.

syncJobSummary_updateDateTime :: Lens' SyncJobSummary (Maybe UTCTime) Source #

The update date and time.

syncJobSummary_workspaceId :: Lens' SyncJobSummary (Maybe Text) Source #

The ID of the workspace that contains the sync job.

SyncResourceFilter

syncResourceFilter_externalId :: Lens' SyncResourceFilter (Maybe Text) Source #

The external Id.

syncResourceFilter_resourceId :: Lens' SyncResourceFilter (Maybe Text) Source #

The sync resource filter resource Id.

syncResourceFilter_resourceType :: Lens' SyncResourceFilter (Maybe SyncResourceType) Source #

The sync resource filter resoucre type

syncResourceFilter_state :: Lens' SyncResourceFilter (Maybe SyncResourceState) Source #

The sync resource filter's state.

SyncResourceStatus

syncResourceStatus_error :: Lens' SyncResourceStatus (Maybe ErrorDetails) Source #

The status error.

syncResourceStatus_state :: Lens' SyncResourceStatus (Maybe SyncResourceState) Source #

The sync resource status state.

SyncResourceSummary

syncResourceSummary_externalId :: Lens' SyncResourceSummary (Maybe Text) Source #

The external Id.

syncResourceSummary_resourceId :: Lens' SyncResourceSummary (Maybe Text) Source #

The resource Id.

syncResourceSummary_resourceType :: Lens' SyncResourceSummary (Maybe SyncResourceType) Source #

The resource type.

syncResourceSummary_status :: Lens' SyncResourceSummary (Maybe SyncResourceStatus) Source #

The sync resource summary status.

syncResourceSummary_updateDateTime :: Lens' SyncResourceSummary (Maybe UTCTime) Source #

The update date and time.

TabularConditions

tabularConditions_orderBy :: Lens' TabularConditions (Maybe (NonEmpty OrderBy)) Source #

Filter criteria that orders the output. It can be sorted in ascending or descending order.

tabularConditions_propertyFilters :: Lens' TabularConditions (Maybe (NonEmpty PropertyFilter)) Source #

You can filter the request using various logical operators and a key-value format. For example:

{"key": "serverType", "value": "webServer"}

WorkspaceSummary

workspaceSummary_description :: Lens' WorkspaceSummary (Maybe Text) Source #

The description of the workspace.

workspaceSummary_workspaceId :: Lens' WorkspaceSummary Text Source #

The ID of the workspace.

workspaceSummary_arn :: Lens' WorkspaceSummary Text Source #

The ARN of the workspace.

workspaceSummary_creationDateTime :: Lens' WorkspaceSummary UTCTime Source #

The date and time when the workspace was created.

workspaceSummary_updateDateTime :: Lens' WorkspaceSummary UTCTime Source #

The date and time when the workspace was last updated.