String errorCode
The error code.
String errorMessage
The error message.
PropertyValueEntry entry
An object that contains information about errors returned by the BatchPutProperty action.
String description
The description of the component request.
String componentTypeId
The ID of the component type.
Map<K,V> 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.
Map<K,V> propertyGroups
The property groups.
String componentName
The name of the component.
String description
The description of the component type.
String componentTypeId
The ID of the component type.
Status status
The status of the component type.
String definedIn
The name of the property definition set in the request.
Map<K,V> 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.
Map<K,V> propertyGroups
The property groups.
String syncSource
The syncSource of the sync job, if this entity was created by a sync job.
String arn
The ARN of the component type.
String componentTypeId
The ID of the component type.
Date creationDateTime
The date and time when the component type was created.
Date updateDateTime
The date and time when the component type was last updated.
String description
The description of the component type.
Status status
The current status of the component type.
String componentTypeName
The component type name.
String updateType
The update type of the component update request.
String description
The description of the component type.
String componentTypeId
The ID of the component type.
Map<K,V> 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.
Map<K,V> propertyGroupUpdates
The property group updates.
String workspaceId
The ID of the workspace that contains the component type.
Boolean isSingleton
A Boolean value that specifies whether an entity can have more than one component of this type.
String componentTypeId
The ID of the component type.
String description
The description of the component type.
Map<K,V> 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.
List<E> extendsFrom
Specifies the parent component type to extend.
Map<K,V> functions
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
Map<K,V> tags
Metadata that you can use to manage the component type.
Map<K,V> propertyGroups
String componentTypeName
A friendly name for the component type.
String workspaceId
The ID of the workspace that contains the entity.
String entityId
The ID of the entity.
String entityName
The name of the entity.
String description
The description of the entity.
Map<K,V> components
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
String parentEntityId
The ID of the entity's parent entity.
Map<K,V> tags
Metadata that you can use to manage the entity.
String workspaceId
The ID of the workspace that contains the scene.
String sceneId
The ID of the scene.
String contentLocation
The relative path that specifies the location of the content definition file.
String description
The description for this scene.
List<E> capabilities
A list of capabilities that the scene uses to render itself.
Map<K,V> tags
Metadata that you can use to manage the scene.
Map<K,V> sceneMetadata
The request metadata.
String workspaceId
The workspace ID.
String syncSource
The sync source.
Currently the only supported syncSoource is SITEWISE .
String 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.
Map<K,V> tags
The SyncJob tags.
String workspaceId
The ID of the workspace.
String description
The description of the workspace.
String s3Location
The ARN of the S3 bucket where resources associated with the workspace are stored.
String role
The ARN of the execution role associated with the workspace.
Map<K,V> tags
Metadata that you can use to manage the workspace
LambdaFunction lambda
The Lambda function associated with this data connector.
Boolean isNative
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
String type
The underlying type of the data type.
DataType nestedType
The nested type in the data type.
List<E> allowedValues
The allowed values for this data type.
String unitOfMeasure
The unit of measure used in this data type.
Relationship relationship
A relationship that associates a component with another component.
Boolean booleanValue
A Boolean value.
Double doubleValue
A double value.
Integer integerValue
An integer value.
Long longValue
A long value.
String stringValue
A string value.
List<E> listValue
A list of multiple values.
Map<K,V> mapValue
An object that maps strings to multiple DataValue objects.
RelationshipValue relationshipValue
A value that relates a component to another component.
String expression
An expression that produces the value.
String state
The current state of the component type to be deleted.
String state
The current state of the deleted entity.
String state
The SyncJob response state.
String workspaceId
The ID of the workspace to delete.
String componentName
The name of the component.
Map<K,V> externalIdProperty
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
String entityId
The ID of the entity.
String propertyName
The name of the property.
String entityId
The ID of the entity.
String entityName
The name of the entity.
String arn
The ARN of the entity.
String parentEntityId
The ID of the parent entity.
Status status
The current status of the entity.
String description
The description of the entity.
Boolean hasChildEntities
A Boolean value that specifies whether the entity has child entities or not.
Date creationDateTime
The date and time when the entity was created.
Date updateDateTime
The last date and time when the entity was updated.
String workspaceId
The ID of the workspace.
String queryStatement
The query statement.
Integer 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.
String nextToken
The string that specifies the next page of results.
List<E> requiredProperties
The required properties of the function.
String scope
The scope of the function.
DataConnector implementedBy
The data connector.
List<E> requiredProperties
The required properties of the function.
String scope
The scope of the function.
DataConnector implementedBy
The data connector.
Boolean isInherited
Indicates whether this function is inherited.
String workspaceId
The ID of the workspace that contains the component type.
Boolean isSingleton
A Boolean value that specifies whether an entity can have more than one component of this type.
String componentTypeId
The ID of the component type.
String description
The description of the component type.
Map<K,V> 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.
List<E> extendsFrom
The name of the parent component type that this component type extends.
Map<K,V> functions
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
Date creationDateTime
The date and time when the component type was created.
Date updateDateTime
The date and time when the component was last updated.
String arn
The ARN of the component type.
Boolean isAbstract
A Boolean value that specifies whether the component type is abstract.
Boolean isSchemaInitialized
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
Status status
The current status of the component type.
Map<K,V> 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.
String syncSource
The syncSource of the SyncJob, if this entity was created by a SyncJob.
String componentTypeName
The component type name.
String entityId
The ID of the entity.
String entityName
The name of the entity.
String arn
The ARN of the entity.
Status status
The current status of the entity.
String workspaceId
The ID of the workspace.
String description
The description of the entity.
Map<K,V> components
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
String parentEntityId
The ID of the parent entity for this entity.
Boolean hasChildEntities
A Boolean value that specifies whether the entity has associated child entities.
Date creationDateTime
The date and time when the entity was created.
Date updateDateTime
The date and time when the entity was last updated.
String syncSource
The syncSource of the sync job, if this entity was created by a sync job.
PricingPlan currentPricingPlan
The chosen pricing plan for the current billing cycle.
PricingPlan pendingPricingPlan
The pending pricing plan.
String workspaceId
The ID of the workspace.
String entityId
The ID of the entity.
String componentName
The name of the component.
String componentTypeId
The ID of the component type.
List<E> selectedProperties
A list of properties whose value histories the request retrieves.
List<E> propertyFilters
A list of objects that filter the property value history request.
Date startDateTime
The date and time of the earliest property value to return.
Date endDateTime
The date and time of the latest property value to return.
InterpolationParameters interpolation
An object that specifies the interpolation type and the interval over which to interpolate data.
String nextToken
The string that specifies the next page of results.
Integer 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.
String orderByTime
The time direction to use in the result order.
String startTime
The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
String endTime
The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
String componentName
The name of the component whose property values the operation returns.
String componentTypeId
The ID of the component type whose property values the operation returns.
String entityId
The ID of the entity whose property values the operation returns.
List<E> selectedProperties
The properties whose values the operation returns.
String workspaceId
The ID of the workspace whose values the operation returns.
Integer 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.
String nextToken
The string that specifies the next page of results.
String propertyGroupName
The property group name.
TabularConditions tabularConditions
The tabular conditions.
Map<K,V> 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.
String nextToken
The string that specifies the next page of results.
List<E> tabularPropertyValues
A table of property values.
String workspaceId
The ID of the workspace that contains the scene.
String sceneId
The ID of the scene.
String contentLocation
The relative path that specifies the location of the content definition file.
String arn
The ARN of the scene.
Date creationDateTime
The date and time when the scene was created.
Date updateDateTime
The date and time when the scene was last updated.
String description
The description of the scene.
List<E> capabilities
A list of capabilities that the scene uses to render.
Map<K,V> sceneMetadata
The response metadata.
Map<K,V> generatedSceneMetadata
The generated scene metadata.
SceneError error
The SceneResponse error.
String arn
The sync job ARN.
String workspaceId
The ID of the workspace that contains the sync job.
String syncSource
The sync soucre.
Currently the only supported syncSource is SITEWISE .
String syncRole
The sync IAM role.
SyncJobStatus status
The SyncJob response status.
Date creationDateTime
The creation date and time.
Date updateDateTime
The update date and time.
String workspaceId
The ID of the workspace.
String workspaceId
The ID of the workspace.
String arn
The ARN of the workspace.
String description
The description of the workspace.
String s3Location
The ARN of the S3 bucket where resources associated with the workspace are stored.
String role
The ARN of the execution role associated with the workspace.
Date creationDateTime
The date and time when the workspace was created.
Date updateDateTime
The date and time when the workspace was last updated.
String arn
The ARN of the Lambda function.
String workspaceId
The ID of the workspace.
List<E> filters
A list of objects that filter the request.
String nextToken
The string that specifies the next page of results.
Integer 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.
String workspaceId
The ID of the workspace.
List<E> componentTypeSummaries
A list of objects that contain information about the component types.
String nextToken
The string that specifies the next page of results.
Integer maxResults
Specifies the maximum number of results to display.
String parentEntityId
The parent of the entities in the list.
String componentTypeId
The ID of the component type in the entities in the list.
String externalId
The external-Id property of a component. The external-Id property is the primary key of an external storage system.
String workspaceId
The ID of the workspace.
List<E> filters
A list of objects that filter the request.
Only one object is accepted as a valid input.
Integer 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.
String nextToken
The string that specifies the next page of results.
String workspaceId
The ID of the workspace that contains the sync job.
Integer 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.
String nextToken
The string that specifies the next page of results.
String workspaceId
The ID of the workspace that contains the sync job.
String syncSource
The sync source.
Currently the only supported syncSource is SITEWISE .
List<E> 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
Integer 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.
String nextToken
The string that specifies the next page of results.
Long billableEntityCount
The billable entity count.
BundleInformation bundleInformation
The pricing plan's bundle information.
Date effectiveDateTime
The effective date and time of the pricing plan.
String pricingMode
The pricing mode.
Date updateDateTime
The set date and time for updating a pricing plan.
String updateReason
The update reason for changing a pricing plan.
DataType dataType
An object that contains information about the data type.
Boolean isRequiredInEntity
A Boolean value that specifies whether the property is required.
Boolean isExternalId
A Boolean value that specifies whether the property ID comes from an external data store.
Boolean isStoredExternally
A Boolean value that specifies whether the property is stored externally.
Boolean isTimeSeries
A Boolean value that specifies whether the property consists of time series data.
DataValue defaultValue
An object that contains the default value.
Map<K,V> configuration
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
String displayName
A friendly name for the property.
DataType dataType
An object that contains information about the data type.
Boolean isTimeSeries
A Boolean value that specifies whether the property consists of time series data.
Boolean isRequiredInEntity
A Boolean value that specifies whether the property is required in an entity.
Boolean isExternalId
A Boolean value that specifies whether the property ID comes from an external data store.
Boolean isStoredExternally
A Boolean value that specifies whether the property is stored externally.
Boolean isImported
A Boolean value that specifies whether the property definition is imported from an external data store.
Boolean isFinal
A Boolean value that specifies whether the property definition can be updated.
Boolean isInherited
A Boolean value that specifies whether the property definition is inherited from a parent entity.
DataValue defaultValue
An object that contains the default value.
Map<K,V> configuration
A mapping that specifies configuration information about the property.
String displayName
A friendly name for the property.
EntityPropertyReference propertyReference
An object that specifies information about a property.
DataValue propertyValue
The value of the property.
PropertyDefinitionRequest definition
An object that specifies information about a property.
DataValue value
The value of the property.
String updateType
The update type of the update property request.
PropertyDefinitionResponse definition
An object that specifies information about a property.
DataValue value
The value of the property.
Date timestamp
The timestamp of a value for a time series property.
DataValue value
An object that specifies a value for a time series property.
String 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]
EntityPropertyReference entityPropertyReference
An object that contains information about the entity that has the property.
List<E> propertyValues
A list of objects that specify time series property values.
EntityPropertyReference entityPropertyReference
An object that uniquely identifies an entity property.
List<E> values
A list of objects that contain information about the values in the history of a time series property.
String sceneId
The ID of the scene.
String contentLocation
The relative path that specifies the location of the content definition file.
String arn
The ARN of the scene.
Date creationDateTime
The date and time when the scene was created.
Date updateDateTime
The date and time when the scene was last updated.
String description
The scene description.
String state
The current state of the entity, component, component type, or workspace.
ErrorDetails error
The error message.
String state
The SyncJob status state.
ErrorDetails error
The SyncJob error.
String arn
The SyncJob summary ARN.
String workspaceId
The ID of the workspace that contains the sync job.
String syncSource
The sync source.
SyncJobStatus status
The SyncJob summaries status.
Date creationDateTime
The creation date and time.
Date updateDateTime
The update date and time.
String state
The sync resource status state.
ErrorDetails error
The status error.
String resourceType
The resource type.
String externalId
The external ID.
String resourceId
The resource ID.
SyncResourceStatus status
The sync resource summary status.
Date updateDateTime
The update date and time.
String workspaceId
The ID of the workspace.
Boolean isSingleton
A Boolean value that specifies whether an entity can have more than one component of this type.
String componentTypeId
The ID of the component type.
String description
The description of the component type.
Map<K,V> 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.
List<E> extendsFrom
Specifies the component type that this component type extends.
Map<K,V> functions
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
Map<K,V> propertyGroups
The property groups.
String componentTypeName
The component type name.
String workspaceId
The ID of the workspace that contains the entity.
String entityId
The ID of the entity.
String entityName
The name of the entity.
String description
The description of the entity.
Map<K,V> componentUpdates
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
ParentEntityUpdateRequest parentEntityUpdate
An object that describes the update request for a parent entity.
PricingPlan currentPricingPlan
Update the current pricing plan.
PricingPlan pendingPricingPlan
Update the pending pricing plan.
String workspaceId
The ID of the workspace that contains the scene.
String sceneId
The ID of the scene.
String contentLocation
The relative path that specifies the location of the content definition file.
String description
The description of this scene.
List<E> capabilities
A list of capabilities that the scene uses to render.
Map<K,V> sceneMetadata
The scene metadata.
Date updateDateTime
The date and time when the scene was last updated.
Date updateDateTime
The date and time of the current update.
String workspaceId
The ID of the workspace.
String arn
The ARN of the workspace.
String description
The description of the workspace.
Date creationDateTime
The date and time when the workspace was created.
Date updateDateTime
The date and time when the workspace was last updated.
Copyright © 2023. All rights reserved.