IoTTwinMaker / Client / list_component_types
list_component_types#
- IoTTwinMaker.Client.list_component_types(**kwargs)#
Lists all component types in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_component_types( workspaceId='string', filters=[ { 'extendsFrom': 'string', 'namespace': 'string', 'isAbstract': True|False }, ], nextToken='string', maxResults=123 )
- Parameters:
workspaceId (string) –
[REQUIRED]
The ID of the workspace.
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
,namespace
,isAbstract
.extendsFrom (string) –
The component type that the component types in the list extend.
namespace (string) –
The namespace to which the component types in the list belong.
isAbstract (boolean) –
A Boolean value that specifies whether the component types in the list are abstract.
nextToken (string) – The string that specifies the next page of results.
maxResults (integer) –
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- Return type:
dict
- Returns:
Response Syntax
{ 'workspaceId': 'string', 'componentTypeSummaries': [ { 'arn': 'string', 'componentTypeId': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'description': 'string', 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'componentTypeName': 'string' }, ], 'nextToken': 'string', 'maxResults': 123 }
Response Structure
(dict) –
workspaceId (string) –
The ID of the workspace.
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.
updateDateTime (datetime) –
The date and time when the component type was last updated.
description (string) –
The description of the component type.
status (dict) –
The current status of the component type.
state (string) –
The current state of the entity, component, component type, or workspace.
error (dict) –
The error message.
code (string) –
The error code.
message (string) –
The error message.
componentTypeName (string) –
The component type name.
nextToken (string) –
The string that specifies the next page of results.
maxResults (integer) –
Specifies the maximum number of results to display.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerException
IoTTwinMaker.Client.exceptions.AccessDeniedException
IoTTwinMaker.Client.exceptions.ThrottlingException
IoTTwinMaker.Client.exceptions.ValidationException