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.
", "operations": { "BatchPutPropertyValues": "Sets values for multiple time series properties.
", "CancelMetadataTransferJob": "Cancels the metadata transfer job.
", "CreateComponentType": "Creates a component type.
", "CreateEntity": "Creates an entity.
", "CreateMetadataTransferJob": "Creates a new metadata transfer job.
", "CreateScene": "Creates a scene.
", "CreateSyncJob": "This action creates a SyncJob.
", "CreateWorkspace": "Creates a workplace.
", "DeleteComponentType": "Deletes a component type.
", "DeleteEntity": "Deletes an entity.
", "DeleteScene": "Deletes a scene.
", "DeleteSyncJob": "Delete the SyncJob.
", "DeleteWorkspace": "Deletes a workspace.
", "ExecuteQuery": "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.
", "GetEntity": "Retrieves information about an entity.
", "GetMetadataTransferJob": "Gets a nmetadata transfer job.
", "GetPricingPlan": "Gets the pricing plan.
", "GetPropertyValue": "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.
", "GetSyncJob": "Gets the SyncJob.
", "GetWorkspace": "Retrieves information about a workspace.
", "ListComponentTypes": "Lists all component types in a workspace.
", "ListComponents": "This API lists the components of an entity.
", "ListEntities": "Lists all entities in a workspace.
", "ListMetadataTransferJobs": "Lists the metadata transfer jobs.
", "ListProperties": "This API lists the properties of a component.
", "ListScenes": "Lists all scenes in a workspace.
", "ListSyncJobs": "List all SyncJobs.
", "ListSyncResources": "Lists the sync resources.
", "ListTagsForResource": "Lists all tags associated with a resource.
", "ListWorkspaces": "Retrieves information about workspaces in the current account.
", "TagResource": "Adds tags to a resource.
", "UntagResource": "Removes tags from a resource.
", "UpdateComponentType": "Updates information in a component type.
", "UpdateEntity": "Updates an entity.
", "UpdatePricingPlan": "Update the pricing plan.
", "UpdateScene": "Updates a scene.
", "UpdateWorkspace": "Updates a workspace.
" }, "shapes": { "AccessDeniedException": { "base": "Access is denied.
", "refs": { } }, "BatchPutPropertyError": { "base": "An error returned by the BatchPutProperty action.
An object that contains information about errors returned by the BatchPutProperty action.
A Boolean value that specifies whether the property group is inherited from a parent entity
", "ComponentResponse$areAllPropertiesReturned": "This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
", "ComponentResponse$areAllCompositeComponentsReturned": "This flag notes whether all compositeComponents are returned in the API response.
This boolean indicates whether this compositeComponentType is inherited from its parent.
A Boolean value that specifies whether an entity can have more than one component of this type.
", "DataConnector$isNative": "A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
", "DataValue$booleanValue": "A Boolean value.
", "DeleteEntityRequest$isRecursive": "A Boolean value that specifies whether the operation deletes child entities.
", "EntitySummary$hasChildEntities": "An eventual Boolean value that specifies whether the entity has child entities or not.
", "FilterByAsset$includeOffspring": "Includes sub-assets.[need description hekp for this]
", "FilterByAsset$includeAssetModel": "Boolean to include the asset model.
", "FilterByAssetModel$includeOffspring": "Include asset offspring. [need desc.]
", "FilterByAssetModel$includeAssets": "Bolean to include assets.
", "FunctionResponse$isInherited": "Indicates whether this function is inherited.
", "GetComponentTypeResponse$isSingleton": "A Boolean value that specifies whether an entity can have more than one component of this type.
", "GetComponentTypeResponse$isAbstract": "A Boolean value that specifies whether the component type is abstract.
", "GetComponentTypeResponse$isSchemaInitialized": "A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
", "GetEntityResponse$hasChildEntities": "A Boolean value that specifies whether the entity has associated child entities.
", "GetEntityResponse$areAllComponentsReturned": "This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
", "ListComponentTypesFilter$isAbstract": "A Boolean value that specifies whether the component types in the list are abstract.
", "PropertyDefinitionRequest$isRequiredInEntity": "A Boolean value that specifies whether the property is required.
", "PropertyDefinitionRequest$isExternalId": "A Boolean value that specifies whether the property ID comes from an external data store.
", "PropertyDefinitionRequest$isStoredExternally": "A Boolean value that specifies whether the property is stored externally.
", "PropertyDefinitionRequest$isTimeSeries": "A Boolean value that specifies whether the property consists of time series data.
", "PropertyDefinitionResponse$isTimeSeries": "A Boolean value that specifies whether the property consists of time series data.
", "PropertyDefinitionResponse$isRequiredInEntity": "A Boolean value that specifies whether the property is required in an entity.
", "PropertyDefinitionResponse$isExternalId": "A Boolean value that specifies whether the property ID comes from an external data store.
", "PropertyDefinitionResponse$isStoredExternally": "A Boolean value that specifies whether the property is stored externally.
", "PropertyDefinitionResponse$isImported": "A Boolean value that specifies whether the property definition is imported from an external data store.
", "PropertyDefinitionResponse$isFinal": "A Boolean value that specifies whether the property definition can be updated.
", "PropertyDefinitionResponse$isInherited": "A Boolean value that specifies whether the property definition is inherited from a parent entity.
", "PropertyGroupResponse$isInherited": "A Boolean value that specifies whether the property group is inherited from a parent entity
", "PropertyResponse$areAllPropertyValuesReturned": "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.
", "PropertySummary$areAllPropertyValuesReturned": "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.
", "UpdateComponentTypeRequest$isSingleton": "A Boolean value that specifies whether an entity can have more than one component of this type.
" } }, "BundleInformation": { "base": "Information about the pricing bundle.
", "refs": { "PricingPlan$bundleInformation": "The pricing plan's bundle information.
" } }, "BundleName": { "base": null, "refs": { "PricingBundles$member": null } }, "CancelMetadataTransferJobRequest": { "base": null, "refs": { } }, "CancelMetadataTransferJobResponse": { "base": null, "refs": { } }, "ColumnDescription": { "base": "A description of the column in the query results.
", "refs": { "ColumnDescriptions$member": null } }, "ColumnDescriptions": { "base": null, "refs": { "ExecuteQueryResponse$columnDescriptions": "A list of ColumnDescription objects.
" } }, "ColumnName": { "base": null, "refs": { "ColumnDescription$name": "The name of the column description.
" } }, "ColumnType": { "base": null, "refs": { "ColumnDescription$type": "The type of the column description.
" } }, "ComponentPath": { "base": null, "refs": { "ComponentSummary$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
", "CompositeComponentUpdatesMapRequest$key": null, "CompositeComponentsMapRequest$key": null, "EntityPropertyReference$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
", "GetPropertyValueHistoryRequest$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
", "GetPropertyValueRequest$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
", "ListComponentsRequest$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
", "ListPropertiesRequest$componentPath": "This string specifies the path to the composite component, starting from the top-level component.
" } }, "ComponentPropertyGroupRequest": { "base": "The component property group request.
", "refs": { "ComponentPropertyGroupRequests$value": null } }, "ComponentPropertyGroupRequests": { "base": null, "refs": { "ComponentRequest$propertyGroups": "The property groups.
", "ComponentUpdateRequest$propertyGroupUpdates": "The property group updates.
", "CompositeComponentRequest$propertyGroups": "The property groups.
", "CompositeComponentUpdateRequest$propertyGroupUpdates": "The property group updates.
" } }, "ComponentPropertyGroupResponse": { "base": "The component property group response.
", "refs": { "ComponentPropertyGroupResponses$value": null } }, "ComponentPropertyGroupResponses": { "base": null, "refs": { "ComponentResponse$propertyGroups": "The property groups.
", "ComponentSummary$propertyGroups": "The property groups.
" } }, "ComponentRequest": { "base": "An object that sets information about a component type create or update request.
", "refs": { "ComponentsMapRequest$value": null } }, "ComponentResponse": { "base": "An object that returns information about a component type create or update request.
", "refs": { "ComponentsMap$value": null } }, "ComponentSummaries": { "base": null, "refs": { "ListComponentsResponse$componentSummaries": "A list of objects that contain information about the components.
" } }, "ComponentSummary": { "base": "An object that returns information about a component summary.
", "refs": { "ComponentSummaries$member": null, "CompositeComponentResponse$value": null } }, "ComponentTypeId": { "base": null, "refs": { "ComponentRequest$componentTypeId": "The ID of the component type.
", "ComponentResponse$componentTypeId": "The ID of the component type.
", "ComponentSummary$componentTypeId": "The ID of the component type.
", "ComponentTypeSummary$componentTypeId": "The ID of the component type.
", "ComponentUpdateRequest$componentTypeId": "The ID of the component type.
", "CompositeComponentTypeRequest$componentTypeId": "This is the componentTypeId that the compositeComponentType refers to.
This is the componentTypeId that this compositeComponentType refers to.
The ID of the component type.
", "DeleteComponentTypeRequest$componentTypeId": "The ID of the component type to delete.
", "ExtendsFrom$member": null, "FilterByComponentType$componentTypeId": "The component type Id.
", "GetComponentTypeRequest$componentTypeId": "The ID of the component type.
", "GetComponentTypeResponse$componentTypeId": "The ID of the component type.
", "GetPropertyValueHistoryRequest$componentTypeId": "The ID of the component type.
", "GetPropertyValueRequest$componentTypeId": "The ID of the component type whose property values the operation returns.
", "ListComponentTypesFilter$extendsFrom": "The component type that the component types in the list extend.
", "ListEntitiesFilter$componentTypeId": "The ID of the component type in the entities in the list.
", "Relationship$targetComponentTypeId": "The ID of the target component type associated with this relationship.
", "UpdateComponentTypeRequest$componentTypeId": "The ID of the component type.
", "UpdateComponentTypeResponse$componentTypeId": "The ID of the component type.
" } }, "ComponentTypeName": { "base": null, "refs": { "ComponentTypeSummary$componentTypeName": "The component type name.
", "CreateComponentTypeRequest$componentTypeName": "A friendly name for the component type.
", "GetComponentTypeResponse$componentTypeName": "The component type name.
", "UpdateComponentTypeRequest$componentTypeName": "The component type name.
" } }, "ComponentTypeSummaries": { "base": null, "refs": { "ListComponentTypesResponse$componentTypeSummaries": "A list of objects that contain information about the component types.
" } }, "ComponentTypeSummary": { "base": "An object that contains information about a component type.
", "refs": { "ComponentTypeSummaries$member": null } }, "ComponentUpdateRequest": { "base": "The component update request.
", "refs": { "ComponentUpdatesMapRequest$value": null } }, "ComponentUpdateType": { "base": null, "refs": { "ComponentUpdateRequest$updateType": "The update type of the component update request.
", "CompositeComponentUpdateRequest$updateType": "The update type of the component update request.
" } }, "ComponentUpdatesMapRequest": { "base": null, "refs": { "UpdateEntityRequest$componentUpdates": "An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
" } }, "ComponentsMap": { "base": null, "refs": { "GetEntityResponse$components": "An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
" } }, "ComponentsMapRequest": { "base": null, "refs": { "CreateEntityRequest$components": "An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
" } }, "CompositeComponentRequest": { "base": "An object that sets information about the composite component update request.
", "refs": { "CompositeComponentsMapRequest$value": null } }, "CompositeComponentResponse": { "base": null, "refs": { "ComponentResponse$compositeComponents": "This lists objects that contain information about the compositeComponents.
An object that sets information about the composite component types of a component type.
", "refs": { "CompositeComponentTypesRequest$value": null } }, "CompositeComponentTypeResponse": { "base": "An object that returns information about the composite component types of a component type.
", "refs": { "CompositeComponentTypesResponse$value": null } }, "CompositeComponentTypesRequest": { "base": null, "refs": { "CreateComponentTypeRequest$compositeComponentTypes": "This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
An object that sets information about the composite component update request.
", "refs": { "CompositeComponentUpdatesMapRequest$value": null } }, "CompositeComponentUpdatesMapRequest": { "base": null, "refs": { "UpdateEntityRequest$compositeComponentUpdates": "This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
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.
", "PropertyDefinitionResponse$configuration": "A mapping that specifies configuration information about the property.
" } }, "ConflictException": { "base": "A conflict occurred.
", "refs": { } }, "ConnectorFailureException": { "base": "The connector failed.
", "refs": { } }, "ConnectorTimeoutException": { "base": "The connector timed out.
", "refs": { } }, "CreateComponentTypeRequest": { "base": null, "refs": { } }, "CreateComponentTypeResponse": { "base": null, "refs": { } }, "CreateEntityRequest": { "base": null, "refs": { } }, "CreateEntityResponse": { "base": null, "refs": { } }, "CreateMetadataTransferJobRequest": { "base": null, "refs": { } }, "CreateMetadataTransferJobResponse": { "base": null, "refs": { } }, "CreateSceneRequest": { "base": null, "refs": { } }, "CreateSceneResponse": { "base": null, "refs": { } }, "CreateSyncJobRequest": { "base": null, "refs": { } }, "CreateSyncJobResponse": { "base": null, "refs": { } }, "CreateWorkspaceRequest": { "base": null, "refs": { } }, "CreateWorkspaceResponse": { "base": null, "refs": { } }, "DataConnector": { "base": "The data connector.
", "refs": { "FunctionRequest$implementedBy": "The data connector.
", "FunctionResponse$implementedBy": "The data connector.
" } }, "DataType": { "base": "An object that specifies the data type of a property.
", "refs": { "DataType$nestedType": "The nested type in the data type.
", "PropertyDefinitionRequest$dataType": "An object that contains information about the data type.
", "PropertyDefinitionResponse$dataType": "An object that contains information about the data type.
" } }, "DataValue": { "base": "An object that specifies a value for a property.
", "refs": { "DataValueList$member": null, "DataValueMap$value": null, "PropertyDefinitionRequest$defaultValue": "An object that contains the default value.
", "PropertyDefinitionResponse$defaultValue": "An object that contains the default value.
", "PropertyFilter$value": "The value associated with this property filter.
", "PropertyLatestValue$propertyValue": "The value of the property.
", "PropertyRequest$value": "The value of the property.
", "PropertyResponse$value": "The value of the property.
", "PropertySummary$value": "This is the value for the property.
", "PropertyTableValue$value": null, "PropertyValue$value": "An object that specifies a value for a time series property.
" } }, "DataValueList": { "base": null, "refs": { "DataType$allowedValues": "The allowed values for this data type.
", "DataValue$listValue": "A list of multiple values.
" } }, "DataValueMap": { "base": null, "refs": { "DataValue$mapValue": "An object that maps strings to multiple DataValue objects.
The description of the component request.
", "ComponentResponse$description": "The description of the component type.
", "ComponentSummary$description": "The description of the component request.
", "ComponentTypeSummary$description": "The description of the component type.
", "ComponentUpdateRequest$description": "The description of the component type.
", "CompositeComponentRequest$description": "The description of the component type.
", "CompositeComponentUpdateRequest$description": "The description of the component type.
", "CreateComponentTypeRequest$description": "The description of the component type.
", "CreateEntityRequest$description": "The description of the entity.
", "CreateMetadataTransferJobRequest$description": "The metadata transfer job description.
", "CreateSceneRequest$description": "The description for this scene.
", "CreateWorkspaceRequest$description": "The description of the workspace.
", "EntitySummary$description": "The description of the entity.
", "GetComponentTypeResponse$description": "The description of the component type.
", "GetEntityResponse$description": "The description of the entity.
", "GetMetadataTransferJobResponse$description": "The metadata transfer job description.
", "GetSceneResponse$description": "The description of the scene.
", "GetWorkspaceResponse$description": "The description of the workspace.
", "SceneSummary$description": "The scene description.
", "UpdateComponentTypeRequest$description": "The description of the component type.
", "UpdateEntityRequest$description": "The description of the entity.
", "UpdateSceneRequest$description": "The description of this scene.
", "UpdateWorkspaceRequest$description": "The description of the workspace.
", "WorkspaceSummary$description": "The description of the workspace.
" } }, "DestinationConfiguration": { "base": "The [link to action] metadata transfer job destination configuration.
", "refs": { "CreateMetadataTransferJobRequest$destination": "The metadata transfer job destination.
", "GetMetadataTransferJobResponse$destination": "The metadata transfer job's destination.
" } }, "DestinationType": { "base": null, "refs": { "DestinationConfiguration$type": "The destination type.
", "ListMetadataTransferJobsRequest$destinationType": "The metadata transfer job's destination type.
" } }, "Double": { "base": null, "refs": { "DataValue$doubleValue": "A double value.
" } }, "EntityId": { "base": null, "refs": { "CreateEntityRequest$entityId": "The ID of the entity.
", "CreateEntityResponse$entityId": "The ID of the entity.
", "DeleteEntityRequest$entityId": "The ID of the entity to delete.
", "EntityPropertyReference$entityId": "The ID of the entity.
", "EntitySummary$entityId": "The ID of the entity.
", "FilterByEntity$entityId": "The entity Id.
", "GetEntityRequest$entityId": "The ID of the entity.
", "GetEntityResponse$entityId": "The ID of the entity.
", "GetPropertyValueHistoryRequest$entityId": "The ID of the entity.
", "GetPropertyValueRequest$entityId": "The ID of the entity whose property values the operation returns.
", "ListComponentsRequest$entityId": "The ID for the entity whose metadata (component/properties) is returned by the operation.
", "ListPropertiesRequest$entityId": "The ID for the entity whose metadata (component/properties) is returned by the operation.
", "RelationshipValue$targetEntityId": "The ID of the target entity associated with this relationship value.
", "UpdateEntityRequest$entityId": "The ID of the entity.
" } }, "EntityName": { "base": null, "refs": { "CreateEntityRequest$entityName": "The name of the entity.
", "EntitySummary$entityName": "The name of the entity.
", "GetEntityResponse$entityName": "The name of the entity.
", "UpdateEntityRequest$entityName": "The name of the entity.
" } }, "EntityPropertyReference": { "base": "An object that uniquely identifies an entity property.
", "refs": { "PropertyLatestValue$propertyReference": "An object that specifies information about a property.
", "PropertyValueEntry$entityPropertyReference": "An object that contains information about the entity that has the property.
", "PropertyValueHistory$entityPropertyReference": "An object that uniquely identifies an entity property.
" } }, "EntitySummaries": { "base": null, "refs": { "ListEntitiesResponse$entitySummaries": "A list of objects that contain information about the entities.
" } }, "EntitySummary": { "base": "An object that contains information about an entity.
", "refs": { "EntitySummaries$member": null } }, "Entries": { "base": null, "refs": { "BatchPutPropertyValuesRequest$entries": "An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
" } }, "ErrorCode": { "base": null, "refs": { "ErrorDetails$code": "The error code.
" } }, "ErrorDetails": { "base": "The error details.
", "refs": { "MetadataTransferJobStatus$error": "The metadata transfer job error.
", "Status$error": "The error message.
", "SyncJobStatus$error": "The SyncJob error.
", "SyncResourceStatus$error": "The status error.
" } }, "ErrorEntries": { "base": null, "refs": { "BatchPutPropertyValuesResponse$errorEntries": "Entries that caused errors in the batch put operation.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "ConnectorFailureException$message": null, "ConnectorTimeoutException$message": null, "ErrorDetails$message": "The error message.
", "InternalServerException$message": null, "QueryTimeoutException$message": null, "ResourceNotFoundException$message": null, "SceneError$message": "The SceneError message.
", "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "Errors": { "base": null, "refs": { "BatchPutPropertyErrorEntry$errors": "A list of objects that contain information about errors returned by the BatchPutProperty action.
An expression that produces the value.
" } }, "ExtendsFrom": { "base": null, "refs": { "CreateComponentTypeRequest$extendsFrom": "Specifies the parent component type to extend.
", "GetComponentTypeResponse$extendsFrom": "The name of the parent component type that this component type extends.
", "UpdateComponentTypeRequest$extendsFrom": "Specifies the component type that this component type extends.
" } }, "ExternalIdProperty": { "base": null, "refs": { "EntityPropertyReference$externalIdProperty": "A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
" } }, "FilterByAsset": { "base": "Filter by asset. [TwinMaker asset]
", "refs": { "IotSiteWiseSourceConfigurationFilter$filterByAsset": "Filter by asset.
" } }, "FilterByAssetModel": { "base": "Filter by asset model.
", "refs": { "IotSiteWiseSourceConfigurationFilter$filterByAssetModel": "Filter by asset model.
" } }, "FilterByComponentType": { "base": "Filter by component type.
", "refs": { "IotTwinMakerSourceConfigurationFilter$filterByComponentType": "Filter by component type.
" } }, "FilterByEntity": { "base": "Vilter by entity.
", "refs": { "IotTwinMakerSourceConfigurationFilter$filterByEntity": "Filter by entity.
" } }, "FunctionRequest": { "base": "The function request body.
", "refs": { "FunctionsRequest$value": null } }, "FunctionResponse": { "base": "The function response.
", "refs": { "FunctionsResponse$value": null } }, "FunctionsRequest": { "base": null, "refs": { "CreateComponentTypeRequest$functions": "An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
", "UpdateComponentTypeRequest$functions": "An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
" } }, "FunctionsResponse": { "base": null, "refs": { "GetComponentTypeResponse$functions": "An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
" } }, "GeneratedSceneMetadataMap": { "base": null, "refs": { "GetSceneResponse$generatedSceneMetadata": "The generated scene metadata.
" } }, "GetComponentTypeRequest": { "base": null, "refs": { } }, "GetComponentTypeResponse": { "base": null, "refs": { } }, "GetEntityRequest": { "base": null, "refs": { } }, "GetEntityResponse": { "base": null, "refs": { } }, "GetMetadataTransferJobRequest": { "base": null, "refs": { } }, "GetMetadataTransferJobResponse": { "base": null, "refs": { } }, "GetPricingPlanRequest": { "base": null, "refs": { } }, "GetPricingPlanResponse": { "base": null, "refs": { } }, "GetPropertyValueHistoryRequest": { "base": null, "refs": { } }, "GetPropertyValueHistoryResponse": { "base": null, "refs": { } }, "GetPropertyValueRequest": { "base": null, "refs": { } }, "GetPropertyValueResponse": { "base": null, "refs": { } }, "GetSceneRequest": { "base": null, "refs": { } }, "GetSceneResponse": { "base": null, "refs": { } }, "GetSyncJobRequest": { "base": null, "refs": { } }, "GetSyncJobResponse": { "base": null, "refs": { } }, "GetWorkspaceRequest": { "base": null, "refs": { } }, "GetWorkspaceResponse": { "base": null, "refs": { } }, "GroupType": { "base": null, "refs": { "ComponentPropertyGroupRequest$groupType": "The group type.
", "ComponentPropertyGroupResponse$groupType": "The group type.
", "PropertyGroupRequest$groupType": "The group type.
", "PropertyGroupResponse$groupType": "The group types.
" } }, "Id": { "base": null, "refs": { "BatchPutPropertyValuesRequest$workspaceId": "The ID of the workspace that contains the properties to set.
", "CancelMetadataTransferJobRequest$metadataTransferJobId": "The metadata transfer job Id.
", "CancelMetadataTransferJobResponse$metadataTransferJobId": "The metadata transfer job Id.
", "CreateComponentTypeRequest$workspaceId": "The ID of the workspace that contains the component type.
", "CreateEntityRequest$workspaceId": "The ID of the workspace that contains the entity.
", "CreateMetadataTransferJobRequest$metadataTransferJobId": "The metadata transfer job Id.
", "CreateMetadataTransferJobResponse$metadataTransferJobId": "The metadata transfer job Id.
", "CreateSceneRequest$workspaceId": "The ID of the workspace that contains the scene.
", "CreateSceneRequest$sceneId": "The ID of the scene.
", "CreateSyncJobRequest$workspaceId": "The workspace ID.
", "CreateWorkspaceRequest$workspaceId": "The ID of the workspace.
", "DeleteComponentTypeRequest$workspaceId": "The ID of the workspace that contains the component type.
", "DeleteEntityRequest$workspaceId": "The ID of the workspace that contains the entity to delete.
", "DeleteSceneRequest$workspaceId": "The ID of the workspace.
", "DeleteSceneRequest$sceneId": "The ID of the scene to delete.
", "DeleteSyncJobRequest$workspaceId": "The workspace ID.
", "DeleteWorkspaceRequest$workspaceId": "The ID of the workspace to delete.
", "ExecuteQueryRequest$workspaceId": "The ID of the workspace.
", "GetComponentTypeRequest$workspaceId": "The ID of the workspace that contains the component type.
", "GetComponentTypeResponse$workspaceId": "The ID of the workspace that contains the component type.
", "GetEntityRequest$workspaceId": "The ID of the workspace.
", "GetEntityResponse$workspaceId": "The ID of the workspace.
", "GetMetadataTransferJobRequest$metadataTransferJobId": "The metadata transfer job Id.
", "GetMetadataTransferJobResponse$metadataTransferJobId": "The metadata transfer job Id.
", "GetPropertyValueHistoryRequest$workspaceId": "The ID of the workspace.
", "GetPropertyValueRequest$workspaceId": "The ID of the workspace whose values the operation returns.
", "GetSceneRequest$workspaceId": "The ID of the workspace that contains the scene.
", "GetSceneRequest$sceneId": "The ID of the scene.
", "GetSceneResponse$workspaceId": "The ID of the workspace that contains the scene.
", "GetSceneResponse$sceneId": "The ID of the scene.
", "GetSyncJobRequest$workspaceId": "The workspace ID.
", "GetSyncJobResponse$workspaceId": "The ID of the workspace that contains the sync job.
", "GetWorkspaceResponse$workspaceId": "The ID of the workspace.
", "ListComponentTypesRequest$workspaceId": "The ID of the workspace.
", "ListComponentTypesResponse$workspaceId": "The ID of the workspace.
", "ListComponentsRequest$workspaceId": "The workspace ID.
", "ListEntitiesRequest$workspaceId": "The ID of the workspace.
", "ListMetadataTransferJobsFilter$workspaceId": "The workspace Id.
", "ListPropertiesRequest$workspaceId": "The workspace ID.
", "ListScenesRequest$workspaceId": "The ID of the workspace that contains the scenes.
", "ListSyncJobsRequest$workspaceId": "The ID of the workspace that contains the sync job.
", "ListSyncResourcesRequest$workspaceId": "The ID of the workspace that contains the sync job.
", "MetadataTransferJobSummary$metadataTransferJobId": "The metadata transfer job summary Id.
", "SceneSummary$sceneId": "The ID of the scene.
", "SyncJobSummary$workspaceId": "The ID of the workspace that contains the sync job.
", "SyncResourceFilter$resourceId": "The sync resource filter resource ID.
", "SyncResourceFilter$externalId": "The external ID.
", "SyncResourceSummary$externalId": "The external ID.
", "SyncResourceSummary$resourceId": "The resource ID.
", "UpdateComponentTypeRequest$workspaceId": "The ID of the workspace.
", "UpdateComponentTypeResponse$workspaceId": "The ID of the workspace that contains the component type.
", "UpdateEntityRequest$workspaceId": "The ID of the workspace that contains the entity.
", "UpdateSceneRequest$workspaceId": "The ID of the workspace that contains the scene.
", "UpdateSceneRequest$sceneId": "The ID of the scene.
", "UpdateWorkspaceRequest$workspaceId": "The ID of the workspace.
", "WorkspaceSummary$workspaceId": "The ID of the workspace.
" } }, "IdOrArn": { "base": null, "refs": { "GetWorkspaceRequest$workspaceId": "The ID of the workspace.
" } }, "Integer": { "base": null, "refs": { "DataValue$integerValue": "An integer value.
", "MetadataTransferJobProgress$totalCount": "The total count. [of what]
", "MetadataTransferJobProgress$succeededCount": "The succeeded count.
", "MetadataTransferJobProgress$skippedCount": "The skipped count.
", "MetadataTransferJobProgress$failedCount": "The failed count.
", "MetadataTransferJobStatus$queuedPosition": "The queued position.
" } }, "InternalServerException": { "base": "An unexpected error has occurred.
", "refs": { } }, "InterpolationParameters": { "base": "An object that specifies how to interpolate data in a list.
", "refs": { "GetPropertyValueHistoryRequest$interpolation": "An object that specifies the interpolation type and the interval over which to interpolate data.
" } }, "InterpolationType": { "base": null, "refs": { "InterpolationParameters$interpolationType": "The interpolation type.
" } }, "IntervalInSeconds": { "base": null, "refs": { "InterpolationParameters$intervalInSeconds": "The interpolation time interval in seconds.
" } }, "IotSiteWiseSourceConfiguration": { "base": "The metadata transfer job AWS IoT SiteWise source configuration.
", "refs": { "SourceConfiguration$iotSiteWiseConfiguration": "The source configuration IoT SiteWise configuration.
" } }, "IotSiteWiseSourceConfigurationFilter": { "base": "The AWS IoT SiteWise soucre configuration filter.[need held with desc here]
", "refs": { "IotSiteWiseSourceConfigurationFilters$member": null } }, "IotSiteWiseSourceConfigurationFilters": { "base": null, "refs": { "IotSiteWiseSourceConfiguration$filters": "The AWS IoT SiteWise soucre configuration filters.
" } }, "IotTwinMakerDestinationConfiguration": { "base": "The metadata transfer job AWS IoT TwinMaker destination configuration.
", "refs": { "DestinationConfiguration$iotTwinMakerConfiguration": "The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
" } }, "IotTwinMakerSourceConfiguration": { "base": "The metadata transfer job AWS IoT TwinMaker source configuration.
", "refs": { "SourceConfiguration$iotTwinMakerConfiguration": "The source configuration IoT TwinMaker configuration.
" } }, "IotTwinMakerSourceConfigurationFilter": { "base": "The metadata transfer job AWS IoT TwinMaker source configuration filter.
", "refs": { "IotTwinMakerSourceConfigurationFilters$member": null } }, "IotTwinMakerSourceConfigurationFilters": { "base": null, "refs": { "IotTwinMakerSourceConfiguration$filters": "The metadata transfer job AWS IoT TwinMaker source configuration filters.
" } }, "LambdaArn": { "base": null, "refs": { "LambdaFunction$arn": "The ARN of the Lambda function.
" } }, "LambdaFunction": { "base": "The Lambda function.
", "refs": { "DataConnector$lambda": "The Lambda function associated with this data connector.
" } }, "LinkedService": { "base": null, "refs": { "LinkedServices$member": null } }, "LinkedServices": { "base": null, "refs": { "GetWorkspaceResponse$linkedServices": "A list of services that are linked to the workspace.
", "WorkspaceSummary$linkedServices": "A list of services that are linked to the workspace.
" } }, "ListComponentTypesFilter": { "base": "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.
" } }, "ListComponentTypesRequest": { "base": null, "refs": { } }, "ListComponentTypesResponse": { "base": null, "refs": { } }, "ListComponentsRequest": { "base": null, "refs": { } }, "ListComponentsResponse": { "base": null, "refs": { } }, "ListEntitiesFilter": { "base": "An object that filters items in a list of entities.
", "refs": { "ListEntitiesFilters$member": null } }, "ListEntitiesFilters": { "base": null, "refs": { "ListEntitiesRequest$filters": "A list of objects that filter the request.
Only one object is accepted as a valid input.
The ListMetadataTransferJobs filter.
", "refs": { "ListMetadataTransferJobsFilters$member": null } }, "ListMetadataTransferJobsFilters": { "base": null, "refs": { "ListMetadataTransferJobsRequest$filters": "An object that filters metadata transfer jobs.
" } }, "ListMetadataTransferJobsRequest": { "base": null, "refs": { } }, "ListMetadataTransferJobsResponse": { "base": null, "refs": { } }, "ListPropertiesRequest": { "base": null, "refs": { } }, "ListPropertiesResponse": { "base": null, "refs": { } }, "ListScenesRequest": { "base": null, "refs": { } }, "ListScenesResponse": { "base": null, "refs": { } }, "ListSyncJobsRequest": { "base": null, "refs": { } }, "ListSyncJobsResponse": { "base": null, "refs": { } }, "ListSyncResourcesRequest": { "base": null, "refs": { } }, "ListSyncResourcesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListWorkspacesRequest": { "base": null, "refs": { } }, "ListWorkspacesResponse": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "DataValue$longValue": "A long value.
", "PricingPlan$billableEntityCount": "The billable entity count.
" } }, "MaxResults": { "base": null, "refs": { "GetPropertyValueHistoryRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
", "GetPropertyValueRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
", "ListComponentTypesRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
", "ListComponentTypesResponse$maxResults": "Specifies the maximum number of results to display.
", "ListComponentsRequest$maxResults": "The maximum number of results returned at one time. The default is 25.
", "ListEntitiesRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
", "ListMetadataTransferJobsRequest$maxResults": "The maximum number of results to return at one time.
", "ListPropertiesRequest$maxResults": "The maximum number of results returned at one time. The default is 25.
", "ListScenesRequest$maxResults": "Specifies the maximum number of results to display.
", "ListSyncJobsRequest$maxResults": "The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
", "ListSyncResourcesRequest$maxResults": "The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
", "ListTagsForResourceRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
", "ListWorkspacesRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" } }, "MetadataTransferJobProgress": { "base": "The metadata transfer job's progress.
", "refs": { "CancelMetadataTransferJobResponse$progress": "The metadata transfer job's progress.
", "GetMetadataTransferJobResponse$progress": "The metadata transfer job's progress.
", "MetadataTransferJobSummary$progress": "The metadata transfer job summary progess.
" } }, "MetadataTransferJobState": { "base": null, "refs": { "ListMetadataTransferJobsFilter$state": "The filter state.
", "MetadataTransferJobStatus$state": "The metadata transfer job state.
" } }, "MetadataTransferJobStatus": { "base": "The metadata transfer job status.
", "refs": { "CancelMetadataTransferJobResponse$status": "The metadata transfer job's status.
", "CreateMetadataTransferJobResponse$status": "The metadata transfer job response status.
", "GetMetadataTransferJobResponse$status": "The metadata transfer job's status.
", "MetadataTransferJobSummary$status": "The metadata transfer job summary status.
" } }, "MetadataTransferJobSummaries": { "base": null, "refs": { "ListMetadataTransferJobsResponse$metadataTransferJobSummaries": "The metadata transfer job summaries.
" } }, "MetadataTransferJobSummary": { "base": "The metadata transfer job summary.
", "refs": { "MetadataTransferJobSummaries$member": null } }, "Name": { "base": null, "refs": { "ComponentPropertyGroupRequests$key": null, "ComponentPropertyGroupResponses$key": null, "ComponentResponse$componentName": "The name of the component.
", "ComponentSummary$componentName": "The name of the component.
", "ComponentUpdatesMapRequest$key": null, "ComponentsMap$key": null, "ComponentsMapRequest$key": null, "CompositeComponentResponse$key": null, "CompositeComponentTypesRequest$key": null, "CompositeComponentTypesResponse$key": null, "Configuration$key": null, "EntityPropertyReference$componentName": "The name of the component.
", "EntityPropertyReference$propertyName": "The name of the property.
", "FunctionsRequest$key": null, "FunctionsResponse$key": null, "GeneratedSceneMetadataMap$key": null, "GetPropertyValueHistoryRequest$componentName": "The name of the component.
", "GetPropertyValueRequest$componentName": "The name of the component whose property values the operation returns.
", "GetPropertyValueRequest$propertyGroupName": "The property group name.
", "ListPropertiesRequest$componentName": "The name of the component whose properties are returned by the operation.
", "PropertyDefinitionsRequest$key": null, "PropertyDefinitionsResponse$key": null, "PropertyGroupsRequest$key": null, "PropertyGroupsResponse$key": null, "PropertyLatestValueMap$key": null, "PropertyNames$member": null, "PropertyRequests$key": null, "PropertyResponses$key": null, "PropertySummary$propertyName": "This is the name of the property.
", "PropertyTableValue$key": null, "RelationshipValue$targetComponentName": "The name of the target component associated with the relationship value.
", "RequiredProperties$member": null, "SceneMetadataMap$key": null } }, "NextToken": { "base": null, "refs": { "ExecuteQueryRequest$nextToken": "The string that specifies the next page of results.
", "ExecuteQueryResponse$nextToken": "The string that specifies the next page of results.
", "GetPropertyValueHistoryRequest$nextToken": "The string that specifies the next page of results.
", "GetPropertyValueHistoryResponse$nextToken": "The string that specifies the next page of results.
", "GetPropertyValueRequest$nextToken": "The string that specifies the next page of results.
", "GetPropertyValueResponse$nextToken": "The string that specifies the next page of results.
", "ListComponentTypesRequest$nextToken": "The string that specifies the next page of results.
", "ListComponentTypesResponse$nextToken": "The string that specifies the next page of results.
", "ListComponentsRequest$nextToken": "The string that specifies the next page of results.
", "ListComponentsResponse$nextToken": "The string that specifies the next page of component results.
", "ListEntitiesRequest$nextToken": "The string that specifies the next page of results.
", "ListEntitiesResponse$nextToken": "The string that specifies the next page of results.
", "ListMetadataTransferJobsRequest$nextToken": "The string that specifies the next page of results.
", "ListMetadataTransferJobsResponse$nextToken": "The string that specifies the next page of results.
", "ListPropertiesRequest$nextToken": "The string that specifies the next page of results.
", "ListPropertiesResponse$nextToken": "The string that specifies the next page of property results.
", "ListScenesRequest$nextToken": "The string that specifies the next page of results.
", "ListScenesResponse$nextToken": "The string that specifies the next page of results.
", "ListSyncJobsRequest$nextToken": "The string that specifies the next page of results.
", "ListSyncJobsResponse$nextToken": "The string that specifies the next page of results.
", "ListSyncResourcesRequest$nextToken": "The string that specifies the next page of results.
", "ListSyncResourcesResponse$nextToken": "The string that specifies the next page of results.
", "ListTagsForResourceRequest$nextToken": "The string that specifies the next page of results.
", "ListTagsForResourceResponse$nextToken": "The string that specifies the next page of results.
", "ListWorkspacesRequest$nextToken": "The string that specifies the next page of results.
", "ListWorkspacesResponse$nextToken": "The string that specifies the next page of results.
" } }, "Order": { "base": null, "refs": { "OrderBy$order": "The set order that filters results.
" } }, "OrderBy": { "base": "Filter criteria that orders the return output. It can be sorted in ascending or descending order.
", "refs": { "OrderByList$member": null } }, "OrderByList": { "base": null, "refs": { "TabularConditions$orderBy": "Filter criteria that orders the output. It can be sorted in ascending or descending order.
" } }, "OrderByTime": { "base": null, "refs": { "GetPropertyValueHistoryRequest$orderByTime": "The time direction to use in the result order.
" } }, "ParentEntityId": { "base": null, "refs": { "CreateEntityRequest$parentEntityId": "The ID of the entity's parent entity.
", "EntitySummary$parentEntityId": "The ID of the parent entity.
", "GetEntityResponse$parentEntityId": "The ID of the parent entity for this entity.
", "ListEntitiesFilter$parentEntityId": "The parent of the entities in the list.
", "ParentEntityUpdateRequest$parentEntityId": "The ID of the parent entity.
" } }, "ParentEntityUpdateRequest": { "base": "The parent entity update request.
", "refs": { "UpdateEntityRequest$parentEntityUpdate": "An object that describes the update request for a parent entity.
" } }, "ParentEntityUpdateType": { "base": null, "refs": { "ParentEntityUpdateRequest$updateType": "The type of the update.
" } }, "PricingBundles": { "base": null, "refs": { "BundleInformation$bundleNames": "The bundle names.
", "UpdatePricingPlanRequest$bundleNames": "The bundle names.
" } }, "PricingMode": { "base": null, "refs": { "PricingPlan$pricingMode": "The pricing mode.
", "UpdatePricingPlanRequest$pricingMode": "The pricing mode.
" } }, "PricingPlan": { "base": "The pricing plan.
", "refs": { "GetPricingPlanResponse$currentPricingPlan": "The chosen pricing plan for the current billing cycle.
", "GetPricingPlanResponse$pendingPricingPlan": "The pending pricing plan.
", "UpdatePricingPlanResponse$currentPricingPlan": "Update the current pricing plan.
", "UpdatePricingPlanResponse$pendingPricingPlan": "Update the pending pricing plan.
" } }, "PricingTier": { "base": null, "refs": { "BundleInformation$pricingTier": "The pricing tier.
" } }, "PropertyDefinitionRequest": { "base": "An object that sets information about a property.
", "refs": { "PropertyDefinitionsRequest$value": null, "PropertyRequest$definition": "An object that specifies information about a property.
" } }, "PropertyDefinitionResponse": { "base": "An object that contains response data from a property definition request.
", "refs": { "PropertyDefinitionsResponse$value": null, "PropertyResponse$definition": "An object that specifies information about a property.
", "PropertySummary$definition": "This is the schema for the property.
" } }, "PropertyDefinitionsRequest": { "base": null, "refs": { "CreateComponentTypeRequest$propertyDefinitions": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
", "UpdateComponentTypeRequest$propertyDefinitions": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" } }, "PropertyDefinitionsResponse": { "base": null, "refs": { "GetComponentTypeResponse$propertyDefinitions": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" } }, "PropertyDisplayName": { "base": null, "refs": { "PropertyDefinitionRequest$displayName": "A friendly name for the property.
", "PropertyDefinitionResponse$displayName": "A friendly name for the property.
" } }, "PropertyFilter": { "base": "An object that filters items returned by a property request.
", "refs": { "PropertyFilters$member": null } }, "PropertyFilters": { "base": null, "refs": { "GetPropertyValueHistoryRequest$propertyFilters": "A list of objects that filter the property value history request.
", "TabularConditions$propertyFilters": "You can filter the request using various logical operators and a key-value format. For example:
{\"key\": \"serverType\", \"value\": \"webServer\"}
The property group response
", "refs": { "PropertyGroupsResponse$value": null } }, "PropertyGroupUpdateType": { "base": null, "refs": { "ComponentPropertyGroupRequest$updateType": "The update type.
" } }, "PropertyGroupsRequest": { "base": null, "refs": { "CreateComponentTypeRequest$propertyGroups": "", "UpdateComponentTypeRequest$propertyGroups": "The property groups.
" } }, "PropertyGroupsResponse": { "base": null, "refs": { "GetComponentTypeResponse$propertyGroups": "The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
" } }, "PropertyLatestValue": { "base": "The latest value of the property.
", "refs": { "PropertyLatestValueMap$value": null } }, "PropertyLatestValueMap": { "base": null, "refs": { "GetPropertyValueResponse$propertyValues": "An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.
" } }, "PropertyNames": { "base": null, "refs": { "ComponentPropertyGroupRequest$propertyNames": "The property names.
", "ComponentPropertyGroupResponse$propertyNames": "The names of properties
", "PropertyGroupRequest$propertyNames": "The names of properties.
", "PropertyGroupResponse$propertyNames": "The names of properties.
" } }, "PropertyRequest": { "base": "An object that sets information about a property.
", "refs": { "PropertyRequests$value": null } }, "PropertyRequests": { "base": null, "refs": { "ComponentRequest$properties": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
", "ComponentUpdateRequest$propertyUpdates": "An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
", "CompositeComponentRequest$properties": "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.
", "CompositeComponentUpdateRequest$propertyUpdates": "An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
" } }, "PropertyResponse": { "base": "An object that contains information about a property response.
", "refs": { "PropertyResponses$value": null } }, "PropertyResponses": { "base": null, "refs": { "ComponentResponse$properties": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
" } }, "PropertySummaries": { "base": null, "refs": { "ListPropertiesResponse$propertySummaries": "A list of objects that contain information about the properties.
" } }, "PropertySummary": { "base": "This is an object that contains the information of a property.
", "refs": { "PropertySummaries$member": null } }, "PropertyTableValue": { "base": null, "refs": { "TabularPropertyValue$member": null } }, "PropertyUpdateType": { "base": null, "refs": { "PropertyRequest$updateType": "The update type of the update property request.
" } }, "PropertyValue": { "base": "An object that contains information about a value for a time series property.
", "refs": { "PropertyValues$member": null, "Values$member": null } }, "PropertyValueEntry": { "base": "An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
", "refs": { "BatchPutPropertyError$entry": "An object that contains information about errors returned by the BatchPutProperty action.
The history of values for a time series property.
", "refs": { "PropertyValueList$member": null } }, "PropertyValueList": { "base": null, "refs": { "GetPropertyValueHistoryResponse$propertyValues": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
" } }, "PropertyValues": { "base": null, "refs": { "PropertyValueEntry$propertyValues": "A list of objects that specify time series property values.
" } }, "QueryResultValue": { "base": null, "refs": { "RowData$member": null } }, "QueryServiceMaxResults": { "base": null, "refs": { "ExecuteQueryRequest$maxResults": "The maximum number of results to return at one time. The default is 50.
" } }, "QueryStatement": { "base": null, "refs": { "ExecuteQueryRequest$queryStatement": "The query statement.
" } }, "QueryTimeoutException": { "base": "The query timeout exception.
", "refs": { } }, "Relationship": { "base": "An object that specifies a relationship with another component type.
", "refs": { "DataType$relationship": "A relationship that associates a component with another component.
" } }, "RelationshipValue": { "base": "A value that associates a component and an entity.
", "refs": { "DataValue$relationshipValue": "A value that relates a component to another component.
" } }, "RequiredProperties": { "base": null, "refs": { "FunctionRequest$requiredProperties": "The required properties of the function.
", "FunctionResponse$requiredProperties": "The required properties of the function.
" } }, "ResourceNotFoundException": { "base": "The resource wasn't found.
", "refs": { } }, "RoleArn": { "base": null, "refs": { "CreateSyncJobRequest$syncRole": "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.
", "CreateWorkspaceRequest$role": "The ARN of the execution role associated with the workspace.
", "GetMetadataTransferJobResponse$metadataTransferJobRole": "The metadata transfer job's role.
", "GetSyncJobResponse$syncRole": "The sync IAM role.
", "GetWorkspaceResponse$role": "The ARN of the execution role associated with the workspace.
", "UpdateWorkspaceRequest$role": "The ARN of the execution role associated with the workspace.
" } }, "Row": { "base": "Represents a single row in the query results.
", "refs": { "Rows$member": null } }, "RowData": { "base": null, "refs": { "Row$rowData": "The data in a row of query results.
" } }, "Rows": { "base": null, "refs": { "ExecuteQueryResponse$rows": "Represents a single row in the query results.
" } }, "S3DestinationConfiguration": { "base": "The S3 destination configuration.
", "refs": { "DestinationConfiguration$s3Configuration": "The metadata transfer job S3 configuration. [need to add S3 entity]
" } }, "S3DestinationLocation": { "base": null, "refs": { "S3DestinationConfiguration$location": "The S3 destination configuration location.
" } }, "S3Location": { "base": null, "refs": { "CreateWorkspaceRequest$s3Location": "The ARN of the S3 bucket where resources associated with the workspace are stored.
", "GetWorkspaceResponse$s3Location": "The ARN of the S3 bucket where resources associated with the workspace are stored.
", "UpdateWorkspaceRequest$s3Location": "The ARN of the S3 bucket where resources associated with the workspace are stored.
" } }, "S3SourceConfiguration": { "base": "The S3 destination source configuration.
", "refs": { "SourceConfiguration$s3Configuration": "The source configuration S3 configuration.
" } }, "S3SourceLocation": { "base": null, "refs": { "S3SourceConfiguration$location": "The S3 destination source configuration location.
" } }, "S3Url": { "base": null, "refs": { "CreateSceneRequest$contentLocation": "The relative path that specifies the location of the content definition file.
", "GetSceneResponse$contentLocation": "The relative path that specifies the location of the content definition file.
", "SceneSummary$contentLocation": "The relative path that specifies the location of the content definition file.
", "UpdateSceneRequest$contentLocation": "The relative path that specifies the location of the content definition file.
" } }, "SceneCapabilities": { "base": null, "refs": { "CreateSceneRequest$capabilities": "A list of capabilities that the scene uses to render itself.
", "GetSceneResponse$capabilities": "A list of capabilities that the scene uses to render.
", "UpdateSceneRequest$capabilities": "A list of capabilities that the scene uses to render.
" } }, "SceneCapability": { "base": null, "refs": { "SceneCapabilities$member": null } }, "SceneError": { "base": "The scene error.
", "refs": { "GetSceneResponse$error": "The SceneResponse error.
" } }, "SceneErrorCode": { "base": null, "refs": { "SceneError$code": "The SceneError code.
" } }, "SceneMetadataMap": { "base": null, "refs": { "CreateSceneRequest$sceneMetadata": "The request metadata.
", "GetSceneResponse$sceneMetadata": "The response metadata.
", "UpdateSceneRequest$sceneMetadata": "The scene metadata.
" } }, "SceneMetadataValue": { "base": null, "refs": { "GeneratedSceneMetadataMap$value": null, "SceneMetadataMap$value": null } }, "SceneSummaries": { "base": null, "refs": { "ListScenesResponse$sceneSummaries": "A list of objects that contain information about the scenes.
" } }, "SceneSummary": { "base": "An object that contains information about a scene.
", "refs": { "SceneSummaries$member": null } }, "Scope": { "base": null, "refs": { "FunctionRequest$scope": "The scope of the function.
", "FunctionResponse$scope": "The scope of the function.
" } }, "SelectedPropertyList": { "base": null, "refs": { "GetPropertyValueHistoryRequest$selectedProperties": "A list of properties whose value histories the request retrieves.
", "GetPropertyValueRequest$selectedProperties": "The properties whose values the operation returns.
" } }, "ServiceQuotaExceededException": { "base": "The service quota was exceeded.
", "refs": { } }, "SiteWiseExternalId": { "base": null, "refs": { "FilterByAsset$assetExternalId": "The external-Id property of an asset.
", "FilterByAssetModel$assetModelExternalId": "The external-Id property of an asset model.
" } }, "SourceConfiguration": { "base": "The source configuration.
", "refs": { "SourceConfigurations$member": null } }, "SourceConfigurations": { "base": null, "refs": { "CreateMetadataTransferJobRequest$sources": "The metadata transfer job sources.
", "GetMetadataTransferJobResponse$sources": "The metadata transfer job's sources.
" } }, "SourceType": { "base": null, "refs": { "ListMetadataTransferJobsRequest$sourceType": "The metadata transfer job's source type.
", "SourceConfiguration$type": "The source configuration type.
" } }, "State": { "base": null, "refs": { "CreateComponentTypeResponse$state": "The current state of the component type.
", "CreateEntityResponse$state": "The current state of the entity.
", "DeleteComponentTypeResponse$state": "The current state of the component type to be deleted.
", "DeleteEntityResponse$state": "The current state of the deleted entity.
", "Status$state": "The current state of the entity, component, component type, or workspace.
", "UpdateComponentTypeResponse$state": "The current state of the component type.
", "UpdateEntityResponse$state": "The current state of the entity update.
" } }, "Status": { "base": "An object that represents the status of an entity, component, component type, or workspace.
", "refs": { "ComponentResponse$status": "The status of the component type.
", "ComponentSummary$status": "The status of the component type.
", "ComponentTypeSummary$status": "The current status of the component type.
", "EntitySummary$status": "The current status of the entity.
", "GetComponentTypeResponse$status": "The current status of the component type.
", "GetEntityResponse$status": "The current status of the entity.
" } }, "String": { "base": null, "refs": { "BatchPutPropertyError$errorCode": "The error code.
", "BatchPutPropertyError$errorMessage": "The error message.
", "ComponentResponse$definedIn": "The name of the property definition set in the request.
", "ComponentSummary$definedIn": "The name of the property definition set in the request.
", "DataType$unitOfMeasure": "The unit of measure used in this data type.
", "DataValue$stringValue": "A string value.
", "DataValueMap$key": null, "ExternalIdProperty$key": null, "ExternalIdProperty$value": null, "GetMetadataTransferJobResponse$reportUrl": "The metadata transfer job's report URL.
", "ListComponentTypesFilter$namespace": "The namespace to which the component types in the list belong.
", "ListEntitiesFilter$externalId": "The external-Id property of a component. The external-Id property is the primary key of an external storage system.
", "OrderBy$propertyName": "The property name.
", "PropertyFilter$propertyName": "The property name associated with this property filter.
", "PropertyFilter$operator": "The operator associated with this property filter.
", "Relationship$relationshipType": "The type of the relationship.
", "SelectedPropertyList$member": null } }, "SyncJobState": { "base": null, "refs": { "CreateSyncJobResponse$state": "The SyncJob response state.
", "DeleteSyncJobResponse$state": "The SyncJob response state.
", "SyncJobStatus$state": "The SyncJob status state.
" } }, "SyncJobStatus": { "base": "The SyncJob status.
", "refs": { "GetSyncJobResponse$status": "The SyncJob response status.
", "SyncJobSummary$status": "The SyncJob summaries status.
" } }, "SyncJobSummaries": { "base": null, "refs": { "ListSyncJobsResponse$syncJobSummaries": "The listed SyncJob summaries.
" } }, "SyncJobSummary": { "base": "The SyncJob summary.
", "refs": { "SyncJobSummaries$member": null } }, "SyncResourceFilter": { "base": "The sync resource filter.
", "refs": { "SyncResourceFilters$member": null } }, "SyncResourceFilters": { "base": null, "refs": { "ListSyncResourcesRequest$filters": "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 sync resource filter's state.
", "SyncResourceStatus$state": "The sync resource status state.
" } }, "SyncResourceStatus": { "base": "The sync resource status.
", "refs": { "SyncResourceSummary$status": "The sync resource summary status.
" } }, "SyncResourceSummaries": { "base": null, "refs": { "ListSyncResourcesResponse$syncResources": "The sync resources.
" } }, "SyncResourceSummary": { "base": "The sync resource summary.
", "refs": { "SyncResourceSummaries$member": null } }, "SyncResourceType": { "base": null, "refs": { "SyncResourceFilter$resourceType": "The sync resource filter resource type
", "SyncResourceSummary$resourceType": "The resource type.
" } }, "SyncSource": { "base": null, "refs": { "ComponentResponse$syncSource": "The syncSource of the sync job, if this entity was created by a sync job.
", "ComponentSummary$syncSource": "The syncSource of the sync job, if this entity was created by a sync job.
The sync source.
Currently the only supported syncSoource is SITEWISE .
The sync source.
Currently the only supported syncSource is SITEWISE .
The syncSource of the SyncJob, if this entity was created by a SyncJob.
", "GetEntityResponse$syncSource": "The syncSource of the sync job, if this entity was created by a sync job.
", "GetSyncJobRequest$syncSource": "The sync source.
Currently the only supported syncSource is SITEWISE .
The sync soucre.
Currently the only supported syncSource is SITEWISE .
The sync source.
Currently the only supported syncSource is SITEWISE .
The sync source.
" } }, "TabularConditions": { "base": "The tabular conditions.
", "refs": { "GetPropertyValueRequest$tabularConditions": "The tabular conditions.
" } }, "TabularPropertyValue": { "base": null, "refs": { "TabularPropertyValues$member": null } }, "TabularPropertyValues": { "base": null, "refs": { "GetPropertyValueResponse$tabularPropertyValues": "A table of property values.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.
" } }, "TagMap": { "base": null, "refs": { "CreateComponentTypeRequest$tags": "Metadata that you can use to manage the component type.
", "CreateEntityRequest$tags": "Metadata that you can use to manage the entity.
", "CreateSceneRequest$tags": "Metadata that you can use to manage the scene.
", "CreateSyncJobRequest$tags": "The SyncJob tags.
", "CreateWorkspaceRequest$tags": "Metadata that you can use to manage the workspace
", "ListTagsForResourceResponse$tags": "Metadata that you can use to manage a resource.
", "TagResourceRequest$tags": "Metadata to add to this resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "ThrottlingException": { "base": "The rate exceeds the limit.
", "refs": { } }, "Time": { "base": "Timestamp represented in ISO 8601 format
", "refs": { "GetPropertyValueHistoryRequest$startTime": "The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
", "GetPropertyValueHistoryRequest$endTime": "The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
", "PropertyValue$time": "ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].
[YYYY]: year
[MM]: month
[DD]: day
[hh]: hour
[mm]: minute
[ss]: seconds
[.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
Z: default timezone UTC
± HH:mm: time zone offset in Hours and Minutes.
Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
" } }, "Timestamp": { "base": "supports epoch seconds value
", "refs": { "CancelMetadataTransferJobResponse$updateDateTime": "Used to update the DateTime property.
", "ComponentTypeSummary$creationDateTime": "The date and time when the component type was created.
", "ComponentTypeSummary$updateDateTime": "The date and time when the component type was last updated.
", "CreateComponentTypeResponse$creationDateTime": "The date and time when the entity was created.
", "CreateEntityResponse$creationDateTime": "The date and time when the entity was created.
", "CreateMetadataTransferJobResponse$creationDateTime": "The The metadata transfer job creation DateTime property.
", "CreateSceneResponse$creationDateTime": "The date and time when the scene was created.
", "CreateSyncJobResponse$creationDateTime": "The date and time for the SyncJob creation.
", "CreateWorkspaceResponse$creationDateTime": "The date and time when the workspace was created.
", "EntitySummary$creationDateTime": "The date and time when the entity was created.
", "EntitySummary$updateDateTime": "The last date and time when the entity was updated.
", "GetComponentTypeResponse$creationDateTime": "The date and time when the component type was created.
", "GetComponentTypeResponse$updateDateTime": "The date and time when the component was last updated.
", "GetEntityResponse$creationDateTime": "The date and time when the entity was created.
", "GetEntityResponse$updateDateTime": "The date and time when the entity was last updated.
", "GetMetadataTransferJobResponse$creationDateTime": "The metadata transfer job's creation DateTime property.
", "GetMetadataTransferJobResponse$updateDateTime": "The metadata transfer job's update DateTime property.
", "GetPropertyValueHistoryRequest$startDateTime": "The date and time of the earliest property value to return.
", "GetPropertyValueHistoryRequest$endDateTime": "The date and time of the latest property value to return.
", "GetSceneResponse$creationDateTime": "The date and time when the scene was created.
", "GetSceneResponse$updateDateTime": "The date and time when the scene was last updated.
", "GetSyncJobResponse$creationDateTime": "The creation date and time.
", "GetSyncJobResponse$updateDateTime": "The update date and time.
", "GetWorkspaceResponse$creationDateTime": "The date and time when the workspace was created.
", "GetWorkspaceResponse$updateDateTime": "The date and time when the workspace was last updated.
", "MetadataTransferJobSummary$creationDateTime": "The metadata transfer job summary creation DateTime object.
", "MetadataTransferJobSummary$updateDateTime": "The metadata transfer job summary update DateTime object
", "PricingPlan$effectiveDateTime": "The effective date and time of the pricing plan.
", "PricingPlan$updateDateTime": "The set date and time for updating a pricing plan.
", "PropertyValue$timestamp": "The timestamp of a value for a time series property.
", "SceneSummary$creationDateTime": "The date and time when the scene was created.
", "SceneSummary$updateDateTime": "The date and time when the scene was last updated.
", "SyncJobSummary$creationDateTime": "The creation date and time.
", "SyncJobSummary$updateDateTime": "The update date and time.
", "SyncResourceSummary$updateDateTime": "The update date and time.
", "UpdateEntityResponse$updateDateTime": "The date and time when the entity was last updated.
", "UpdateSceneResponse$updateDateTime": "The date and time when the scene was last updated.
", "UpdateWorkspaceResponse$updateDateTime": "The date and time of the current update.
", "WorkspaceSummary$creationDateTime": "The date and time when the workspace was created.
", "WorkspaceSummary$updateDateTime": "The date and time when the workspace was last updated.
" } }, "TooManyTagsException": { "base": "The number of tags exceeds the limit.
", "refs": { } }, "TwinMakerArn": { "base": null, "refs": { "CancelMetadataTransferJobResponse$arn": "The metadata transfer job ARN.
", "ComponentTypeSummary$arn": "The ARN of the component type.
", "CreateComponentTypeResponse$arn": "The ARN of the component type.
", "CreateEntityResponse$arn": "The ARN of the entity.
", "CreateMetadataTransferJobResponse$arn": "The metadata transfer job ARN.
", "CreateSceneResponse$arn": "The ARN of the scene.
", "CreateSyncJobResponse$arn": "The SyncJob ARN.
", "CreateWorkspaceResponse$arn": "The ARN of the workspace.
", "EntitySummary$arn": "The ARN of the entity.
", "GetComponentTypeResponse$arn": "The ARN of the component type.
", "GetEntityResponse$arn": "The ARN of the entity.
", "GetMetadataTransferJobResponse$arn": "The metadata transfer job ARN.
", "GetSceneResponse$arn": "The ARN of the scene.
", "GetSyncJobResponse$arn": "The sync job ARN.
", "GetWorkspaceResponse$arn": "The ARN of the workspace.
", "IotTwinMakerDestinationConfiguration$workspace": "The IoT TwinMaker workspace.
", "IotTwinMakerSourceConfiguration$workspace": "The IoT TwinMaker workspace.
", "ListTagsForResourceRequest$resourceARN": "The ARN of the resource.
", "MetadataTransferJobSummary$arn": "The metadata transfer job summary ARN.
", "SceneSummary$arn": "The ARN of the scene.
", "SyncJobSummary$arn": "The SyncJob summary ARN.
", "TagResourceRequest$resourceARN": "The ARN of the resource.
", "UntagResourceRequest$resourceARN": "The ARN of the resource.
", "UpdateComponentTypeResponse$arn": "The ARN of the component type.
", "WorkspaceSummary$arn": "The ARN of the workspace.
" } }, "Type": { "base": null, "refs": { "DataType$type": "The underlying type of the data type.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateComponentTypeRequest": { "base": null, "refs": { } }, "UpdateComponentTypeResponse": { "base": null, "refs": { } }, "UpdateEntityRequest": { "base": null, "refs": { } }, "UpdateEntityResponse": { "base": null, "refs": { } }, "UpdatePricingPlanRequest": { "base": null, "refs": { } }, "UpdatePricingPlanResponse": { "base": null, "refs": { } }, "UpdateReason": { "base": null, "refs": { "PricingPlan$updateReason": "The update reason for changing a pricing plan.
" } }, "UpdateSceneRequest": { "base": null, "refs": { } }, "UpdateSceneResponse": { "base": null, "refs": { } }, "UpdateWorkspaceRequest": { "base": null, "refs": { } }, "UpdateWorkspaceResponse": { "base": null, "refs": { } }, "Uuid": { "base": null, "refs": { "FilterByAsset$assetId": "Filter by asset Id.
", "FilterByAssetModel$assetModelId": "The asset model Id.
" } }, "ValidationException": { "base": "Failed
", "refs": { } }, "Value": { "base": null, "refs": { "Configuration$value": null } }, "Values": { "base": null, "refs": { "PropertyValueHistory$values": "A list of objects that contain information about the values in the history of a time series property.
" } }, "WorkspaceDeleteMessage": { "base": null, "refs": { "DeleteWorkspaceResponse$message": "The string that specifies the delete result for the workspace.
" } }, "WorkspaceSummaries": { "base": null, "refs": { "ListWorkspacesResponse$workspaceSummaries": "A list of objects that contain information about the workspaces.
" } }, "WorkspaceSummary": { "base": "An object that contains information about a workspace.
", "refs": { "WorkspaceSummaries$member": null } } } }