update_component_type
(**kwargs)¶Updates information in a component type.
See also: AWS API Documentation
Request Syntax
response = client.update_component_type(
workspaceId='string',
isSingleton=True|False,
componentTypeId='string',
description='string',
propertyDefinitions={
'string': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
}
},
extendsFrom=[
'string',
],
functions={
'string': {
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE',
'implementedBy': {
'lambda': {
'arn': 'string'
},
'isNative': True|False
}
}
},
propertyGroups={
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
]
}
},
componentTypeName='string'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The ID of the component type.
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
An object that sets information about a property.
An object that contains information about the data type.
The underlying type of the data type.
The nested type in the data type.
The allowed values for this data type.
An object that specifies a value for a property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that maps strings to multiple DataValue
objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The unit of measure used in this data type.
A relationship that associates a component with another component.
The ID of the target component type associated with this relationship.
The type of the relationship.
A Boolean value that specifies whether the property is required.
A Boolean value that specifies whether the property ID comes from an external data store.
A Boolean value that specifies whether the property is stored externally.
A Boolean value that specifies whether the property consists of time series data.
An object that contains the default value.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue
objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
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.
A friendly name for the property.
Specifies the component type that this component type extends.
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
The function request body.
The required properties of the function.
The scope of the function.
The data connector.
The Lambda function associated with this data connector.
The ARN of the Lambda function.
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
The property groups
The group type.
The names of properties.
dict
Response Syntax
{
'workspaceId': 'string',
'arn': 'string',
'componentTypeId': 'string',
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace that contains the component type.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerException
IoTTwinMaker.Client.exceptions.AccessDeniedException
IoTTwinMaker.Client.exceptions.ResourceNotFoundException
IoTTwinMaker.Client.exceptions.ThrottlingException
IoTTwinMaker.Client.exceptions.ValidationException
IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException