Sets values for multiple time series properties.
", "endpoint":{"hostPrefix":"data."} }, "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."} }, "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."} }, "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."} }, "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."} }, "GetComponentType":{ "name":"GetComponentType", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}/component-types/{componentTypeId}", "responseCode":200 }, "input":{"shape":"GetComponentTypeRequest"}, "output":{"shape":"GetComponentTypeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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."} }, "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."} }, "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."} }, "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."} }, "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."} }, "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."} }, "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":[ "entry", "errorCode", "errorMessage" ], "members":{ "entry":{ "shape":"PropertyValueEntry", "documentation":"An object that contains information about errors returned by the BatchPutProperty action.
The error code.
" }, "errorMessage":{ "shape":"String", "documentation":"The error message.
" } }, "documentation":"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.
An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the properties to set.
", "location":"uri", "locationName":"workspaceId" } } }, "BatchPutPropertyValuesResponse":{ "type":"structure", "required":["errorEntries"], "members":{ "errorEntries":{ "shape":"ErrorEntries", "documentation":"Entries that caused errors in the batch put operation.
" } } }, "Boolean":{ "type":"boolean", "box":true }, "ComponentRequest":{ "type":"structure", "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "description":{ "shape":"Description", "documentation":"The description of the component request.
" }, "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.
" } }, "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.
" }, "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 type.
" }, "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.
" }, "status":{ "shape":"Status", "documentation":"The status of the component type.
" } }, "documentation":"An object that returns information about a component type create or update request.
" }, "ComponentTypeId":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z_\\.\\-0-9:]+" }, "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.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "status":{ "shape":"Status", "documentation":"The current status of the component type.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component type was last updated.
" } }, "documentation":"An object that contains information about a component type.
" }, "ComponentUpdateRequest":{ "type":"structure", "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "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.
" }, "updateType":{ "shape":"ComponentUpdateType", "documentation":"The update type of the component update request.
" } }, "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"} }, "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":[ "componentTypeId", "workspaceId" ], "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "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.
" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this 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.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the component type.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" } } }, "CreateComponentTypeResponse":{ "type":"structure", "required":[ "arn", "creationDateTime", "state" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"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":[ "entityName", "workspaceId" ], "members":{ "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.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the entity's parent entity.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the entity.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity.
", "location":"uri", "locationName":"workspaceId" } } }, "CreateEntityResponse":{ "type":"structure", "required":[ "arn", "creationDateTime", "entityId", "state" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the entity.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "state":{ "shape":"State", "documentation":"The current state of the entity.
" } } }, "CreateSceneRequest":{ "type":"structure", "required":[ "contentLocation", "sceneId", "workspaceId" ], "members":{ "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render itself.
" }, "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.
" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the scene.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" } } }, "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.
" } } }, "CreateWorkspaceRequest":{ "type":"structure", "required":[ "role", "s3Location", "workspaceId" ], "members":{ "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.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage the workspace
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "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":{ "isNative":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
" }, "lambda":{ "shape":"LambdaFunction", "documentation":"The Lambda function associated with this data connector.
" } }, "documentation":"The data connector.
" }, "DataType":{ "type":"structure", "required":["type"], "members":{ "allowedValues":{ "shape":"DataValueList", "documentation":"The allowed values for this data type.
" }, "nestedType":{ "shape":"DataType", "documentation":"The nested type in the data type.
" }, "relationship":{ "shape":"Relationship", "documentation":"A relationship that associates a component with another component.
" }, "type":{ "shape":"Type", "documentation":"The underlying type of the data type.
" }, "unitOfMeasure":{ "shape":"String", "documentation":"The unit of measure used in this data type.
" } }, "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.
" }, "expression":{ "shape":"Expression", "documentation":"An expression that produces the value.
" }, "integerValue":{ "shape":"Integer", "documentation":"An integer value.
" }, "listValue":{ "shape":"DataValueList", "documentation":"A list of multiple values.
" }, "longValue":{ "shape":"Long", "documentation":"A long value.
" }, "mapValue":{ "shape":"DataValueMap", "documentation":"An object that maps strings to multiple DataValue objects.
A value that relates a component to another component.
" }, "stringValue":{ "shape":"String", "documentation":"A string 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":[ "componentTypeId", "workspaceId" ], "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type to delete.
", "location":"uri", "locationName":"componentTypeId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" } } }, "DeleteComponentTypeResponse":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"State", "documentation":"The current state of the component type to be deleted.
" } } }, "DeleteEntityRequest":{ "type":"structure", "required":[ "entityId", "workspaceId" ], "members":{ "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" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity to delete.
", "location":"uri", "locationName":"workspaceId" } } }, "DeleteEntityResponse":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"State", "documentation":"The current state of the deleted entity.
" } } }, "DeleteSceneRequest":{ "type":"structure", "required":[ "sceneId", "workspaceId" ], "members":{ "sceneId":{ "shape":"Id", "documentation":"The ID of the scene to delete.
", "location":"uri", "locationName":"sceneId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "DeleteSceneResponse":{ "type":"structure", "members":{ } }, "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":{ } }, "Description":{ "type":"string", "max":512, "min":0, "pattern":".*" }, "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":"[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+" }, "EntityPropertyReference":{ "type":"structure", "required":["propertyName"], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "externalIdProperty":{ "shape":"ExternalIdProperty", "documentation":"A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
" }, "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":[ "arn", "creationDateTime", "entityId", "entityName", "status", "updateDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the entity.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "hasChildEntities":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the entity has child entities or not.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity.
" }, "status":{ "shape":"Status", "documentation":"The current status of the entity.
" }, "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" ] }, "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"}, "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"} }, "FunctionRequest":{ "type":"structure", "members":{ "implementedBy":{ "shape":"DataConnector", "documentation":"The data connector.
" }, "requiredProperties":{ "shape":"RequiredProperties", "documentation":"The required properties of the function.
" }, "scope":{ "shape":"Scope", "documentation":"The scope of the function.
" } }, "documentation":"The function request body.
" }, "FunctionResponse":{ "type":"structure", "members":{ "implementedBy":{ "shape":"DataConnector", "documentation":"The data connector.
" }, "isInherited":{ "shape":"Boolean", "documentation":"Indicates whether this function is inherited.
" }, "requiredProperties":{ "shape":"RequiredProperties", "documentation":"The required properties of the function.
" }, "scope":{ "shape":"Scope", "documentation":"The scope of the function.
" } }, "documentation":"The function response.
" }, "FunctionsRequest":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"FunctionRequest"} }, "FunctionsResponse":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"FunctionResponse"} }, "GetComponentTypeRequest":{ "type":"structure", "required":[ "componentTypeId", "workspaceId" ], "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" } } }, "GetComponentTypeResponse":{ "type":"structure", "required":[ "arn", "componentTypeId", "creationDateTime", "updateDateTime", "workspaceId" ], "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.
" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "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.
" }, "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.
" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this 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.
" }, "status":{ "shape":"Status", "documentation":"The current status of the component type.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the component was last updated.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
" } } }, "GetEntityRequest":{ "type":"structure", "required":[ "entityId", "workspaceId" ], "members":{ "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
", "location":"uri", "locationName":"entityId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "GetEntityResponse":{ "type":"structure", "required":[ "arn", "creationDateTime", "entityId", "entityName", "hasChildEntities", "parentEntityId", "status", "updateDateTime", "workspaceId" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN 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.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "hasChildEntities":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the entity has associated child entities.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity for this entity.
" }, "status":{ "shape":"Status", "documentation":"The current status of the entity.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was last updated.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" } } }, "GetPropertyValueHistoryRequest":{ "type":"structure", "required":[ "selectedProperties", "workspaceId" ], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component.
" }, "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
" }, "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." }, "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.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
" }, "interpolation":{ "shape":"InterpolationParameters", "documentation":"An object that specifies the interpolation type and the interval over which to interpolate data.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "orderByTime":{ "shape":"OrderByTime", "documentation":"The time direction to use in the result order.
" }, "propertyFilters":{ "shape":"PropertyFilters", "documentation":"A list of objects that filter the property value history request.
" }, "selectedProperties":{ "shape":"SelectedPropertyList", "documentation":"A list of properties whose value histories the request retrieves.
" }, "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." }, "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.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "GetPropertyValueHistoryResponse":{ "type":"structure", "required":["propertyValues"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "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.
" } } }, "GetPropertyValueRequest":{ "type":"structure", "required":[ "selectedProperties", "workspaceId" ], "members":{ "componentName":{ "shape":"Name", "documentation":"The name of the component whose property values the operation returns.
" }, "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" } } }, "GetPropertyValueResponse":{ "type":"structure", "required":["propertyValues"], "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.
" } } }, "GetSceneRequest":{ "type":"structure", "required":[ "sceneId", "workspaceId" ], "members":{ "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
", "location":"uri", "locationName":"sceneId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" } } }, "GetSceneResponse":{ "type":"structure", "required":[ "arn", "contentLocation", "creationDateTime", "sceneId", "updateDateTime", "workspaceId" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the scene.
" }, "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render.
" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the scene.
" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was last updated.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
" } } }, "GetWorkspaceRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "workspaceId":{ "shape":"IdOrArn", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "GetWorkspaceResponse":{ "type":"structure", "required":[ "arn", "creationDateTime", "role", "s3Location", "updateDateTime", "workspaceId" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the workspace.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was created.
" }, "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.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was last updated.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" } } }, "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 }, "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.
" }, "ListComponentTypesFilter":{ "type":"structure", "members":{ "extendsFrom":{ "shape":"ComponentTypeId", "documentation":"The component type that the component types in the list extend.
" }, "isAbstract":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the component types in the list are abstract.
" }, "namespace":{ "shape":"String", "documentation":"The namespace to which the component types in the list belong.
" } }, "documentation":"An object that filters items in a list of component types.
Only one object is accepted as a valid input.
A list of objects that filter the request.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to display.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "ListComponentTypesResponse":{ "type":"structure", "required":[ "componentTypeSummaries", "workspaceId" ], "members":{ "componentTypeSummaries":{ "shape":"ComponentTypeSummaries", "documentation":"A list of objects that contain information about the component types.
" }, "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.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" } } }, "ListEntitiesFilter":{ "type":"structure", "members":{ "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.
" }, "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The parent of the entities in the list.
" } }, "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":{ "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 display.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "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.
" } } }, "ListScenesRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "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.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scenes.
", "location":"uri", "locationName":"workspaceId" } } }, "ListScenesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "sceneSummaries":{ "shape":"SceneSummaries", "documentation":"A list of objects that contain information about the scenes.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceARN"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to display.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "resourceARN":{ "shape":"TwinMakerArn", "documentation":"The ARN of the resource.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "tags":{ "shape":"TagMap", "documentation":"Metadata that you can use to manage a resource.
" } } }, "ListWorkspacesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to display.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ListWorkspacesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The string that specifies the next page of results.
" }, "workspaceSummaries":{ "shape":"WorkspaceSummaries", "documentation":"A list of objects that contain information about the workspaces.
" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":200, "min":0 }, "Name":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z_\\-0-9]+" }, "NextToken":{ "type":"string", "max":17880, "min":0, "pattern":".*" }, "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":{ "parentEntityId":{ "shape":"ParentEntityId", "documentation":"The ID of the parent entity.
" }, "updateType":{ "shape":"ParentEntityUpdateType", "documentation":"The type of the update.
" } }, "documentation":"The parent entity update request.
" }, "ParentEntityUpdateType":{ "type":"string", "enum":[ "UPDATE", "DELETE" ] }, "PropertyDefinitionRequest":{ "type":"structure", "members":{ "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.
" }, "dataType":{ "shape":"DataType", "documentation":"An object that contains information about the data type.
" }, "defaultValue":{ "shape":"DataValue", "documentation":"An object that contains the default value.
" }, "isExternalId":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property ID comes from an external data store.
" }, "isRequiredInEntity":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is required.
" }, "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.
" } }, "documentation":"An object that sets information about a property.
" }, "PropertyDefinitionResponse":{ "type":"structure", "required":[ "dataType", "isExternalId", "isFinal", "isImported", "isInherited", "isRequiredInEntity", "isStoredExternally", "isTimeSeries" ], "members":{ "configuration":{ "shape":"Configuration", "documentation":"A mapping that specifies configuration information about the property.
" }, "dataType":{ "shape":"DataType", "documentation":"An object that contains information about the data type.
" }, "defaultValue":{ "shape":"DataValue", "documentation":"An object that contains the default value.
" }, "isExternalId":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property ID comes from an external data store.
" }, "isFinal":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition can be updated.
" }, "isImported":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition is imported from an external data store.
" }, "isInherited":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property definition is inherited from a parent entity.
" }, "isRequiredInEntity":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether the property is required in an entity.
" }, "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.
" } }, "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"} }, "PropertyFilter":{ "type":"structure", "members":{ "operator":{ "shape":"String", "documentation":"The operator associated with this property filter.
" }, "propertyName":{ "shape":"String", "documentation":"The property name 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 }, "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"} }, "PropertyRequest":{ "type":"structure", "members":{ "definition":{ "shape":"PropertyDefinitionRequest", "documentation":"An object that specifies information about a property.
" }, "updateType":{ "shape":"PropertyUpdateType", "documentation":"The update type of the update property request.
" }, "value":{ "shape":"DataValue", "documentation":"The value of the property.
" } }, "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.
" } }, "documentation":"An object that contains information about a property response.
" }, "PropertyResponses":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"PropertyResponse"} }, "PropertyUpdateType":{ "type":"string", "enum":[ "UPDATE", "DELETE", "CREATE" ] }, "PropertyValue":{ "type":"structure", "required":["value"], "members":{ "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]
" }, "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.
" } }, "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 }, "Relationship":{ "type":"structure", "members":{ "relationshipType":{ "shape":"String", "documentation":"The type of the relationship.
" }, "targetComponentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the target component type associated with this relationship.
" } }, "documentation":"An object that specifies a relationship with another component type.
" }, "RelationshipValue":{ "type":"structure", "members":{ "targetComponentName":{ "shape":"Name", "documentation":"The name of the target component associated with the relationship value.
" }, "targetEntityId":{ "shape":"EntityId", "documentation":"The ID of the target entity associated with this 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/.*" }, "S3Location":{ "type":"string", "max":1024, "min":0, "pattern":".*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([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":".*" }, "SceneSummaries":{ "type":"list", "member":{"shape":"SceneSummary"} }, "SceneSummary":{ "type":"structure", "required":[ "arn", "contentLocation", "creationDateTime", "sceneId", "updateDateTime" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the scene.
" }, "contentLocation":{ "shape":"S3Url", "documentation":"The relative path that specifies the location of the content definition file.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was created.
" }, "description":{ "shape":"Description", "documentation":"The scene description.
" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the scene was last updated.
" } }, "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 }, "State":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" ] }, "Status":{ "type":"structure", "members":{ "error":{ "shape":"ErrorDetails", "documentation":"The error message.
" }, "state":{ "shape":"State", "documentation":"The current state of the entity, component, component type, or workspace.
" } }, "documentation":"An object that represents the status of an entity, component, component type, or workspace.
" }, "String":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "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":[ "componentTypeId", "workspaceId" ], "members":{ "componentTypeId":{ "shape":"ComponentTypeId", "documentation":"The ID of the component type.
", "location":"uri", "locationName":"componentTypeId" }, "description":{ "shape":"Description", "documentation":"The description of the component type.
" }, "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.
" }, "isSingleton":{ "shape":"Boolean", "documentation":"A Boolean value that specifies whether an entity can have more than one component of this 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.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
", "location":"uri", "locationName":"workspaceId" } } }, "UpdateComponentTypeResponse":{ "type":"structure", "required":[ "arn", "componentTypeId", "state", "workspaceId" ], "members":{ "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.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the component type.
" } } }, "UpdateEntityRequest":{ "type":"structure", "required":[ "entityId", "workspaceId" ], "members":{ "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.
" }, "description":{ "shape":"Description", "documentation":"The description of the entity.
" }, "entityId":{ "shape":"EntityId", "documentation":"The ID of the entity.
", "location":"uri", "locationName":"entityId" }, "entityName":{ "shape":"EntityName", "documentation":"The name of the entity.
" }, "parentEntityUpdate":{ "shape":"ParentEntityUpdateRequest", "documentation":"An object that describes the update request for a parent entity.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the entity.
", "location":"uri", "locationName":"workspaceId" } } }, "UpdateEntityResponse":{ "type":"structure", "required":[ "state", "updateDateTime" ], "members":{ "state":{ "shape":"State", "documentation":"The current state of the entity update.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the entity was last updated.
" } } }, "UpdateSceneRequest":{ "type":"structure", "required":[ "sceneId", "workspaceId" ], "members":{ "capabilities":{ "shape":"SceneCapabilities", "documentation":"A list of capabilities that the scene uses to render.
" }, "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.
" }, "sceneId":{ "shape":"Id", "documentation":"The ID of the scene.
", "location":"uri", "locationName":"sceneId" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace that contains the scene.
", "location":"uri", "locationName":"workspaceId" } } }, "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":{ "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "role":{ "shape":"RoleArn", "documentation":"The ARN of the execution role associated with the workspace.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } } }, "UpdateWorkspaceResponse":{ "type":"structure", "required":["updateDateTime"], "members":{ "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time of the current update.
" } } }, "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"} }, "WorkspaceSummaries":{ "type":"list", "member":{"shape":"WorkspaceSummary"} }, "WorkspaceSummary":{ "type":"structure", "required":[ "arn", "creationDateTime", "updateDateTime", "workspaceId" ], "members":{ "arn":{ "shape":"TwinMakerArn", "documentation":"The ARN of the workspace.
" }, "creationDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "updateDateTime":{ "shape":"Timestamp", "documentation":"The date and time when the workspace was last updated.
" }, "workspaceId":{ "shape":"Id", "documentation":"The ID of the workspace.
" } }, "documentation":"An object that contains information about a workspace.
" } }, "documentation":"IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
" }