Sets values for multiple time series properties.
", "endpoint":{"hostPrefix":"data."} }, "CancelMetadataTransferJob":{ "name":"CancelMetadataTransferJob", "http":{ "method":"PUT", "requestUri":"/metadata-transfer-jobs/{metadataTransferJobId}/cancel", "responseCode":200 }, "input":{"shape":"CancelMetadataTransferJobRequest"}, "output":{"shape":"CancelMetadataTransferJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"Cancels the metadata transfer job.
", "endpoint":{"hostPrefix":"api."} }, "CreateComponentType":{ "name":"CreateComponentType", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", "responseCode":200 }, "input":{"shape":"CreateComponentTypeRequest"}, "output":{"shape":"CreateComponentTypeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a component type.
", "endpoint":{"hostPrefix":"api."} }, "CreateEntity":{ "name":"CreateEntity", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/entities", "responseCode":200 }, "input":{"shape":"CreateEntityRequest"}, "output":{"shape":"CreateEntityResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates an entity.
", "endpoint":{"hostPrefix":"api."} }, "CreateMetadataTransferJob":{ "name":"CreateMetadataTransferJob", "http":{ "method":"POST", "requestUri":"/metadata-transfer-jobs", "responseCode":200 }, "input":{"shape":"CreateMetadataTransferJobRequest"}, "output":{"shape":"CreateMetadataTransferJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a new metadata transfer job.
", "endpoint":{"hostPrefix":"api."} }, "CreateScene":{ "name":"CreateScene", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/scenes", "responseCode":200 }, "input":{"shape":"CreateSceneRequest"}, "output":{"shape":"CreateSceneResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a scene.
", "endpoint":{"hostPrefix":"api."} }, "CreateSyncJob":{ "name":"CreateSyncJob", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}", "responseCode":200 }, "input":{"shape":"CreateSyncJobRequest"}, "output":{"shape":"CreateSyncJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"This action creates a SyncJob.
", "endpoint":{"hostPrefix":"api."} }, "CreateWorkspace":{ "name":"CreateWorkspace", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}", "responseCode":200 }, "input":{"shape":"CreateWorkspaceRequest"}, "output":{"shape":"CreateWorkspaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a workplace.
", "endpoint":{"hostPrefix":"api."} }, "DeleteComponentType":{ "name":"DeleteComponentType", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", "responseCode":200 }, "input":{"shape":"DeleteComponentTypeRequest"}, "output":{"shape":"DeleteComponentTypeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Deletes a component type.
", "endpoint":{"hostPrefix":"api."} }, "DeleteEntity":{ "name":"DeleteEntity", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", "responseCode":200 }, "input":{"shape":"DeleteEntityRequest"}, "output":{"shape":"DeleteEntityResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Deletes an entity.
", "endpoint":{"hostPrefix":"api."} }, "DeleteScene":{ "name":"DeleteScene", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/scenes/{sceneId}", "responseCode":200 }, "input":{"shape":"DeleteSceneRequest"}, "output":{"shape":"DeleteSceneResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Deletes a scene.
", "endpoint":{"hostPrefix":"api."} }, "DeleteSyncJob":{ "name":"DeleteSyncJob", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}", "responseCode":200 }, "input":{"shape":"DeleteSyncJobRequest"}, "output":{"shape":"DeleteSyncJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Delete the SyncJob.
", "endpoint":{"hostPrefix":"api."} }, "DeleteWorkspace":{ "name":"DeleteWorkspace", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}", "responseCode":200 }, "input":{"shape":"DeleteWorkspaceRequest"}, "output":{"shape":"DeleteWorkspaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Deletes a workspace.
", "endpoint":{"hostPrefix":"api."} }, "ExecuteQuery":{ "name":"ExecuteQuery", "http":{ "method":"POST", "requestUri":"/queries/execution", "responseCode":200 }, "input":{"shape":"ExecuteQueryRequest"}, "output":{"shape":"ExecuteQueryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"QueryTimeoutException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Run queries to access information from your knowledge graph of entities within individual workspaces.
The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.
Retrieves information about a component type.
", "endpoint":{"hostPrefix":"api."} }, "GetEntity":{ "name":"GetEntity", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", "responseCode":200 }, "input":{"shape":"GetEntityRequest"}, "output":{"shape":"GetEntityResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Retrieves information about an entity.
", "endpoint":{"hostPrefix":"api."} }, "GetMetadataTransferJob":{ "name":"GetMetadataTransferJob", "http":{ "method":"GET", "requestUri":"/metadata-transfer-jobs/{metadataTransferJobId}", "responseCode":200 }, "input":{"shape":"GetMetadataTransferJobRequest"}, "output":{"shape":"GetMetadataTransferJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Gets a nmetadata transfer job.
", "endpoint":{"hostPrefix":"api."} }, "GetPricingPlan":{ "name":"GetPricingPlan", "http":{ "method":"GET", "requestUri":"/pricingplan", "responseCode":200 }, "input":{"shape":"GetPricingPlanRequest"}, "output":{"shape":"GetPricingPlanResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Gets the pricing plan.
", "endpoint":{"hostPrefix":"api."} }, "GetPropertyValue":{ "name":"GetPropertyValue", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/entity-properties/value", "responseCode":200 }, "input":{"shape":"GetPropertyValueRequest"}, "output":{"shape":"GetPropertyValueResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConnectorFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConnectorTimeoutException"} ], "documentation":"Gets the property values for a component, component type, entity, or workspace.
You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.
Retrieves information about a scene.
", "endpoint":{"hostPrefix":"api."} }, "GetSyncJob":{ "name":"GetSyncJob", "http":{ "method":"GET", "requestUri":"/sync-jobs/{syncSource}", "responseCode":200 }, "input":{"shape":"GetSyncJobRequest"}, "output":{"shape":"GetSyncJobResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Gets the SyncJob.
", "endpoint":{"hostPrefix":"api."} }, "GetWorkspace":{ "name":"GetWorkspace", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}", "responseCode":200 }, "input":{"shape":"GetWorkspaceRequest"}, "output":{"shape":"GetWorkspaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Retrieves information about a workspace.
", "endpoint":{"hostPrefix":"api."} }, "ListComponentTypes":{ "name":"ListComponentTypes", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/component-types-list", "responseCode":200 }, "input":{"shape":"ListComponentTypesRequest"}, "output":{"shape":"ListComponentTypesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Lists all component types in a workspace.
", "endpoint":{"hostPrefix":"api."} }, "ListComponents":{ "name":"ListComponents", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/entities/{entityId}/components-list", "responseCode":200 }, "input":{"shape":"ListComponentsRequest"}, "output":{"shape":"ListComponentsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"This API lists the components of an entity.
", "endpoint":{"hostPrefix":"api."} }, "ListEntities":{ "name":"ListEntities", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/entities-list", "responseCode":200 }, "input":{"shape":"ListEntitiesRequest"}, "output":{"shape":"ListEntitiesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Lists all entities in a workspace.
", "endpoint":{"hostPrefix":"api."} }, "ListMetadataTransferJobs":{ "name":"ListMetadataTransferJobs", "http":{ "method":"POST", "requestUri":"/metadata-transfer-jobs-list", "responseCode":200 }, "input":{"shape":"ListMetadataTransferJobsRequest"}, "output":{"shape":"ListMetadataTransferJobsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Lists the metadata transfer jobs.
", "endpoint":{"hostPrefix":"api."} }, "ListProperties":{ "name":"ListProperties", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/properties-list", "responseCode":200 }, "input":{"shape":"ListPropertiesRequest"}, "output":{"shape":"ListPropertiesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"This API lists the properties of a component.
", "endpoint":{"hostPrefix":"api."} }, "ListScenes":{ "name":"ListScenes", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/scenes-list", "responseCode":200 }, "input":{"shape":"ListScenesRequest"}, "output":{"shape":"ListScenesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Lists all scenes in a workspace.
", "endpoint":{"hostPrefix":"api."} }, "ListSyncJobs":{ "name":"ListSyncJobs", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/sync-jobs-list", "responseCode":200 }, "input":{"shape":"ListSyncJobsRequest"}, "output":{"shape":"ListSyncJobsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"List all SyncJobs.
", "endpoint":{"hostPrefix":"api."} }, "ListSyncResources":{ "name":"ListSyncResources", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/sync-jobs/{syncSource}/resources-list", "responseCode":200 }, "input":{"shape":"ListSyncResourcesRequest"}, "output":{"shape":"ListSyncResourcesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Lists the sync resources.
", "endpoint":{"hostPrefix":"api."} }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/tags-list", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists all tags associated with a resource.
", "endpoint":{"hostPrefix":"api."} }, "ListWorkspaces":{ "name":"ListWorkspaces", "http":{ "method":"POST", "requestUri":"/workspaces-list", "responseCode":200 }, "input":{"shape":"ListWorkspacesRequest"}, "output":{"shape":"ListWorkspacesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Retrieves information about workspaces in the current account.
", "endpoint":{"hostPrefix":"api."} }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"TooManyTagsException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Adds tags to a resource.
", "endpoint":{"hostPrefix":"api."} }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes tags from a resource.
", "endpoint":{"hostPrefix":"api."} }, "UpdateComponentType":{ "name":"UpdateComponentType", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", "responseCode":200 }, "input":{"shape":"UpdateComponentTypeRequest"}, "output":{"shape":"UpdateComponentTypeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Updates information in a component type.
", "endpoint":{"hostPrefix":"api."} }, "UpdateEntity":{ "name":"UpdateEntity", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}/entities/{entityId}", "responseCode":200 }, "input":{"shape":"UpdateEntityRequest"}, "output":{"shape":"UpdateEntityResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Updates an entity.
", "endpoint":{"hostPrefix":"api."} }, "UpdatePricingPlan":{ "name":"UpdatePricingPlan", "http":{ "method":"POST", "requestUri":"/pricingplan", "responseCode":200 }, "input":{"shape":"UpdatePricingPlanRequest"}, "output":{"shape":"UpdatePricingPlanResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Update the pricing plan.
", "endpoint":{"hostPrefix":"api."} }, "UpdateScene":{ "name":"UpdateScene", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}/scenes/{sceneId}", "responseCode":200 }, "input":{"shape":"UpdateSceneRequest"}, "output":{"shape":"UpdateSceneResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"Updates a scene.
", "endpoint":{"hostPrefix":"api."} }, "UpdateWorkspace":{ "name":"UpdateWorkspace", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}", "responseCode":200 }, "input":{"shape":"UpdateWorkspaceRequest"}, "output":{"shape":"UpdateWorkspaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Updates a workspace.
", "endpoint":{"hostPrefix":"api."} } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Access is denied.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "BatchPutPropertyError":{ "type":"structure", "required":[ "errorCode", "errorMessage", "entry" ], "members":{ "errorCode":{ "shape":"String", "documentation":"The error code.
" }, "errorMessage":{ "shape":"String", "documentation":"The error message.
" }, "entry":{ "shape":"PropertyValueEntry", "documentation":"An object that contains information about errors returned by the BatchPutProperty action.
An error returned by the BatchPutProperty action.
A list of objects that contain information about errors returned by the BatchPutProperty action.
An object that contains information about errors returned by the BatchPutProperty action.
The ID of the workspace that contains the properties to set.
", "location":"uri", "locationName":"workspaceId" }, "entries":{ "shape":"Entries", "documentation":"An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
" } } }, "BatchPutPropertyValuesResponse":{ "type":"structure", "required":["errorEntries"], "members":{ "errorEntries":{ "shape":"ErrorEntries", "documentation":"Entries that caused errors in the batch put operation.
" } } }, "Boolean":{ "type":"boolean", "box":true }, "BundleInformation":{ "type":"structure", "required":["bundleNames"], "members":{ "bundleNames":{ "shape":"PricingBundles", "documentation":"The bundle names.
" }, "pricingTier":{ "shape":"PricingTier", "documentation":"The pricing tier.
" } }, "documentation":"Information about the pricing bundle.
" }, "BundleName":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "CancelMetadataTransferJobRequest":{ "type":"structure", "required":["metadataTransferJobId"], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
", "location":"uri", "locationName":"metadataTransferJobId" } } }, "CancelMetadataTransferJobResponse":{ "type":"structure", "required":[ "metadataTransferJobId", "arn", "updateDateTime", "status" ], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The metadata transfer job ARN.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"Used to update the DateTime property.
" }, "status":{ "shape":"MetadataTransferJobStatus", "documentation":"The metadata transfer job's status.
" }, "progress":{ "shape":"MetadataTransferJobProgress", "documentation":"The metadata transfer job's progress.
" } } }, "ColumnDescription":{ "type":"structure", "members":{ "name":{ "shape":"ColumnName", "documentation":"The name of the column description.
" }, "type":{ "shape":"ColumnType", "documentation":"The type of the column description.
" } }, "documentation":"A description of the column in the query results.
" }, "ColumnDescriptions":{ "type":"list", "member":{"shape":"ColumnDescription"} }, "ColumnName":{ "type":"string", "pattern":".*" }, "ColumnType":{ "type":"string", "enum":[ "NODE", "EDGE", "VALUE" ] }, "ComponentPath":{ "type":"string", "max":2048, "min":1, "pattern":"[a-zA-Z_\\-0-9/]+" }, "ComponentPropertyGroupRequest":{ "type":"structure", "members":{ "groupType":{ "shape":"GroupType", "documentation":"The group type.
" }, "propertyNames":{ "shape":"PropertyNames", "documentation":"The property names.
" }, "updateType":{ "shape":"PropertyGroupUpdateType", "documentation":"The update type.
" } }, "documentation":"The component property group request.
" }, "ComponentPropertyGroupRequests":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentPropertyGroupRequest"} }, "ComponentPropertyGroupResponse":{ "type":"structure", "required":[ "groupType", "propertyNames", "isInherited" ], "members":{ "groupType":{ "shape":"GroupType", "documentation":"The group type.
" }, "propertyNames":{ "shape":"PropertyNames", "documentation":"The names of properties
" }, "isInherited":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property group is inherited from a parent entity
" } }, "documentation":"The component property group response.
" }, "ComponentPropertyGroupResponses":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentPropertyGroupResponse"} }, "ComponentRequest":{ "type":"structure", "members":{ "description":{ "shape":"Description", "documentation":"The description of the component request.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "properties":{ "shape":"PropertyRequests", "documentation":"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.
" }, "propertyGroups":{ "shape":"ComponentPropertyGroupRequests", "documentation":"The property groups.
" } }, "documentation":"An object that sets information about a component type create or update request.
" }, "ComponentResponse":{ "type":"structure", "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "status":{ "shape":"Status", "documentation":"The status of the component type.
" }, "definedIn":{ "shape":"String", "documentation":"The name of the property definition set in the request.
" }, "properties":{ "shape":"PropertyResponses", "documentation":"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.
" }, "propertyGroups":{ "shape":"ComponentPropertyGroupResponses", "documentation":"The property groups.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The syncSource of the sync job, if this entity was created by a sync job.
" }, "areAllPropertiesReturned":{ "shape":"Boolean", "documentation":"This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
" }, "compositeComponents":{ "shape":"CompositeComponentResponse", "documentation":"This lists objects that contain information about the compositeComponents.
This flag notes whether all compositeComponents are returned in the API response.
An object that returns information about a component type create or update request.
" }, "ComponentSummaries":{ "type":"list", "member":{"shape":"ComponentSummary"} }, "ComponentSummary":{ "type":"structure", "required":[ "componentName", "componentTypeId", "status" ], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "definedIn":{ "shape":"String", "documentation":"The name of the property definition set in the request.
" }, "description":{ "shape":"Description", "documentation":"The description of the component request.
" }, "propertyGroups":{ "shape":"ComponentPropertyGroupResponses", "documentation":"The property groups.
" }, "status":{ "shape":"Status", "documentation":"The status of the component type.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The syncSource of the sync job, if this entity was created by a sync job.
This string specifies the path to the composite component, starting from the top-level component.
" } }, "documentation":"An object that returns information about a component summary.
" }, "ComponentTypeId":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z_\\.\\-0-9:]+" }, "ComponentTypeName":{ "type":"string", "max":256, "min":0, "pattern":".*[^\\u0000-\\u001F\\u007F]*.*" }, "ComponentTypeSummaries":{ "type":"list", "member":{"shape":"ComponentTypeSummary"} }, "ComponentTypeSummary":{ "type":"structure", "required":[ "arn", "componentTypeId", "creationDateTime", "updateDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the component type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component type was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component type was last updated.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "status":{ "shape":"Status", "documentation":"The current status of the component type.
" }, "componentTypeName":{ "shape":"ComponentTypeName", "documentation":"The component type name.
" } }, "documentation":"An object that contains information about a component type.
" }, "ComponentUpdateRequest":{ "type":"structure", "members":{ "updateType":{ "shape":"ComponentUpdateType", "documentation":"The update type of the component update request.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "propertyUpdates":{ "shape":"PropertyRequests", "documentation":"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.
" }, "propertyGroupUpdates":{ "shape":"ComponentPropertyGroupRequests", "documentation":"The property group updates.
" } }, "documentation":"The component update request.
" }, "ComponentUpdateType":{ "type":"string", "enum":[ "CREATE", "UPDATE", "DELETE" ] }, "ComponentUpdatesMapRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentUpdateRequest"} }, "ComponentsMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentResponse"} }, "ComponentsMapRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentRequest"} }, "CompositeComponentRequest":{ "type":"structure", "members":{ "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "properties":{ "shape":"PropertyRequests", "documentation":"This is 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.
" }, "propertyGroups":{ "shape":"ComponentPropertyGroupRequests", "documentation":"The property groups.
" } }, "documentation":"An object that sets information about the composite component update request.
" }, "CompositeComponentResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"ComponentSummary"} }, "CompositeComponentTypeRequest":{ "type":"structure", "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"This is the componentTypeId that the compositeComponentType refers to.
An object that sets information about the composite component types of a component type.
" }, "CompositeComponentTypeResponse":{ "type":"structure", "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"This is the componentTypeId that this compositeComponentType refers to.
This boolean indicates whether this compositeComponentType is inherited from its parent.
An object that returns information about the composite component types of a component type.
" }, "CompositeComponentTypesRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"CompositeComponentTypeRequest"} }, "CompositeComponentTypesResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"CompositeComponentTypeResponse"} }, "CompositeComponentUpdateRequest":{ "type":"structure", "members":{ "updateType":{ "shape":"ComponentUpdateType", "documentation":"The update type of the component update request.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "propertyUpdates":{ "shape":"PropertyRequests", "documentation":"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.
" }, "propertyGroupUpdates":{ "shape":"ComponentPropertyGroupRequests", "documentation":"The property group updates.
" } }, "documentation":"An object that sets information about the composite component update request.
" }, "CompositeComponentUpdatesMapRequest":{ "type":"map", "key":{"shape":"ComponentPath"}, "value":{"shape":"CompositeComponentUpdateRequest"} }, "CompositeComponentsMapRequest":{ "type":"map", "key":{"shape":"ComponentPath"}, "value":{"shape":"CompositeComponentRequest"} }, "Configuration":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"Value"} }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"A conflict occurred.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ConnectorFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The connector failed.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "ConnectorTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The connector timed out.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "CreateComponentTypeRequest":{ "type":"structure", "required":[ "workspaceId", "componentTypeId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "propertyDefinitions":{ "shape":"PropertyDefinitionsRequest", "documentation":"An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" }, "extendsFrom":{ "shape":"ExtendsFrom", "documentation":"Specifies the parent component type to extend.
" }, "functions":{ "shape":"FunctionsRequest", "documentation":"An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the component type.
" }, "propertyGroups":{ "shape":"PropertyGroupsRequest", "documentation":"" }, "componentTypeName":{ "shape":"ComponentTypeName", "documentation":"A friendly name for the component type.
" }, "compositeComponentTypes":{ "shape":"CompositeComponentTypesRequest", "documentation":"This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
The ARN of the component type.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "state":{ "shape":"State", "documentation":"The current state of the component type.
" } } }, "CreateEntityRequest":{ "type":"structure", "required":[ "workspaceId", "entityName" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "components":{ "shape":"ComponentsMapRequest", "documentation":"An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
" }, "compositeComponents":{ "shape":"CompositeComponentsMapRequest", "documentation":"This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
The ID of the entity's parent entity.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the entity.
" } } }, "CreateEntityResponse":{ "type":"structure", "required":[ "entityId", "arn", "creationDateTime", "state" ], "members":{ "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the entity.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "state":{ "shape":"State", "documentation":"The current state of the entity.
" } } }, "CreateMetadataTransferJobRequest":{ "type":"structure", "required":[ "sources", "destination" ], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
" }, "description":{ "shape":"Description", "documentation":"The metadata transfer job description.
" }, "sources":{ "shape":"SourceConfigurations", "documentation":"The metadata transfer job sources.
" }, "destination":{ "shape":"DestinationConfiguration", "documentation":"The metadata transfer job destination.
" } } }, "CreateMetadataTransferJobResponse":{ "type":"structure", "required":[ "metadataTransferJobId", "arn", "creationDateTime", "status" ], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The metadata transfer job ARN.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The The metadata transfer job creation DateTime property.
" }, "status":{ "shape":"MetadataTransferJobStatus", "documentation":"The metadata transfer job response status.
" } } }, "CreateSceneRequest":{ "type":"structure", "required":[ "workspaceId", "sceneId", "contentLocation" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "description":{ "shape":"Description", "documentation":"The description for this scene.
" }, "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render itself.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the scene.
" }, "sceneMetadata":{ "shape":"SceneMetadataMap", "documentation":"The request metadata.
" } } }, "CreateSceneResponse":{ "type":"structure", "required":[ "arn", "creationDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the scene.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was created.
" } } }, "CreateSyncJobRequest":{ "type":"structure", "required":[ "workspaceId", "syncSource", "syncRole" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The workspace ID.
", "location":"uri", "locationName":"workspaceId" }, "syncSource":{ "shape":"SyncSource", "documentation":"The sync source.
Currently the only supported syncSoource is SITEWISE .
The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.
" }, "tags":{ "shape":"TagMap", "documentation":"The SyncJob tags.
" } } }, "CreateSyncJobResponse":{ "type":"structure", "required":[ "arn", "creationDateTime", "state" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The SyncJob ARN.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time for the SyncJob creation.
" }, "state":{ "shape":"SyncJobState", "documentation":"The SyncJob response state.
" } } }, "CreateWorkspaceRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "s3Location":{ "shape":"S3Location", "documentation":"The ARN of the S3 bucket where resources associated with the workspace are stored.
" }, "role":{ "shape":"RoleArn", "documentation":"The ARN of the execution role associated with the workspace.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the workspace
" } } }, "CreateWorkspaceResponse":{ "type":"structure", "required":[ "arn", "creationDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the workspace.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was created.
" } } }, "DataConnector":{ "type":"structure", "members":{ "lambda":{ "shape":"LambdaFunction", "documentation":"The Lambda function associated with this data connector.
" }, "isNative":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
" } }, "documentation":"The data connector.
" }, "DataType":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"Type", "documentation":"The underlying type of the data type.
" }, "nestedType":{ "shape":"DataType", "documentation":"The nested type in the data type.
" }, "allowedValues":{ "shape":"DataValueList", "documentation":"The allowed values for this data type.
" }, "unitOfMeasure":{ "shape":"String", "documentation":"The unit of measure used in this data type.
" }, "relationship":{ "shape":"Relationship", "documentation":"A relationship that associates a component with another component.
" } }, "documentation":"An object that specifies the data type of a property.
" }, "DataValue":{ "type":"structure", "members":{ "booleanValue":{ "shape":"Boolean", "documentation":"A Boolean value.
" }, "doubleValue":{ "shape":"Double", "documentation":"A double value.
" }, "integerValue":{ "shape":"Integer", "documentation":"An integer value.
" }, "longValue":{ "shape":"Long", "documentation":"A long value.
" }, "stringValue":{ "shape":"String", "documentation":"A string value.
" }, "listValue":{ "shape":"DataValueList", "documentation":"A list of multiple values.
" }, "mapValue":{ "shape":"DataValueMap", "documentation":"An object that maps strings to multiple DataValue objects.
A value that relates a component to another component.
" }, "expression":{ "shape":"Expression", "documentation":"An expression that produces the value.
" } }, "documentation":"An object that specifies a value for a property.
" }, "DataValueList":{ "type":"list", "member":{"shape":"DataValue"}, "max":50, "min":0 }, "DataValueMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"DataValue"}, "max":50, "min":0 }, "DeleteComponentTypeRequest":{ "type":"structure", "required":[ "workspaceId", "componentTypeId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type to delete.
", "location":"uri", "locationName":"componentTypeId" } } }, "DeleteComponentTypeResponse":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"State", "documentation":"The current state of the component type to be deleted.
" } } }, "DeleteEntityRequest":{ "type":"structure", "required":[ "workspaceId", "entityId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity to delete.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity to delete.
", "location":"uri", "locationName":"entityId" }, "isRecursive":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the operation deletes child entities.
", "location":"querystring", "locationName":"isRecursive" } } }, "DeleteEntityResponse":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"State", "documentation":"The current state of the deleted entity.
" } } }, "DeleteSceneRequest":{ "type":"structure", "required":[ "workspaceId", "sceneId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene to delete.
", "location":"uri", "locationName":"sceneId" } } }, "DeleteSceneResponse":{ "type":"structure", "members":{ } }, "DeleteSyncJobRequest":{ "type":"structure", "required":[ "workspaceId", "syncSource" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The workspace ID.
", "location":"uri", "locationName":"workspaceId" }, "syncSource":{ "shape":"SyncSource", "documentation":"The sync source.
Currently the only supported syncSource is SITEWISE .
The SyncJob response state.
" } } }, "DeleteWorkspaceRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace to delete.
", "location":"uri", "locationName":"workspaceId" } } }, "DeleteWorkspaceResponse":{ "type":"structure", "members":{ "message":{ "shape":"WorkspaceDeleteMessage", "documentation":"The string that specifies the delete result for the workspace.
" } } }, "Description":{ "type":"string", "max":2048, "min":0, "pattern":".*" }, "DestinationConfiguration":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"DestinationType", "documentation":"The destination type.
" }, "s3Configuration":{ "shape":"S3DestinationConfiguration", "documentation":"The metadata transfer job S3 configuration. [need to add S3 entity]
" }, "iotTwinMakerConfiguration":{ "shape":"IotTwinMakerDestinationConfiguration", "documentation":"The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
" } }, "documentation":"The [link to action] metadata transfer job destination configuration.
" }, "DestinationType":{ "type":"string", "enum":[ "s3", "iotsitewise", "iottwinmaker" ] }, "Double":{ "type":"double", "box":true }, "EntityId":{ "type":"string", "max":128, "min":1, "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+" }, "EntityName":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "EntityPropertyReference":{ "type":"structure", "required":["propertyName"], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "componentPath":{ "shape":"ComponentPath", "documentation":"This string specifies the path to the composite component, starting from the top-level component.
" }, "externalIdProperty":{ "shape":"ExternalIdProperty", "documentation":"A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "propertyName":{ "shape":"Name", "documentation":"The name of the property.
" } }, "documentation":"An object that uniquely identifies an entity property.
" }, "EntitySummaries":{ "type":"list", "member":{"shape":"EntitySummary"} }, "EntitySummary":{ "type":"structure", "required":[ "entityId", "entityName", "arn", "status", "creationDateTime", "updateDateTime" ], "members":{ "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the entity.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity.
" }, "status":{ "shape":"Status", "documentation":"The current status of the entity.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "hasChildEntities":{ "shape":"Boolean", "documentation":"An eventual Boolean value that specifies whether the entity has child entities or not.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The last date and time when the entity was updated.
" } }, "documentation":"An object that contains information about an entity.
" }, "Entries":{ "type":"list", "member":{"shape":"PropertyValueEntry"}, "max":10, "min":1 }, "ErrorCode":{ "type":"string", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" ] }, "ErrorDetails":{ "type":"structure", "members":{ "code":{ "shape":"ErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"ErrorMessage", "documentation":"The error message.
" } }, "documentation":"The error details.
" }, "ErrorEntries":{ "type":"list", "member":{"shape":"BatchPutPropertyErrorEntry"}, "max":10, "min":1 }, "ErrorMessage":{ "type":"string", "max":2048, "min":0 }, "Errors":{ "type":"list", "member":{"shape":"BatchPutPropertyError"}, "max":10, "min":1 }, "ExceptionMessage":{"type":"string"}, "ExecuteQueryRequest":{ "type":"structure", "required":[ "workspaceId", "queryStatement" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" }, "queryStatement":{ "shape":"QueryStatement", "documentation":"The query statement.
" }, "maxResults":{ "shape":"QueryServiceMaxResults", "documentation":"The maximum number of results to return at one time. The default is 50.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ExecuteQueryResponse":{ "type":"structure", "members":{ "columnDescriptions":{ "shape":"ColumnDescriptions", "documentation":"A list of ColumnDescription objects.
" }, "rows":{ "shape":"Rows", "documentation":"Represents a single row in the query results.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "Expression":{ "type":"string", "max":316, "min":1, "pattern":"(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)" }, "ExtendsFrom":{ "type":"list", "member":{"shape":"ComponentTypeId"} }, "ExternalIdProperty":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "FilterByAsset":{ "type":"structure", "members":{ "assetId":{ "shape":"Uuid", "documentation":"Filter by asset Id.
" }, "assetExternalId":{ "shape":"SiteWiseExternalId", "documentation":"The external-Id property of an asset.
" }, "includeOffspring":{ "shape":"Boolean", "documentation":"Includes sub-assets.[need description hekp for this]
" }, "includeAssetModel":{ "shape":"Boolean", "documentation":"Boolean to include the asset model.
" } }, "documentation":"Filter by asset. [TwinMaker asset]
" }, "FilterByAssetModel":{ "type":"structure", "members":{ "assetModelId":{ "shape":"Uuid", "documentation":"The asset model Id.
" }, "assetModelExternalId":{ "shape":"SiteWiseExternalId", "documentation":"The external-Id property of an asset model.
" }, "includeOffspring":{ "shape":"Boolean", "documentation":"Include asset offspring. [need desc.]
" }, "includeAssets":{ "shape":"Boolean", "documentation":"Bolean to include assets.
" } }, "documentation":"Filter by asset model.
" }, "FilterByComponentType":{ "type":"structure", "required":["componentTypeId"], "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The component type Id.
" } }, "documentation":"Filter by component type.
" }, "FilterByEntity":{ "type":"structure", "required":["entityId"], "members":{ "entityId":{ "shape":"EntityId", "documentation":"The entity Id.
" } }, "documentation":"Vilter by entity.
" }, "FunctionRequest":{ "type":"structure", "members":{ "requiredProperties":{ "shape":"RequiredProperties", "documentation":"The required properties of the function.
" }, "scope":{ "shape":"Scope", "documentation":"The scope of the function.
" }, "implementedBy":{ "shape":"DataConnector", "documentation":"The data connector.
" } }, "documentation":"The function request body.
" }, "FunctionResponse":{ "type":"structure", "members":{ "requiredProperties":{ "shape":"RequiredProperties", "documentation":"The required properties of the function.
" }, "scope":{ "shape":"Scope", "documentation":"The scope of the function.
" }, "implementedBy":{ "shape":"DataConnector", "documentation":"The data connector.
" }, "isInherited":{ "shape":"Boolean", "documentation":"Indicates whether this function is inherited.
" } }, "documentation":"The function response.
" }, "FunctionsRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"FunctionRequest"} }, "FunctionsResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"FunctionResponse"} }, "GeneratedSceneMetadataMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"SceneMetadataValue"}, "max":50, "min":0 }, "GetComponentTypeRequest":{ "type":"structure", "required":[ "workspaceId", "componentTypeId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" } } }, "GetComponentTypeResponse":{ "type":"structure", "required":[ "workspaceId", "componentTypeId", "creationDateTime", "updateDateTime", "arn" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "propertyDefinitions":{ "shape":"PropertyDefinitionsResponse", "documentation":"An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" }, "extendsFrom":{ "shape":"ExtendsFrom", "documentation":"The name of the parent component type that this component type extends.
" }, "functions":{ "shape":"FunctionsResponse", "documentation":"An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component type was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component was last updated.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the component type.
" }, "isAbstract":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the component type is abstract.
" }, "isSchemaInitialized":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
" }, "status":{ "shape":"Status", "documentation":"The current status of the component type.
" }, "propertyGroups":{ "shape":"PropertyGroupsResponse", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The syncSource of the SyncJob, if this entity was created by a SyncJob.
" }, "componentTypeName":{ "shape":"ComponentTypeName", "documentation":"The component type name.
" }, "compositeComponentTypes":{ "shape":"CompositeComponentTypesResponse", "documentation":"This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
", "location":"uri", "locationName":"entityId" } } }, "GetEntityResponse":{ "type":"structure", "required":[ "entityId", "entityName", "arn", "status", "workspaceId", "parentEntityId", "hasChildEntities", "creationDateTime", "updateDateTime" ], "members":{ "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the entity.
" }, "status":{ "shape":"Status", "documentation":"The current status of the entity.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "components":{ "shape":"ComponentsMap", "documentation":"An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity for this entity.
" }, "hasChildEntities":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the entity has associated child entities.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was last updated.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The syncSource of the sync job, if this entity was created by a sync job.
" }, "areAllComponentsReturned":{ "shape":"Boolean", "documentation":"This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
" } } }, "GetMetadataTransferJobRequest":{ "type":"structure", "required":["metadataTransferJobId"], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
", "location":"uri", "locationName":"metadataTransferJobId" } } }, "GetMetadataTransferJobResponse":{ "type":"structure", "required":[ "metadataTransferJobId", "arn", "sources", "destination", "metadataTransferJobRole", "creationDateTime", "updateDateTime", "status" ], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job Id.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The metadata transfer job ARN.
" }, "description":{ "shape":"Description", "documentation":"The metadata transfer job description.
" }, "sources":{ "shape":"SourceConfigurations", "documentation":"The metadata transfer job's sources.
" }, "destination":{ "shape":"DestinationConfiguration", "documentation":"The metadata transfer job's destination.
" }, "metadataTransferJobRole":{ "shape":"RoleArn", "documentation":"The metadata transfer job's role.
" }, "reportUrl":{ "shape":"String", "documentation":"The metadata transfer job's report URL.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The metadata transfer job's creation DateTime property.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The metadata transfer job's update DateTime property.
" }, "status":{ "shape":"MetadataTransferJobStatus", "documentation":"The metadata transfer job's status.
" }, "progress":{ "shape":"MetadataTransferJobProgress", "documentation":"The metadata transfer job's progress.
" } } }, "GetPricingPlanRequest":{ "type":"structure", "members":{ } }, "GetPricingPlanResponse":{ "type":"structure", "required":["currentPricingPlan"], "members":{ "currentPricingPlan":{ "shape":"PricingPlan", "documentation":"The chosen pricing plan for the current billing cycle.
" }, "pendingPricingPlan":{ "shape":"PricingPlan", "documentation":"The pending pricing plan.
" } } }, "GetPropertyValueHistoryRequest":{ "type":"structure", "required":[ "workspaceId", "selectedProperties" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "componentPath":{ "shape":"ComponentPath", "documentation":"This string specifies the path to the composite component, starting from the top-level component.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "selectedProperties":{ "shape":"SelectedPropertyList", "documentation":"A list of properties whose value histories the request retrieves.
" }, "propertyFilters":{ "shape":"PropertyFilters", "documentation":"A list of objects that filter the property value history request.
" }, "startDateTime":{ "shape":"Timestamp", "documentation":"The date and time of the earliest property value to return.
", "deprecated":true, "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use startTime instead." }, "endDateTime":{ "shape":"Timestamp", "documentation":"The date and time of the latest property value to return.
", "deprecated":true, "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use endTime instead." }, "interpolation":{ "shape":"InterpolationParameters", "documentation":"An object that specifies the interpolation type and the interval over which to interpolate data.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "orderByTime":{ "shape":"OrderByTime", "documentation":"The time direction to use in the result order.
" }, "startTime":{ "shape":"Time", "documentation":"The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
" }, "endTime":{ "shape":"Time", "documentation":"The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
" } } }, "GetPropertyValueHistoryResponse":{ "type":"structure", "required":["propertyValues"], "members":{ "propertyValues":{ "shape":"PropertyValueList", "documentation":"An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "GetPropertyValueRequest":{ "type":"structure", "required":[ "selectedProperties", "workspaceId" ], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component whose property values the operation returns.
" }, "componentPath":{ "shape":"ComponentPath", "documentation":"This string specifies the path to the composite component, starting from the top-level component.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type whose property values the operation returns.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity whose property values the operation returns.
" }, "selectedProperties":{ "shape":"SelectedPropertyList", "documentation":"The properties whose values the operation returns.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace whose values the operation returns.
", "location":"uri", "locationName":"workspaceId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "propertyGroupName":{ "shape":"Name", "documentation":"The property group name.
" }, "tabularConditions":{ "shape":"TabularConditions", "documentation":"The tabular conditions.
" } } }, "GetPropertyValueResponse":{ "type":"structure", "members":{ "propertyValues":{ "shape":"PropertyLatestValueMap", "documentation":"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.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "tabularPropertyValues":{ "shape":"TabularPropertyValues", "documentation":"A table of property values.
" } } }, "GetSceneRequest":{ "type":"structure", "required":[ "workspaceId", "sceneId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
", "location":"uri", "locationName":"sceneId" } } }, "GetSceneResponse":{ "type":"structure", "required":[ "workspaceId", "sceneId", "contentLocation", "arn", "creationDateTime", "updateDateTime" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the scene.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was last updated.
" }, "description":{ "shape":"Description", "documentation":"The description of the scene.
" }, "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render.
" }, "sceneMetadata":{ "shape":"SceneMetadataMap", "documentation":"The response metadata.
" }, "generatedSceneMetadata":{ "shape":"GeneratedSceneMetadataMap", "documentation":"The generated scene metadata.
" }, "error":{ "shape":"SceneError", "documentation":"The SceneResponse error.
" } } }, "GetSyncJobRequest":{ "type":"structure", "required":["syncSource"], "members":{ "syncSource":{ "shape":"SyncSource", "documentation":"The sync source.
Currently the only supported syncSource is SITEWISE .
The workspace ID.
", "location":"querystring", "locationName":"workspace" } } }, "GetSyncJobResponse":{ "type":"structure", "required":[ "arn", "workspaceId", "syncSource", "syncRole", "status", "creationDateTime", "updateDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The sync job ARN.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the sync job.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The sync soucre.
Currently the only supported syncSource is SITEWISE .
The sync IAM role.
" }, "status":{ "shape":"SyncJobStatus", "documentation":"The SyncJob response status.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The creation date and time.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The update date and time.
" } } }, "GetWorkspaceRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"IdOrArn", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "GetWorkspaceResponse":{ "type":"structure", "required":[ "workspaceId", "arn", "creationDateTime", "updateDateTime" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the workspace.
" }, "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "linkedServices":{ "shape":"LinkedServices", "documentation":"A list of services that are linked to the workspace.
" }, "s3Location":{ "shape":"S3Location", "documentation":"The ARN of the S3 bucket where resources associated with the workspace are stored.
" }, "role":{ "shape":"RoleArn", "documentation":"The ARN of the execution role associated with the workspace.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was last updated.
" } } }, "GroupType":{ "type":"string", "enum":["TABULAR"] }, "Id":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+" }, "IdOrArn":{ "type":"string", "max":2048, "min":1, "pattern":"[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An unexpected error has occurred.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InterpolationParameters":{ "type":"structure", "members":{ "interpolationType":{ "shape":"InterpolationType", "documentation":"The interpolation type.
" }, "intervalInSeconds":{ "shape":"IntervalInSeconds", "documentation":"The interpolation time interval in seconds.
" } }, "documentation":"An object that specifies how to interpolate data in a list.
" }, "InterpolationType":{ "type":"string", "enum":["LINEAR"] }, "IntervalInSeconds":{ "type":"long", "box":true }, "IotSiteWiseSourceConfiguration":{ "type":"structure", "members":{ "filters":{ "shape":"IotSiteWiseSourceConfigurationFilters", "documentation":"The AWS IoT SiteWise soucre configuration filters.
" } }, "documentation":"The metadata transfer job AWS IoT SiteWise source configuration.
" }, "IotSiteWiseSourceConfigurationFilter":{ "type":"structure", "members":{ "filterByAssetModel":{ "shape":"FilterByAssetModel", "documentation":"Filter by asset model.
" }, "filterByAsset":{ "shape":"FilterByAsset", "documentation":"Filter by asset.
" } }, "documentation":"The AWS IoT SiteWise soucre configuration filter.[need held with desc here]
", "union":true }, "IotSiteWiseSourceConfigurationFilters":{ "type":"list", "member":{"shape":"IotSiteWiseSourceConfigurationFilter"} }, "IotTwinMakerDestinationConfiguration":{ "type":"structure", "required":["workspace"], "members":{ "workspace":{ "shape":"TwinMakerArn", "documentation":"The IoT TwinMaker workspace.
" } }, "documentation":"The metadata transfer job AWS IoT TwinMaker destination configuration.
" }, "IotTwinMakerSourceConfiguration":{ "type":"structure", "required":["workspace"], "members":{ "workspace":{ "shape":"TwinMakerArn", "documentation":"The IoT TwinMaker workspace.
" }, "filters":{ "shape":"IotTwinMakerSourceConfigurationFilters", "documentation":"The metadata transfer job AWS IoT TwinMaker source configuration filters.
" } }, "documentation":"The metadata transfer job AWS IoT TwinMaker source configuration.
" }, "IotTwinMakerSourceConfigurationFilter":{ "type":"structure", "members":{ "filterByComponentType":{ "shape":"FilterByComponentType", "documentation":"Filter by component type.
" }, "filterByEntity":{ "shape":"FilterByEntity", "documentation":"Filter by entity.
" } }, "documentation":"The metadata transfer job AWS IoT TwinMaker source configuration filter.
", "union":true }, "IotTwinMakerSourceConfigurationFilters":{ "type":"list", "member":{"shape":"IotTwinMakerSourceConfigurationFilter"} }, "LambdaArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\\/a-zA-Z0-9_-]+" }, "LambdaFunction":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"LambdaArn", "documentation":"The ARN of the Lambda function.
" } }, "documentation":"The Lambda function.
" }, "LinkedService":{ "type":"string", "pattern":"[a-zA-Z_0-9]+" }, "LinkedServices":{ "type":"list", "member":{"shape":"LinkedService"} }, "ListComponentTypesFilter":{ "type":"structure", "members":{ "extendsFrom":{ "shape":"ComponentTypeId", "documentation":"The component type that the component types in the list extend.
" }, "namespace":{ "shape":"String", "documentation":"The namespace to which the component types in the list belong.
" }, "isAbstract":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the component types in the list are abstract.
" } }, "documentation":"An object that filters items in a list of component types.
Only one object is accepted as a valid input.
The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "filters":{ "shape":"ListComponentTypesFilters", "documentation":"A list of objects that filter the request.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" } } }, "ListComponentTypesResponse":{ "type":"structure", "required":[ "workspaceId", "componentTypeSummaries" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" }, "componentTypeSummaries":{ "shape":"ComponentTypeSummaries", "documentation":"A list of objects that contain information about the component types.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"Specifies the maximum number of results to display.
" } } }, "ListComponentsRequest":{ "type":"structure", "required":[ "workspaceId", "entityId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The workspace ID.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID for the entity whose metadata (component/properties) is returned by the operation.
", "location":"uri", "locationName":"entityId" }, "componentPath":{ "shape":"ComponentPath", "documentation":"This string specifies the path to the composite component, starting from the top-level component.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results returned at one time. The default is 25.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListComponentsResponse":{ "type":"structure", "required":["componentSummaries"], "members":{ "componentSummaries":{ "shape":"ComponentSummaries", "documentation":"A list of objects that contain information about the components.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of component results.
" } } }, "ListEntitiesFilter":{ "type":"structure", "members":{ "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The parent of the entities in the list.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type in the entities in the list.
" }, "externalId":{ "shape":"String", "documentation":"The external-Id property of a component. The external-Id property is the primary key of an external storage system.
" } }, "documentation":"An object that filters items in a list of entities.
", "union":true }, "ListEntitiesFilters":{ "type":"list", "member":{"shape":"ListEntitiesFilter"} }, "ListEntitiesRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "filters":{ "shape":"ListEntitiesFilters", "documentation":"A list of objects that filter the request.
Only one object is accepted as a valid input.
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListEntitiesResponse":{ "type":"structure", "members":{ "entitySummaries":{ "shape":"EntitySummaries", "documentation":"A list of objects that contain information about the entities.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListMetadataTransferJobsFilter":{ "type":"structure", "members":{ "workspaceId":{ "shape":"Id", "documentation":"The workspace Id.
" }, "state":{ "shape":"MetadataTransferJobState", "documentation":"The filter state.
" } }, "documentation":"The ListMetadataTransferJobs filter.
", "union":true }, "ListMetadataTransferJobsFilters":{ "type":"list", "member":{"shape":"ListMetadataTransferJobsFilter"} }, "ListMetadataTransferJobsRequest":{ "type":"structure", "required":[ "sourceType", "destinationType" ], "members":{ "sourceType":{ "shape":"SourceType", "documentation":"The metadata transfer job's source type.
" }, "destinationType":{ "shape":"DestinationType", "documentation":"The metadata transfer job's destination type.
" }, "filters":{ "shape":"ListMetadataTransferJobsFilters", "documentation":"An object that filters metadata transfer jobs.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time.
" } } }, "ListMetadataTransferJobsResponse":{ "type":"structure", "required":["metadataTransferJobSummaries"], "members":{ "metadataTransferJobSummaries":{ "shape":"MetadataTransferJobSummaries", "documentation":"The metadata transfer job summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListPropertiesRequest":{ "type":"structure", "required":[ "workspaceId", "entityId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The workspace ID.
", "location":"uri", "locationName":"workspaceId" }, "componentName":{ "shape":"Name", "documentation":"The name of the component whose properties are returned by the operation.
" }, "componentPath":{ "shape":"ComponentPath", "documentation":"This string specifies the path to the composite component, starting from the top-level component.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID for the entity whose metadata (component/properties) is returned by the operation.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results returned at one time. The default is 25.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListPropertiesResponse":{ "type":"structure", "required":["propertySummaries"], "members":{ "propertySummaries":{ "shape":"PropertySummaries", "documentation":"A list of objects that contain information about the properties.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of property results.
" } } }, "ListScenesRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scenes.
", "location":"uri", "locationName":"workspaceId" }, "maxResults":{ "shape":"MaxResults", "documentation":"Specifies the maximum number of results to display.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListScenesResponse":{ "type":"structure", "members":{ "sceneSummaries":{ "shape":"SceneSummaries", "documentation":"A list of objects that contain information about the scenes.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListSyncJobsRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the sync job.
", "location":"uri", "locationName":"workspaceId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListSyncJobsResponse":{ "type":"structure", "members":{ "syncJobSummaries":{ "shape":"SyncJobSummaries", "documentation":"The listed SyncJob summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListSyncResourcesRequest":{ "type":"structure", "required":[ "workspaceId", "syncSource" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the sync job.
", "location":"uri", "locationName":"workspaceId" }, "syncSource":{ "shape":"SyncSource", "documentation":"The sync source.
Currently the only supported syncSource is SITEWISE .
A list of objects that filter the request.
The following filter combinations are supported:
Filter with state
Filter with ResourceType and ResourceId
Filter with ResourceType and ExternalId
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListSyncResourcesResponse":{ "type":"structure", "members":{ "syncResources":{ "shape":"SyncResourceSummaries", "documentation":"The sync resources.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceARN"], "members":{ "resourceARN":{ "shape":"TwinMakerArn", "documentation":"The ARN of the resource.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage a resource.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListWorkspacesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListWorkspacesResponse":{ "type":"structure", "members":{ "workspaceSummaries":{ "shape":"WorkspaceSummaries", "documentation":"A list of objects that contain information about the workspaces.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":200, "min":0 }, "MetadataTransferJobProgress":{ "type":"structure", "members":{ "totalCount":{ "shape":"Integer", "documentation":"The total count. [of what]
" }, "succeededCount":{ "shape":"Integer", "documentation":"The succeeded count.
" }, "skippedCount":{ "shape":"Integer", "documentation":"The skipped count.
" }, "failedCount":{ "shape":"Integer", "documentation":"The failed count.
" } }, "documentation":"The metadata transfer job's progress.
" }, "MetadataTransferJobState":{ "type":"string", "enum":[ "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED" ] }, "MetadataTransferJobStatus":{ "type":"structure", "members":{ "state":{ "shape":"MetadataTransferJobState", "documentation":"The metadata transfer job state.
" }, "error":{ "shape":"ErrorDetails", "documentation":"The metadata transfer job error.
" }, "queuedPosition":{ "shape":"Integer", "documentation":"The queued position.
" } }, "documentation":"The metadata transfer job status.
" }, "MetadataTransferJobSummaries":{ "type":"list", "member":{"shape":"MetadataTransferJobSummary"} }, "MetadataTransferJobSummary":{ "type":"structure", "required":[ "metadataTransferJobId", "arn", "creationDateTime", "updateDateTime", "status" ], "members":{ "metadataTransferJobId":{ "shape":"Id", "documentation":"The metadata transfer job summary Id.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The metadata transfer job summary ARN.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The metadata transfer job summary creation DateTime object.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The metadata transfer job summary update DateTime object
" }, "status":{ "shape":"MetadataTransferJobStatus", "documentation":"The metadata transfer job summary status.
" }, "progress":{ "shape":"MetadataTransferJobProgress", "documentation":"The metadata transfer job summary progess.
" } }, "documentation":"The metadata transfer job summary.
" }, "Name":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z_\\-0-9]+" }, "NextToken":{ "type":"string", "max":17880, "min":0, "pattern":".*" }, "Order":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "OrderBy":{ "type":"structure", "required":["propertyName"], "members":{ "order":{ "shape":"Order", "documentation":"The set order that filters results.
" }, "propertyName":{ "shape":"String", "documentation":"The property name.
" } }, "documentation":"Filter criteria that orders the return output. It can be sorted in ascending or descending order.
" }, "OrderByList":{ "type":"list", "member":{"shape":"OrderBy"}, "max":10, "min":1 }, "OrderByTime":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "ParentEntityId":{ "type":"string", "max":128, "min":1, "pattern":"\\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+" }, "ParentEntityUpdateRequest":{ "type":"structure", "required":["updateType"], "members":{ "updateType":{ "shape":"ParentEntityUpdateType", "documentation":"The type of the update.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity.
" } }, "documentation":"The parent entity update request.
" }, "ParentEntityUpdateType":{ "type":"string", "enum":[ "UPDATE", "DELETE" ] }, "PricingBundles":{ "type":"list", "member":{"shape":"BundleName"}, "max":10, "min":1 }, "PricingMode":{ "type":"string", "enum":[ "BASIC", "STANDARD", "TIERED_BUNDLE" ] }, "PricingPlan":{ "type":"structure", "required":[ "effectiveDateTime", "pricingMode", "updateDateTime", "updateReason" ], "members":{ "billableEntityCount":{ "shape":"Long", "documentation":"The billable entity count.
" }, "bundleInformation":{ "shape":"BundleInformation", "documentation":"The pricing plan's bundle information.
" }, "effectiveDateTime":{ "shape":"Timestamp", "documentation":"The effective date and time of the pricing plan.
" }, "pricingMode":{ "shape":"PricingMode", "documentation":"The pricing mode.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The set date and time for updating a pricing plan.
" }, "updateReason":{ "shape":"UpdateReason", "documentation":"The update reason for changing a pricing plan.
" } }, "documentation":"The pricing plan.
" }, "PricingTier":{ "type":"string", "enum":[ "TIER_1", "TIER_2", "TIER_3", "TIER_4" ] }, "PropertyDefinitionRequest":{ "type":"structure", "members":{ "dataType":{ "shape":"DataType", "documentation":"An object that contains information about the data type.
" }, "isRequiredInEntity":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is required.
" }, "isExternalId":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property ID comes from an external data store.
" }, "isStoredExternally":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is stored externally.
" }, "isTimeSeries":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property consists of time series data.
" }, "defaultValue":{ "shape":"DataValue", "documentation":"An object that contains the default value.
" }, "configuration":{ "shape":"Configuration", "documentation":"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.
" }, "displayName":{ "shape":"PropertyDisplayName", "documentation":"A friendly name for the property.
" } }, "documentation":"An object that sets information about a property.
" }, "PropertyDefinitionResponse":{ "type":"structure", "required":[ "dataType", "isTimeSeries", "isRequiredInEntity", "isExternalId", "isStoredExternally", "isImported", "isFinal", "isInherited" ], "members":{ "dataType":{ "shape":"DataType", "documentation":"An object that contains information about the data type.
" }, "isTimeSeries":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property consists of time series data.
" }, "isRequiredInEntity":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is required in an entity.
" }, "isExternalId":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property ID comes from an external data store.
" }, "isStoredExternally":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is stored externally.
" }, "isImported":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition is imported from an external data store.
" }, "isFinal":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition can be updated.
" }, "isInherited":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition is inherited from a parent entity.
" }, "defaultValue":{ "shape":"DataValue", "documentation":"An object that contains the default value.
" }, "configuration":{ "shape":"Configuration", "documentation":"A mapping that specifies configuration information about the property.
" }, "displayName":{ "shape":"PropertyDisplayName", "documentation":"A friendly name for the property.
" } }, "documentation":"An object that contains response data from a property definition request.
" }, "PropertyDefinitionsRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyDefinitionRequest"} }, "PropertyDefinitionsResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyDefinitionResponse"} }, "PropertyDisplayName":{ "type":"string", "max":256, "min":0, "pattern":".*[^\\u0000-\\u001F\\u007F]*.*" }, "PropertyFilter":{ "type":"structure", "members":{ "propertyName":{ "shape":"String", "documentation":"The property name associated with this property filter.
" }, "operator":{ "shape":"String", "documentation":"The operator associated with this property filter.
" }, "value":{ "shape":"DataValue", "documentation":"The value associated with this property filter.
" } }, "documentation":"An object that filters items returned by a property request.
" }, "PropertyFilters":{ "type":"list", "member":{"shape":"PropertyFilter"}, "max":10, "min":1 }, "PropertyGroupRequest":{ "type":"structure", "members":{ "groupType":{ "shape":"GroupType", "documentation":"The group type.
" }, "propertyNames":{ "shape":"PropertyNames", "documentation":"The names of properties.
" } }, "documentation":"" }, "PropertyGroupResponse":{ "type":"structure", "required":[ "groupType", "propertyNames", "isInherited" ], "members":{ "groupType":{ "shape":"GroupType", "documentation":"The group types.
" }, "propertyNames":{ "shape":"PropertyNames", "documentation":"The names of properties.
" }, "isInherited":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property group is inherited from a parent entity
" } }, "documentation":"The property group response
" }, "PropertyGroupUpdateType":{ "type":"string", "enum":[ "UPDATE", "DELETE", "CREATE" ] }, "PropertyGroupsRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyGroupRequest"} }, "PropertyGroupsResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyGroupResponse"} }, "PropertyLatestValue":{ "type":"structure", "required":["propertyReference"], "members":{ "propertyReference":{ "shape":"EntityPropertyReference", "documentation":"An object that specifies information about a property.
" }, "propertyValue":{ "shape":"DataValue", "documentation":"The value of the property.
" } }, "documentation":"The latest value of the property.
" }, "PropertyLatestValueMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyLatestValue"} }, "PropertyNames":{ "type":"list", "member":{"shape":"Name"} }, "PropertyRequest":{ "type":"structure", "members":{ "definition":{ "shape":"PropertyDefinitionRequest", "documentation":"An object that specifies information about a property.
" }, "value":{ "shape":"DataValue", "documentation":"The value of the property.
" }, "updateType":{ "shape":"PropertyUpdateType", "documentation":"The update type of the update property request.
" } }, "documentation":"An object that sets information about a property.
" }, "PropertyRequests":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyRequest"} }, "PropertyResponse":{ "type":"structure", "members":{ "definition":{ "shape":"PropertyDefinitionResponse", "documentation":"An object that specifies information about a property.
" }, "value":{ "shape":"DataValue", "documentation":"The value of the property.
" }, "areAllPropertyValuesReturned":{ "shape":"Boolean", "documentation":"This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
" } }, "documentation":"An object that contains information about a property response.
" }, "PropertyResponses":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyResponse"} }, "PropertySummaries":{ "type":"list", "member":{"shape":"PropertySummary"} }, "PropertySummary":{ "type":"structure", "required":["propertyName"], "members":{ "definition":{ "shape":"PropertyDefinitionResponse", "documentation":"This is the schema for the property.
" }, "propertyName":{ "shape":"Name", "documentation":"This is the name of the property.
" }, "value":{ "shape":"DataValue", "documentation":"This is the value for the property.
" }, "areAllPropertyValuesReturned":{ "shape":"Boolean", "documentation":"This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
" } }, "documentation":"This is an object that contains the information of a property.
" }, "PropertyTableValue":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"DataValue"} }, "PropertyUpdateType":{ "type":"string", "enum":[ "UPDATE", "DELETE", "CREATE", "RESET_VALUE" ] }, "PropertyValue":{ "type":"structure", "required":["value"], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"The timestamp of a value for a time series property.
", "deprecated":true, "deprecatedMessage":"This field is deprecated and will throw an error in the future. Use time instead." }, "value":{ "shape":"DataValue", "documentation":"An object that specifies a value for a time series property.
" }, "time":{ "shape":"Time", "documentation":"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]
" } }, "documentation":"An object that contains information about a value for a time series property.
" }, "PropertyValueEntry":{ "type":"structure", "required":["entityPropertyReference"], "members":{ "entityPropertyReference":{ "shape":"EntityPropertyReference", "documentation":"An object that contains information about the entity that has the property.
" }, "propertyValues":{ "shape":"PropertyValues", "documentation":"A list of objects that specify time series property values.
" } }, "documentation":"An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
" }, "PropertyValueHistory":{ "type":"structure", "required":["entityPropertyReference"], "members":{ "entityPropertyReference":{ "shape":"EntityPropertyReference", "documentation":"An object that uniquely identifies an entity property.
" }, "values":{ "shape":"Values", "documentation":"A list of objects that contain information about the values in the history of a time series property.
" } }, "documentation":"The history of values for a time series property.
" }, "PropertyValueList":{ "type":"list", "member":{"shape":"PropertyValueHistory"} }, "PropertyValues":{ "type":"list", "member":{"shape":"PropertyValue"}, "max":10, "min":1 }, "QueryResultValue":{ "type":"structure", "members":{ }, "document":true }, "QueryServiceMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "QueryStatement":{ "type":"string", "max":1000, "min":1, "pattern":"[\\s\\S]+" }, "QueryTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The query timeout exception.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "Relationship":{ "type":"structure", "members":{ "targetComponentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the target component type associated with this relationship.
" }, "relationshipType":{ "shape":"String", "documentation":"The type of the relationship.
" } }, "documentation":"An object that specifies a relationship with another component type.
" }, "RelationshipValue":{ "type":"structure", "members":{ "targetEntityId":{ "shape":"EntityId", "documentation":"The ID of the target entity associated with this relationship value.
" }, "targetComponentName":{ "shape":"Name", "documentation":"The name of the target component associated with the relationship value.
" } }, "documentation":"A value that associates a component and an entity.
" }, "RequiredProperties":{ "type":"list", "member":{"shape":"Name"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The resource wasn't found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*" }, "Row":{ "type":"structure", "members":{ "rowData":{ "shape":"RowData", "documentation":"The data in a row of query results.
" } }, "documentation":"Represents a single row in the query results.
" }, "RowData":{ "type":"list", "member":{"shape":"QueryResultValue"} }, "Rows":{ "type":"list", "member":{"shape":"Row"} }, "S3DestinationConfiguration":{ "type":"structure", "required":["location"], "members":{ "location":{ "shape":"S3DestinationLocation", "documentation":"The S3 destination configuration location.
" } }, "documentation":"The S3 destination configuration.
" }, "S3DestinationLocation":{ "type":"string", "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([/a-zA-Z0-9_-]+$).*" }, "S3Location":{ "type":"string", "max":1024, "min":0, "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+$).*" }, "S3SourceConfiguration":{ "type":"structure", "required":["location"], "members":{ "location":{ "shape":"S3SourceLocation", "documentation":"The S3 destination source configuration location.
" } }, "documentation":"The S3 destination source configuration.
" }, "S3SourceLocation":{ "type":"string", "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+)\\/([/.a-zA-Z0-9_-]+$).*" }, "S3Url":{ "type":"string", "max":256, "min":0, "pattern":"[sS]3://[A-Za-z0-9._/-]+" }, "SceneCapabilities":{ "type":"list", "member":{"shape":"SceneCapability"}, "max":50, "min":0 }, "SceneCapability":{ "type":"string", "max":256, "min":0, "pattern":".*" }, "SceneError":{ "type":"structure", "members":{ "code":{ "shape":"SceneErrorCode", "documentation":"The SceneError code.
" }, "message":{ "shape":"ErrorMessage", "documentation":"The SceneError message.
" } }, "documentation":"The scene error.
" }, "SceneErrorCode":{ "type":"string", "enum":["MATTERPORT_ERROR"] }, "SceneMetadataMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"SceneMetadataValue"}, "max":50, "min":0 }, "SceneMetadataValue":{ "type":"string", "max":2048, "min":0, "pattern":".*" }, "SceneSummaries":{ "type":"list", "member":{"shape":"SceneSummary"} }, "SceneSummary":{ "type":"structure", "required":[ "sceneId", "contentLocation", "arn", "creationDateTime", "updateDateTime" ], "members":{ "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the scene.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was last updated.
" }, "description":{ "shape":"Description", "documentation":"The scene description.
" } }, "documentation":"An object that contains information about a scene.
" }, "Scope":{ "type":"string", "enum":[ "ENTITY", "WORKSPACE" ] }, "SelectedPropertyList":{ "type":"list", "member":{"shape":"String"}, "max":10, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The service quota was exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SiteWiseExternalId":{ "type":"string", "max":128, "min":2, "pattern":".*[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+.*" }, "SourceConfiguration":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"SourceType", "documentation":"The source configuration type.
" }, "s3Configuration":{ "shape":"S3SourceConfiguration", "documentation":"The source configuration S3 configuration.
" }, "iotSiteWiseConfiguration":{ "shape":"IotSiteWiseSourceConfiguration", "documentation":"The source configuration IoT SiteWise configuration.
" }, "iotTwinMakerConfiguration":{ "shape":"IotTwinMakerSourceConfiguration", "documentation":"The source configuration IoT TwinMaker configuration.
" } }, "documentation":"The source configuration.
" }, "SourceConfigurations":{ "type":"list", "member":{"shape":"SourceConfiguration"}, "max":1, "min":1 }, "SourceType":{ "type":"string", "enum":[ "s3", "iotsitewise", "iottwinmaker" ] }, "State":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" ] }, "Status":{ "type":"structure", "members":{ "state":{ "shape":"State", "documentation":"The current state of the entity, component, component type, or workspace.
" }, "error":{ "shape":"ErrorDetails", "documentation":"The error message.
" } }, "documentation":"An object that represents the status of an entity, component, component type, or workspace.
" }, "String":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "SyncJobState":{ "type":"string", "enum":[ "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR" ] }, "SyncJobStatus":{ "type":"structure", "members":{ "state":{ "shape":"SyncJobState", "documentation":"The SyncJob status state.
" }, "error":{ "shape":"ErrorDetails", "documentation":"The SyncJob error.
" } }, "documentation":"The SyncJob status.
" }, "SyncJobSummaries":{ "type":"list", "member":{"shape":"SyncJobSummary"} }, "SyncJobSummary":{ "type":"structure", "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The SyncJob summary ARN.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the sync job.
" }, "syncSource":{ "shape":"SyncSource", "documentation":"The sync source.
" }, "status":{ "shape":"SyncJobStatus", "documentation":"The SyncJob summaries status.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The creation date and time.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The update date and time.
" } }, "documentation":"The SyncJob summary.
" }, "SyncResourceFilter":{ "type":"structure", "members":{ "state":{ "shape":"SyncResourceState", "documentation":"The sync resource filter's state.
" }, "resourceType":{ "shape":"SyncResourceType", "documentation":"The sync resource filter resource type
" }, "resourceId":{ "shape":"Id", "documentation":"The sync resource filter resource ID.
" }, "externalId":{ "shape":"Id", "documentation":"The external ID.
" } }, "documentation":"The sync resource filter.
", "union":true }, "SyncResourceFilters":{ "type":"list", "member":{"shape":"SyncResourceFilter"} }, "SyncResourceState":{ "type":"string", "enum":[ "INITIALIZING", "PROCESSING", "DELETED", "IN_SYNC", "ERROR" ] }, "SyncResourceStatus":{ "type":"structure", "members":{ "state":{ "shape":"SyncResourceState", "documentation":"The sync resource status state.
" }, "error":{ "shape":"ErrorDetails", "documentation":"The status error.
" } }, "documentation":"The sync resource status.
" }, "SyncResourceSummaries":{ "type":"list", "member":{"shape":"SyncResourceSummary"} }, "SyncResourceSummary":{ "type":"structure", "members":{ "resourceType":{ "shape":"SyncResourceType", "documentation":"The resource type.
" }, "externalId":{ "shape":"Id", "documentation":"The external ID.
" }, "resourceId":{ "shape":"Id", "documentation":"The resource ID.
" }, "status":{ "shape":"SyncResourceStatus", "documentation":"The sync resource summary status.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The update date and time.
" } }, "documentation":"The sync resource summary.
" }, "SyncResourceType":{ "type":"string", "enum":[ "ENTITY", "COMPONENT_TYPE" ] }, "SyncSource":{ "type":"string", "pattern":"[a-zA-Z_0-9]+" }, "TabularConditions":{ "type":"structure", "members":{ "orderBy":{ "shape":"OrderByList", "documentation":"Filter criteria that orders the output. It can be sorted in ascending or descending order.
" }, "propertyFilters":{ "shape":"PropertyFilters", "documentation":"You can filter the request using various logical operators and a key-value format. For example:
{\"key\": \"serverType\", \"value\": \"webServer\"}
The tabular conditions.
" }, "TabularPropertyValue":{ "type":"list", "member":{"shape":"PropertyTableValue"} }, "TabularPropertyValues":{ "type":"list", "member":{"shape":"TabularPropertyValue"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tags" ], "members":{ "resourceARN":{ "shape":"TwinMakerArn", "documentation":"The ARN of the resource.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata to add to this resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The rate exceeds the limit.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Time":{ "type":"string", "documentation":"Timestamp represented in ISO 8601 format
", "max":35, "min":20 }, "Timestamp":{ "type":"timestamp", "documentation":"supports epoch seconds value
" }, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"The number of tags exceeds the limit.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "TwinMakerArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+" }, "Type":{ "type":"string", "enum":[ "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP" ] }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tagKeys" ], "members":{ "resourceARN":{ "shape":"TwinMakerArn", "documentation":"The ARN of the resource.
", "location":"querystring", "locationName":"resourceARN" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"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.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateComponentTypeRequest":{ "type":"structure", "required":[ "workspaceId", "componentTypeId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "propertyDefinitions":{ "shape":"PropertyDefinitionsRequest", "documentation":"An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" }, "extendsFrom":{ "shape":"ExtendsFrom", "documentation":"Specifies the component type that this component type extends.
" }, "functions":{ "shape":"FunctionsRequest", "documentation":"An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
" }, "propertyGroups":{ "shape":"PropertyGroupsRequest", "documentation":"The property groups.
" }, "componentTypeName":{ "shape":"ComponentTypeName", "documentation":"The component type name.
" }, "compositeComponentTypes":{ "shape":"CompositeComponentTypesRequest", "documentation":"This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
The ID of the workspace that contains the component type.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the component type.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "state":{ "shape":"State", "documentation":"The current state of the component type.
" } } }, "UpdateEntityRequest":{ "type":"structure", "required":[ "workspaceId", "entityId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity.
", "location":"uri", "locationName":"workspaceId" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
", "location":"uri", "locationName":"entityId" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "componentUpdates":{ "shape":"ComponentUpdatesMapRequest", "documentation":"An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
" }, "compositeComponentUpdates":{ "shape":"CompositeComponentUpdatesMapRequest", "documentation":"This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
An object that describes the update request for a parent entity.
" } } }, "UpdateEntityResponse":{ "type":"structure", "required":[ "updateDateTime", "state" ], "members":{ "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was last updated.
" }, "state":{ "shape":"State", "documentation":"The current state of the entity update.
" } } }, "UpdatePricingPlanRequest":{ "type":"structure", "required":["pricingMode"], "members":{ "pricingMode":{ "shape":"PricingMode", "documentation":"The pricing mode.
" }, "bundleNames":{ "shape":"PricingBundles", "documentation":"The bundle names.
" } } }, "UpdatePricingPlanResponse":{ "type":"structure", "required":["currentPricingPlan"], "members":{ "currentPricingPlan":{ "shape":"PricingPlan", "documentation":"Update the current pricing plan.
" }, "pendingPricingPlan":{ "shape":"PricingPlan", "documentation":"Update the pending pricing plan.
" } } }, "UpdateReason":{ "type":"string", "enum":[ "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN" ] }, "UpdateSceneRequest":{ "type":"structure", "required":[ "workspaceId", "sceneId" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
", "location":"uri", "locationName":"sceneId" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "description":{ "shape":"Description", "documentation":"The description of this scene.
" }, "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render.
" }, "sceneMetadata":{ "shape":"SceneMetadataMap", "documentation":"The scene metadata.
" } } }, "UpdateSceneResponse":{ "type":"structure", "required":["updateDateTime"], "members":{ "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was last updated.
" } } }, "UpdateWorkspaceRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" }, "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "role":{ "shape":"RoleArn", "documentation":"The ARN of the execution role associated with the workspace.
" }, "s3Location":{ "shape":"S3Location", "documentation":"The ARN of the S3 bucket where resources associated with the workspace are stored.
" } } }, "UpdateWorkspaceResponse":{ "type":"structure", "required":["updateDateTime"], "members":{ "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time of the current update.
" } } }, "Uuid":{ "type":"string", "max":36, "min":36, "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Failed
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "Value":{ "type":"string", "pattern":".*" }, "Values":{ "type":"list", "member":{"shape":"PropertyValue"} }, "WorkspaceDeleteMessage":{ "type":"string", "max":2048, "min":0, "pattern":".*" }, "WorkspaceSummaries":{ "type":"list", "member":{"shape":"WorkspaceSummary"} }, "WorkspaceSummary":{ "type":"structure", "required":[ "workspaceId", "arn", "creationDateTime", "updateDateTime" ], "members":{ "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" }, "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the workspace.
" }, "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "linkedServices":{ "shape":"LinkedServices", "documentation":"A list of services that are linked to the workspace.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was created.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was last updated.
" } }, "documentation":"An object that contains information about a workspace.
" } }, "documentation":"IoT TwinMaker is a service with which you can 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.
" }