A low-level client representing AWS IoT TwinMaker
IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
client = session.create_client('iottwinmaker')
These are the available methods:
Sets values for multiple time series properties.
See also: AWS API Documentation
Request Syntax
response = client.batch_put_property_values(
entries=[
{
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'propertyValues': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
],
workspaceId='string'
)
entries (list) –
[REQUIRED]
An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
(dict) –
An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
entityPropertyReference (dict) – [REQUIRED]
An object that contains information about the entity that has the property.
componentName (string) –
The name of the component.
entityId (string) –
The ID of the entity.
externalIdProperty (dict) –
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) –
(string) –
propertyName (string) – [REQUIRED]
The name of the property.
propertyValues (list) –
A list of objects that specify time series property values.
(dict) –
An object that contains information about a value for a time series property.
time (string) –
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 (datetime) –
The timestamp of a value for a time series property.
value (dict) – [REQUIRED]
An object that specifies a value for a time series property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the properties to set.
dict
Response Syntax
{
'errorEntries': [
{
'errors': [
{
'entry': {
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'propertyValues': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
'errorCode': 'string',
'errorMessage': 'string'
},
]
},
]
}
Response Structure
(dict) –
errorEntries (list) –
Entries that caused errors in the batch put operation.
(dict) –
An object that contains information about errors returned by the BatchPutProperty
action.
errors (list) –
A list of objects that contain information about errors returned by the BatchPutProperty
action.
(dict) –
An error returned by the BatchPutProperty
action.
entry (dict) –
An object that contains information about errors returned by the BatchPutProperty
action.
entityPropertyReference (dict) –
An object that contains information about the entity that has the property.
componentName (string) –
The name of the component.
entityId (string) –
The ID of the entity.
externalIdProperty (dict) –
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) –
(string) –
propertyName (string) –
The name of the property.
propertyValues (list) –
A list of objects that specify time series property values.
(dict) –
An object that contains information about a value for a time series property.
time (string) –
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 (datetime) –
The timestamp of a value for a time series property.
value (dict) –
An object that specifies a value for a time series property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
errorCode (string) –
The error code.
errorMessage (string) –
The error message.
Exceptions
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
Creates a component type.
See also: AWS API Documentation
Request Syntax
response = client.create_component_type(
componentTypeId='string',
description='string',
extendsFrom=[
'string',
],
functions={
'string': {
'implementedBy': {
'isNative': True|False,
'lambda': {
'arn': 'string'
}
},
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE'
}
},
isSingleton=True|False,
propertyDefinitions={
'string': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
}
},
tags={
'string': 'string'
},
workspaceId='string'
)
componentTypeId (string) –
[REQUIRED]
The ID of the component type.
description (string) – The description of the component type.
extendsFrom (list) –
Specifies the parent component type to extend.
(string) –
functions (dict) –
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
The function request body.
implementedBy (dict) –
The data connector.
isNative (boolean) –
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
lambda (dict) –
The Lambda function associated with this data connector.
arn (string) – [REQUIRED]
The ARN of the Lambda function.
requiredProperties (list) –
The required properties of the function.
(string) –
scope (string) –
The scope of the function.
isSingleton (boolean) – A Boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions (dict) –
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
An object that sets information about a property.
configuration (dict) –
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) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) – [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
tags (dict) –
Metadata that you can use to manage the component type.
(string) –
(string) –
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the component type.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) –
arn (string) –
The ARN of the component type.
creationDateTime (datetime) –
The date and time when the entity was created.
state (string) –
The current state of the component type.
Exceptions
Creates an entity.
See also: AWS API Documentation
Request Syntax
response = client.create_entity(
components={
'string': {
'componentTypeId': 'string',
'description': 'string',
'properties': {
'string': {
'definition': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
},
'updateType': 'UPDATE'|'DELETE'|'CREATE',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
}
}
},
description='string',
entityId='string',
entityName='string',
parentEntityId='string',
tags={
'string': 'string'
},
workspaceId='string'
)
components (dict) –
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
(string) –
(dict) –
An object that sets information about a component type create or update request.
componentTypeId (string) –
The ID of the component type.
description (string) –
The description of the component request.
properties (dict) –
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.
(string) –
(dict) –
An object that sets information about a property.
definition (dict) –
An object that specifies information about a property.
configuration (dict) –
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) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) – [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
updateType (string) –
The update type of the update property request.
value (dict) –
The value of the property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
description (string) – The description of the entity.
entityId (string) – The ID of the entity.
entityName (string) –
[REQUIRED]
The name of the entity.
parentEntityId (string) – The ID of the entity’s parent entity.
tags (dict) –
Metadata that you can use to manage the entity.
(string) –
(string) –
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the entity.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'entityId': 'string',
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) –
arn (string) –
The ARN of the entity.
creationDateTime (datetime) –
The date and time when the entity was created.
entityId (string) –
The ID of the entity.
state (string) –
The current state of the entity.
Exceptions
Creates a scene.
See also: AWS API Documentation
Request Syntax
response = client.create_scene(
capabilities=[
'string',
],
contentLocation='string',
description='string',
sceneId='string',
tags={
'string': 'string'
},
workspaceId='string'
)
capabilities (list) –
A list of capabilities that the scene uses to render itself.
(string) –
contentLocation (string) –
[REQUIRED]
The relative path that specifies the location of the content definition file.
description (string) – The description for this scene.
sceneId (string) –
[REQUIRED]
The ID of the scene.
tags (dict) –
Metadata that you can use to manage the scene.
(string) –
(string) –
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the scene.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) –
arn (string) –
The ARN of the scene.
creationDateTime (datetime) –
The date and time when the scene was created.
Exceptions
Creates a workplace.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace(
description='string',
role='string',
s3Location='string',
tags={
'string': 'string'
},
workspaceId='string'
)
description (string) – The description of the workspace.
role (string) –
[REQUIRED]
The ARN of the execution role associated with the workspace.
s3Location (string) –
[REQUIRED]
The ARN of the S3 bucket where resources associated with the workspace are stored.
tags (dict) –
Metadata that you can use to manage the workspace
(string) –
(string) –
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) –
arn (string) –
The ARN of the workspace.
creationDateTime (datetime) –
The date and time when the workspace was created.
Exceptions
Deletes a component type.
See also: AWS API Documentation
Request Syntax
response = client.delete_component_type(
componentTypeId='string',
workspaceId='string'
)
componentTypeId (string) –
[REQUIRED]
The ID of the component type to delete.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the component type.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) –
state (string) –
The current state of the component type to be deleted.
Exceptions
Deletes an entity.
See also: AWS API Documentation
Request Syntax
response = client.delete_entity(
entityId='string',
isRecursive=True|False,
workspaceId='string'
)
entityId (string) –
[REQUIRED]
The ID of the entity to delete.
isRecursive (boolean) – A Boolean value that specifies whether the operation deletes child entities.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the entity to delete.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) –
state (string) –
The current state of the deleted entity.
Exceptions
Deletes a scene.
See also: AWS API Documentation
Request Syntax
response = client.delete_scene(
sceneId='string',
workspaceId='string'
)
sceneId (string) –
[REQUIRED]
The ID of the scene to delete.
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Deletes a workspace.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace(
workspaceId='string'
)
workspaceId (string) –
[REQUIRED]
The ID of the workspace to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Retrieves information about a component type.
See also: AWS API Documentation
Request Syntax
response = client.get_component_type(
componentTypeId='string',
workspaceId='string'
)
componentTypeId (string) –
[REQUIRED]
The ID of the component type.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the component type.
dict
Response Syntax
{
'arn': 'string',
'componentTypeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'extendsFrom': [
'string',
],
'functions': {
'string': {
'implementedBy': {
'isNative': True|False,
'lambda': {
'arn': 'string'
}
},
'isInherited': True|False,
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE'
}
},
'isAbstract': True|False,
'isSchemaInitialized': True|False,
'isSingleton': True|False,
'propertyDefinitions': {
'string': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isFinal': True|False,
'isImported': True|False,
'isInherited': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
}
},
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
},
'updateDateTime': datetime(2015, 1, 1),
'workspaceId': 'string'
}
Response Structure
(dict) –
arn (string) –
The ARN of the component type.
componentTypeId (string) –
The ID of the component type.
creationDateTime (datetime) –
The date and time when the component type was created.
description (string) –
The description of the component type.
extendsFrom (list) –
The name of the parent component type that this component type extends.
(string) –
functions (dict) –
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
The function response.
implementedBy (dict) –
The data connector.
isNative (boolean) –
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
lambda (dict) –
The Lambda function associated with this data connector.
arn (string) –
The ARN of the Lambda function.
isInherited (boolean) –
Indicates whether this function is inherited.
requiredProperties (list) –
The required properties of the function.
(string) –
scope (string) –
The scope of the function.
isAbstract (boolean) –
A Boolean value that specifies whether the component type is abstract.
isSchemaInitialized (boolean) –
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
isSingleton (boolean) –
A Boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions (dict) –
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
An object that contains response data from a property definition request.
configuration (dict) –
A mapping that specifies configuration information about the property.
(string) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) –
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isFinal (boolean) –
A Boolean value that specifies whether the property definition can be updated.
isImported (boolean) –
A Boolean value that specifies whether the property definition is imported from an external data store.
isInherited (boolean) –
A Boolean value that specifies whether the property definition is inherited from a parent entity.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required in an entity.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
status (dict) –
The current status of the component type.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
state (string) –
The current state of the entity, component, component type, or workspace.
updateDateTime (datetime) –
The date and time when the component was last updated.
workspaceId (string) –
The ID of the workspace that contains the component type.
Exceptions
Retrieves information about an entity.
See also: AWS API Documentation
Request Syntax
response = client.get_entity(
entityId='string',
workspaceId='string'
)
entityId (string) –
[REQUIRED]
The ID of the entity.
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'arn': 'string',
'components': {
'string': {
'componentName': 'string',
'componentTypeId': 'string',
'definedIn': 'string',
'description': 'string',
'properties': {
'string': {
'definition': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isFinal': True|False,
'isImported': True|False,
'isInherited': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
},
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
},
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
}
},
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityName': 'string',
'hasChildEntities': True|False,
'parentEntityId': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
},
'updateDateTime': datetime(2015, 1, 1),
'workspaceId': 'string'
}
Response Structure
(dict) –
arn (string) –
The ARN of the entity.
components (dict) –
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
(string) –
(dict) –
An object that returns information about a component type create or update request.
componentName (string) –
The name of the component.
componentTypeId (string) –
The ID of the component type.
definedIn (string) –
The name of the property definition set in the request.
description (string) –
The description of the component type.
properties (dict) –
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.
(string) –
(dict) –
An object that contains information about a property response.
definition (dict) –
An object that specifies information about a property.
configuration (dict) –
A mapping that specifies configuration information about the property.
(string) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) –
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isFinal (boolean) –
A Boolean value that specifies whether the property definition can be updated.
isImported (boolean) –
A Boolean value that specifies whether the property definition is imported from an external data store.
isInherited (boolean) –
A Boolean value that specifies whether the property definition is inherited from a parent entity.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required in an entity.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
value (dict) –
The value of the property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
status (dict) –
The status of the component type.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
state (string) –
The current state of the entity, component, component type, or workspace.
creationDateTime (datetime) –
The date and time when the entity was created.
description (string) –
The description of the entity.
entityId (string) –
The ID of the entity.
entityName (string) –
The name of the entity.
hasChildEntities (boolean) –
A Boolean value that specifies whether the entity has associated child entities.
parentEntityId (string) –
The ID of the parent entity for this entity.
status (dict) –
The current status of the entity.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
state (string) –
The current state of the entity, component, component type, or workspace.
updateDateTime (datetime) –
The date and time when the entity was last updated.
workspaceId (string) –
The ID of the workspace.
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Gets the property values for a component, component type, entity, or workspace.
You must specify a value for either componentName
, componentTypeId
, entityId
, or workspaceId
.
See also: AWS API Documentation
Request Syntax
response = client.get_property_value(
componentName='string',
componentTypeId='string',
entityId='string',
selectedProperties=[
'string',
],
workspaceId='string'
)
componentName (string) – The name of the component whose property values the operation returns.
componentTypeId (string) – The ID of the component type whose property values the operation returns.
entityId (string) – The ID of the entity whose property values the operation returns.
selectedProperties (list) –
[REQUIRED]
The properties whose values the operation returns.
(string) –
workspaceId (string) –
[REQUIRED]
The ID of the workspace whose values the operation returns.
dict
Response Syntax
{
'propertyValues': {
'string': {
'propertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'propertyValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
}
}
Response Structure
(dict) –
propertyValues (dict) –
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) –
(dict) –
The latest value of the property.
propertyReference (dict) –
An object that specifies information about a property.>
componentName (string) –
The name of the component.
entityId (string) –
The ID of the entity.
externalIdProperty (dict) –
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) –
(string) –
propertyName (string) –
The name of the property.
propertyValue (dict) –
The value of the property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
Exceptions
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
.
See also: AWS API Documentation
Request Syntax
response = client.get_property_value_history(
componentName='string',
componentTypeId='string',
endDateTime=datetime(2015, 1, 1),
endTime='string',
entityId='string',
interpolation={
'interpolationType': 'LINEAR',
'intervalInSeconds': 123
},
maxResults=123,
nextToken='string',
orderByTime='ASCENDING'|'DESCENDING',
propertyFilters=[
{
'operator': 'string',
'propertyName': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
],
selectedProperties=[
'string',
],
startDateTime=datetime(2015, 1, 1),
startTime='string',
workspaceId='string'
)
componentName (string) – The name of the component.
componentTypeId (string) – The ID of the component type.
endDateTime (datetime) – The date and time of the latest property value to return.
endTime (string) –
The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue .
entityId (string) – The ID of the entity.
interpolation (dict) –
An object that specifies the interpolation type and the interval over which to interpolate data.
interpolationType (string) –
The interpolation type.
intervalInSeconds (integer) –
The interpolation time interval in seconds.
maxResults (integer) – The maximum number of results to return.
nextToken (string) – The string that specifies the next page of results.
orderByTime (string) – The time direction to use in the result order.
propertyFilters (list) –
A list of objects that filter the property value history request.
(dict) –
An object that filters items returned by a property request.
operator (string) –
The operator associated with this property filter.
propertyName (string) –
The property name associated with this property filter.
value (dict) –
The value associated with this property filter.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
selectedProperties (list) –
[REQUIRED]
A list of properties whose value histories the request retrieves.
(string) –
startDateTime (datetime) – The date and time of the earliest property value to return.
startTime (string) –
The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue .
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'nextToken': 'string',
'propertyValues': [
{
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'values': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
]
}
Response Structure
(dict) –
nextToken (string) –
The string that specifies the next page of results.
propertyValues (list) –
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(dict) –
The history of values for a time series property.
entityPropertyReference (dict) –
An object that uniquely identifies an entity property.
componentName (string) –
The name of the component.
entityId (string) –
The ID of the entity.
externalIdProperty (dict) –
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) –
(string) –
propertyName (string) –
The name of the property.
values (list) –
A list of objects that contain information about the values in the history of a time series property.
(dict) –
An object that contains information about a value for a time series property.
time (string) –
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 (datetime) –
The timestamp of a value for a time series property.
value (dict) –
An object that specifies a value for a time series property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
Exceptions
Retrieves information about a scene.
See also: AWS API Documentation
Request Syntax
response = client.get_scene(
sceneId='string',
workspaceId='string'
)
sceneId (string) –
[REQUIRED]
The ID of the scene.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the scene.
dict
Response Syntax
{
'arn': 'string',
'capabilities': [
'string',
],
'contentLocation': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'sceneId': 'string',
'updateDateTime': datetime(2015, 1, 1),
'workspaceId': 'string'
}
Response Structure
(dict) –
arn (string) –
The ARN of the scene.
capabilities (list) –
A list of capabilities that the scene uses to render.
(string) –
contentLocation (string) –
The relative path that specifies the location of the content definition file.
creationDateTime (datetime) –
The date and time when the scene was created.
description (string) –
The description of the scene.
sceneId (string) –
The ID of the scene.
updateDateTime (datetime) –
The date and time when the scene was last updated.
workspaceId (string) –
The ID of the workspace that contains the scene.
Exceptions
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Retrieves information about a workspace.
See also: AWS API Documentation
Request Syntax
response = client.get_workspace(
workspaceId='string'
)
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'role': 'string',
's3Location': 'string',
'updateDateTime': datetime(2015, 1, 1),
'workspaceId': 'string'
}
Response Structure
(dict) –
arn (string) –
The ARN of the workspace.
creationDateTime (datetime) –
The date and time when the workspace was created.
description (string) –
The description of the workspace.
role (string) –
The ARN of the execution role associated with the workspace.
s3Location (string) –
The ARN of the S3 bucket where resources associated with the workspace are stored.
updateDateTime (datetime) –
The date and time when the workspace was last updated.
workspaceId (string) –
The ID of the workspace.
Exceptions
Lists all component types in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_component_types(
filters=[
{
'extendsFrom': 'string',
'isAbstract': True|False,
'namespace': 'string'
},
],
maxResults=123,
nextToken='string',
workspaceId='string'
)
filters (list) –
A list of objects that filter the request.
(dict) –
An object that filters items in a list of component types.
Note
Only one object is accepted as a valid input.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: extendsFrom
, isAbstract
, namespace
.
extendsFrom (string) –
The component type that the component types in the list extend.
isAbstract (boolean) –
A Boolean value that specifies whether the component types in the list are abstract.
namespace (string) –
The namespace to which the component types in the list belong.
maxResults (integer) – The maximum number of results to display.
nextToken (string) – The string that specifies the next page of results.
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'componentTypeSummaries': [
{
'arn': 'string',
'componentTypeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
},
'updateDateTime': datetime(2015, 1, 1)
},
],
'maxResults': 123,
'nextToken': 'string',
'workspaceId': 'string'
}
Response Structure
(dict) –
componentTypeSummaries (list) –
A list of objects that contain information about the component types.
(dict) –
An object that contains information about a component type.
arn (string) –
The ARN of the component type.
componentTypeId (string) –
The ID of the component type.
creationDateTime (datetime) –
The date and time when the component type was created.
description (string) –
The description of the component type.
status (dict) –
The current status of the component type.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
state (string) –
The current state of the entity, component, component type, or workspace.
updateDateTime (datetime) –
The date and time when the component type was last updated.
maxResults (integer) –
Specifies the maximum number of results to display.
nextToken (string) –
The string that specifies the next page of results.
workspaceId (string) –
The ID of the workspace.
Exceptions
Lists all entities in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_entities(
filters=[
{
'componentTypeId': 'string',
'externalId': 'string',
'parentEntityId': 'string'
},
],
maxResults=123,
nextToken='string',
workspaceId='string'
)
filters (list) –
A list of objects that filter the request.
Note
Only one object is accepted as a valid input.
(dict) –
An object that filters items in a list of entities.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: componentTypeId
, externalId
, parentEntityId
.
componentTypeId (string) –
The ID of the component type in the entities in the list.
externalId (string) –
The external-Id property of a component. The external-Id property is the primary key of an external storage system.
parentEntityId (string) –
The parent of the entities in the list.
maxResults (integer) – The maximum number of results to display.
nextToken (string) – The string that specifies the next page of results.
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'entitySummaries': [
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityName': 'string',
'hasChildEntities': True|False,
'parentEntityId': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
},
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
entitySummaries (list) –
A list of objects that contain information about the entities.
(dict) –
An object that contains information about an entity.
arn (string) –
The ARN of the entity.
creationDateTime (datetime) –
The date and time when the entity was created.
description (string) –
The description of the entity.
entityId (string) –
The ID of the entity.
entityName (string) –
The name of the entity.
hasChildEntities (boolean) –
A Boolean value that specifies whether the entity has child entities or not.
parentEntityId (string) –
The ID of the parent entity.
status (dict) –
The current status of the entity.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
state (string) –
The current state of the entity, component, component type, or workspace.
updateDateTime (datetime) –
The last date and time when the entity was updated.
nextToken (string) –
The string that specifies the next page of results.
Exceptions
Lists all scenes in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_scenes(
maxResults=123,
nextToken='string',
workspaceId='string'
)
maxResults (integer) – Specifies the maximum number of results to display.
nextToken (string) – The string that specifies the next page of results.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the scenes.
dict
Response Syntax
{
'nextToken': 'string',
'sceneSummaries': [
{
'arn': 'string',
'contentLocation': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'sceneId': 'string',
'updateDateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) –
nextToken (string) –
The string that specifies the next page of results.
sceneSummaries (list) –
A list of objects that contain information about the scenes.
(dict) –
An object that contains information about a scene.
arn (string) –
The ARN of the scene.
contentLocation (string) –
The relative path that specifies the location of the content definition file.
creationDateTime (datetime) –
The date and time when the scene was created.
description (string) –
The scene description.
sceneId (string) –
The ID of the scene.
updateDateTime (datetime) –
The date and time when the scene was last updated.
Exceptions
Lists all tags associated with a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
maxResults=123,
nextToken='string',
resourceARN='string'
)
maxResults (integer) – The maximum number of results to display.
nextToken (string) – The string that specifies the next page of results.
resourceARN (string) –
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'nextToken': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) –
nextToken (string) –
The string that specifies the next page of results.
tags (dict) –
Metadata that you can use to manage a resource.
(string) –
(string) –
Exceptions
Retrieves information about workspaces in the current account.
See also: AWS API Documentation
Request Syntax
response = client.list_workspaces(
maxResults=123,
nextToken='string'
)
maxResults (integer) – The maximum number of results to display.
nextToken (string) – The string that specifies the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'workspaceSummaries': [
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'updateDateTime': datetime(2015, 1, 1),
'workspaceId': 'string'
},
]
}
Response Structure
(dict) –
nextToken (string) –
The string that specifies the next page of results.
workspaceSummaries (list) –
A list of objects that contain information about the workspaces.
(dict) –
An object that contains information about a workspace.
arn (string) –
The ARN of the workspace.
creationDateTime (datetime) –
The date and time when the workspace was created.
description (string) –
The description of the workspace.
updateDateTime (datetime) –
The date and time when the workspace was last updated.
workspaceId (string) –
The ID of the workspace.
Exceptions
Adds tags to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceARN='string',
tags={
'string': 'string'
}
)
resourceARN (string) –
[REQUIRED]
The ARN of the resource.
tags (dict) –
[REQUIRED]
Metadata to add to this resource.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceARN='string',
tagKeys=[
'string',
]
)
resourceARN (string) –
[REQUIRED]
The ARN of the resource.
tagKeys (list) –
[REQUIRED]
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.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Updates information in a component type.
See also: AWS API Documentation
Request Syntax
response = client.update_component_type(
componentTypeId='string',
description='string',
extendsFrom=[
'string',
],
functions={
'string': {
'implementedBy': {
'isNative': True|False,
'lambda': {
'arn': 'string'
}
},
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE'
}
},
isSingleton=True|False,
propertyDefinitions={
'string': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
}
},
workspaceId='string'
)
componentTypeId (string) –
[REQUIRED]
The ID of the component type.
description (string) – The description of the component type.
extendsFrom (list) –
Specifies the component type that this component type extends.
(string) –
functions (dict) –
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
The function request body.
implementedBy (dict) –
The data connector.
isNative (boolean) –
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
lambda (dict) –
The Lambda function associated with this data connector.
arn (string) – [REQUIRED]
The ARN of the Lambda function.
requiredProperties (list) –
The required properties of the function.
(string) –
scope (string) –
The scope of the function.
isSingleton (boolean) – A Boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions (dict) –
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(string) –
(dict) –
An object that sets information about a property.
configuration (dict) –
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) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) – [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the component type.
dict
Response Syntax
{
'arn': 'string',
'componentTypeId': 'string',
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'workspaceId': 'string'
}
Response Structure
(dict) –
arn (string) –
The ARN of the component type.
componentTypeId (string) –
The ID of the component type.
state (string) –
The current state of the component type.
workspaceId (string) –
The ID of the workspace that contains the component type.
Exceptions
Updates an entity.
See also: AWS API Documentation
Request Syntax
response = client.update_entity(
componentUpdates={
'string': {
'componentTypeId': 'string',
'description': 'string',
'propertyUpdates': {
'string': {
'definition': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
},
'updateType': 'UPDATE'|'DELETE'|'CREATE',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
},
'updateType': 'CREATE'|'UPDATE'|'DELETE'
}
},
description='string',
entityId='string',
entityName='string',
parentEntityUpdate={
'parentEntityId': 'string',
'updateType': 'UPDATE'|'DELETE'
},
workspaceId='string'
)
componentUpdates (dict) –
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
(string) –
(dict) –
The component update request.
componentTypeId (string) –
The ID of the component type.
description (string) –
The description of the component type.
propertyUpdates (dict) –
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.
(string) –
(dict) –
An object that sets information about a property.
definition (dict) –
An object that specifies information about a property.
configuration (dict) –
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) –
(string) –
dataType (dict) –
An object that contains information about the data type.
allowedValues (list) –
The allowed values for this data type.
(dict) –
An object that specifies a value for a property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
nestedType (dict) –
The nested type in the data type.
relationship (dict) –
A relationship that associates a component with another component.
relationshipType (string) –
The type of the relationship.
targetComponentTypeId (string) –
The ID of the target component type associated with this relationship.
type (string) – [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) –
The unit of measure used in this data type.
defaultValue (dict) –
An object that contains the default value.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
isExternalId (boolean) –
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) –
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) –
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) –
A Boolean value that specifies whether the property consists of time series data.
updateType (string) –
The update type of the update property request.
value (dict) –
The value of the property.
booleanValue (boolean) –
A Boolean value.
doubleValue (float) –
A double value.
expression (string) –
An expression that produces the value.
integerValue (integer) –
An integer value.
listValue (list) –
A list of multiple values.
(dict) –
An object that specifies a value for a property.
longValue (integer) –
A long value.
mapValue (dict) –
An object that maps strings to multiple DataValue
objects.
(string) –
(dict) –
An object that specifies a value for a property.
relationshipValue (dict) –
A value that relates a component to another component.
targetComponentName (string) –
The name of the target component associated with the relationship value.
targetEntityId (string) –
The ID of the target entity associated with this relationship value.
stringValue (string) –
A string value.
updateType (string) –
The update type of the component update request.
description (string) – The description of the entity.
entityId (string) –
[REQUIRED]
The ID of the entity.
entityName (string) – The name of the entity.
parentEntityUpdate (dict) –
An object that describes the update request for a parent entity.
parentEntityId (string) –
The ID of the parent entity.
updateType (string) – [REQUIRED]
The type of the update.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the entity.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) –
state (string) –
The current state of the entity update.
updateDateTime (datetime) –
The date and time when the entity was last updated.
Exceptions
Updates a scene.
See also: AWS API Documentation
Request Syntax
response = client.update_scene(
capabilities=[
'string',
],
contentLocation='string',
description='string',
sceneId='string',
workspaceId='string'
)
capabilities (list) –
A list of capabilities that the scene uses to render.
(string) –
contentLocation (string) – The relative path that specifies the location of the content definition file.
description (string) – The description of this scene.
sceneId (string) –
[REQUIRED]
The ID of the scene.
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the scene.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) –
updateDateTime (datetime) –
The date and time when the scene was last updated.
Exceptions
Updates a workspace.
See also: AWS API Documentation
Request Syntax
response = client.update_workspace(
description='string',
role='string',
workspaceId='string'
)
description (string) – The description of the workspace.
role (string) – The ARN of the execution role associated with the workspace.
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) –
updateDateTime (datetime) –
The date and time of the current update.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Access is denied.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Access is denied.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A conflict occurred.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
A conflict occurred.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The connector failed.
Example
try:
...
except client.exceptions.ConnectorFailureException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The connector failed.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The connector timed out.
Example
try:
...
except client.exceptions.ConnectorTimeoutException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The connector timed out.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An unexpected error has occurred.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
An unexpected error has occurred.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The resource wasn’t found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The resource wasn’t found.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The service quota was exceeded.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The service quota was exceeded.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The rate exceeds the limit.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The rate exceeds the limit.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The number of tags exceeds the limit.
Example
try:
...
except client.exceptions.TooManyTagsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The number of tags exceeds the limit.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Failed
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Failed
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: