IoTTwinMakerClient
Index > IoTTwinMaker > IoTTwinMakerClient
Auto-generated documentation for IoTTwinMaker type annotations stubs module mypy-boto3-iottwinmaker.
IoTTwinMakerClient
Type annotations and code completion for boto3.client("iottwinmaker")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_iottwinmaker.client import IoTTwinMakerClient
def get_iottwinmaker_client() -> IoTTwinMakerClient:
return Session().client("iottwinmaker")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iottwinmaker").exceptions
structure.
client = boto3.client("iottwinmaker")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.ConnectorFailureException,
client.ConnectorTimeoutException,
client.InternalServerException,
client.QueryTimeoutException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.TooManyTagsException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_iottwinmaker.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
batch_put_property_values
Sets values for multiple time series properties.
Type annotations and code completion for boto3.client("iottwinmaker").batch_put_property_values
method.
boto3 documentation
def batch_put_property_values(
self,
*,
workspaceId: str,
entries: Sequence[PropertyValueEntryTypeDef], # (1)
) -> BatchPutPropertyValuesResponseTypeDef: # (2)
...
kwargs: BatchPutPropertyValuesRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entries": ...,
}
parent.batch_put_property_values(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iottwinmaker").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iottwinmaker").close
method.
boto3 documentation
create_component_type
Creates a component type.
Type annotations and code completion for boto3.client("iottwinmaker").create_component_type
method.
boto3 documentation
def create_component_type(
self,
*,
workspaceId: str,
componentTypeId: str,
isSingleton: bool = ...,
description: str = ...,
propertyDefinitions: Mapping[str, PropertyDefinitionRequestTypeDef] = ..., # (1)
extendsFrom: Sequence[str] = ...,
functions: Mapping[str, FunctionRequestTypeDef] = ..., # (2)
tags: Mapping[str, str] = ...,
propertyGroups: Mapping[str, PropertyGroupRequestTypeDef] = ..., # (3)
componentTypeName: str = ...,
) -> CreateComponentTypeResponseTypeDef: # (4)
...
- See PropertyDefinitionRequestTypeDef
- See FunctionRequestTypeDef
- See PropertyGroupRequestTypeDef
- See CreateComponentTypeResponseTypeDef
kwargs: CreateComponentTypeRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"componentTypeId": ...,
}
parent.create_component_type(**kwargs)
create_entity
Creates an entity.
Type annotations and code completion for boto3.client("iottwinmaker").create_entity
method.
boto3 documentation
def create_entity(
self,
*,
workspaceId: str,
entityName: str,
entityId: str = ...,
description: str = ...,
components: Mapping[str, ComponentRequestTypeDef] = ..., # (1)
parentEntityId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateEntityResponseTypeDef: # (2)
...
kwargs: CreateEntityRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entityName": ...,
}
parent.create_entity(**kwargs)
create_scene
Creates a scene.
Type annotations and code completion for boto3.client("iottwinmaker").create_scene
method.
boto3 documentation
def create_scene(
self,
*,
workspaceId: str,
sceneId: str,
contentLocation: str,
description: str = ...,
capabilities: Sequence[str] = ...,
tags: Mapping[str, str] = ...,
) -> CreateSceneResponseTypeDef: # (1)
...
kwargs: CreateSceneRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"sceneId": ...,
"contentLocation": ...,
}
parent.create_scene(**kwargs)
create_sync_job
This action creates a SyncJob.
Type annotations and code completion for boto3.client("iottwinmaker").create_sync_job
method.
boto3 documentation
def create_sync_job(
self,
*,
workspaceId: str,
syncSource: str,
syncRole: str,
tags: Mapping[str, str] = ...,
) -> CreateSyncJobResponseTypeDef: # (1)
...
kwargs: CreateSyncJobRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"syncSource": ...,
"syncRole": ...,
}
parent.create_sync_job(**kwargs)
create_workspace
Creates a workplace.
Type annotations and code completion for boto3.client("iottwinmaker").create_workspace
method.
boto3 documentation
def create_workspace(
self,
*,
workspaceId: str,
s3Location: str,
role: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef: # (1)
...
kwargs: CreateWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"s3Location": ...,
"role": ...,
}
parent.create_workspace(**kwargs)
delete_component_type
Deletes a component type.
Type annotations and code completion for boto3.client("iottwinmaker").delete_component_type
method.
boto3 documentation
def delete_component_type(
self,
*,
workspaceId: str,
componentTypeId: str,
) -> DeleteComponentTypeResponseTypeDef: # (1)
...
kwargs: DeleteComponentTypeRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"componentTypeId": ...,
}
parent.delete_component_type(**kwargs)
delete_entity
Deletes an entity.
Type annotations and code completion for boto3.client("iottwinmaker").delete_entity
method.
boto3 documentation
def delete_entity(
self,
*,
workspaceId: str,
entityId: str,
isRecursive: bool = ...,
) -> DeleteEntityResponseTypeDef: # (1)
...
kwargs: DeleteEntityRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entityId": ...,
}
parent.delete_entity(**kwargs)
delete_scene
Deletes a scene.
Type annotations and code completion for boto3.client("iottwinmaker").delete_scene
method.
boto3 documentation
def delete_scene(
self,
*,
workspaceId: str,
sceneId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteSceneRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"sceneId": ...,
}
parent.delete_scene(**kwargs)
delete_sync_job
Delete the SyncJob.
Type annotations and code completion for boto3.client("iottwinmaker").delete_sync_job
method.
boto3 documentation
def delete_sync_job(
self,
*,
workspaceId: str,
syncSource: str,
) -> DeleteSyncJobResponseTypeDef: # (1)
...
kwargs: DeleteSyncJobRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"syncSource": ...,
}
parent.delete_sync_job(**kwargs)
delete_workspace
Deletes a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").delete_workspace
method.
boto3 documentation
kwargs: DeleteWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.delete_workspace(**kwargs)
execute_query
Run queries to access information from your knowledge graph of entities within individual workspaces.
Type annotations and code completion for boto3.client("iottwinmaker").execute_query
method.
boto3 documentation
def execute_query(
self,
*,
workspaceId: str,
queryStatement: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ExecuteQueryResponseTypeDef: # (1)
...
kwargs: ExecuteQueryRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"queryStatement": ...,
}
parent.execute_query(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("iottwinmaker").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_component_type
Retrieves information about a component type.
Type annotations and code completion for boto3.client("iottwinmaker").get_component_type
method.
boto3 documentation
def get_component_type(
self,
*,
workspaceId: str,
componentTypeId: str,
) -> GetComponentTypeResponseTypeDef: # (1)
...
kwargs: GetComponentTypeRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"componentTypeId": ...,
}
parent.get_component_type(**kwargs)
get_entity
Retrieves information about an entity.
Type annotations and code completion for boto3.client("iottwinmaker").get_entity
method.
boto3 documentation
def get_entity(
self,
*,
workspaceId: str,
entityId: str,
) -> GetEntityResponseTypeDef: # (1)
...
kwargs: GetEntityRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entityId": ...,
}
parent.get_entity(**kwargs)
get_pricing_plan
Gets the pricing plan.
Type annotations and code completion for boto3.client("iottwinmaker").get_pricing_plan
method.
boto3 documentation
get_property_value
Gets the property values for a component, component type, entity, or workspace.
Type annotations and code completion for boto3.client("iottwinmaker").get_property_value
method.
boto3 documentation
def get_property_value(
self,
*,
selectedProperties: Sequence[str],
workspaceId: str,
componentName: str = ...,
componentTypeId: str = ...,
entityId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
propertyGroupName: str = ...,
tabularConditions: TabularConditionsTypeDef = ..., # (1)
) -> GetPropertyValueResponseTypeDef: # (2)
...
kwargs: GetPropertyValueRequestRequestTypeDef = { # (1)
"selectedProperties": ...,
"workspaceId": ...,
}
parent.get_property_value(**kwargs)
get_property_value_history
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
Type annotations and code completion for boto3.client("iottwinmaker").get_property_value_history
method.
boto3 documentation
def get_property_value_history(
self,
*,
workspaceId: str,
selectedProperties: Sequence[str],
entityId: str = ...,
componentName: str = ...,
componentTypeId: str = ...,
propertyFilters: Sequence[PropertyFilterTypeDef] = ..., # (1)
startDateTime: Union[datetime, str] = ...,
endDateTime: Union[datetime, str] = ...,
interpolation: InterpolationParametersTypeDef = ..., # (2)
nextToken: str = ...,
maxResults: int = ...,
orderByTime: OrderByTimeType = ..., # (3)
startTime: str = ...,
endTime: str = ...,
) -> GetPropertyValueHistoryResponseTypeDef: # (4)
...
- See PropertyFilterTypeDef
- See InterpolationParametersTypeDef
- See OrderByTimeType
- See GetPropertyValueHistoryResponseTypeDef
kwargs: GetPropertyValueHistoryRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"selectedProperties": ...,
}
parent.get_property_value_history(**kwargs)
get_scene
Retrieves information about a scene.
Type annotations and code completion for boto3.client("iottwinmaker").get_scene
method.
boto3 documentation
def get_scene(
self,
*,
workspaceId: str,
sceneId: str,
) -> GetSceneResponseTypeDef: # (1)
...
kwargs: GetSceneRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"sceneId": ...,
}
parent.get_scene(**kwargs)
get_sync_job
Gets the SyncJob.
Type annotations and code completion for boto3.client("iottwinmaker").get_sync_job
method.
boto3 documentation
def get_sync_job(
self,
*,
syncSource: str,
workspaceId: str = ...,
) -> GetSyncJobResponseTypeDef: # (1)
...
kwargs: GetSyncJobRequestRequestTypeDef = { # (1)
"syncSource": ...,
}
parent.get_sync_job(**kwargs)
get_workspace
Retrieves information about a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").get_workspace
method.
boto3 documentation
def get_workspace(
self,
*,
workspaceId: str,
) -> GetWorkspaceResponseTypeDef: # (1)
...
kwargs: GetWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.get_workspace(**kwargs)
list_component_types
Lists all component types in a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").list_component_types
method.
boto3 documentation
def list_component_types(
self,
*,
workspaceId: str,
filters: Sequence[ListComponentTypesFilterTypeDef] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListComponentTypesResponseTypeDef: # (2)
...
kwargs: ListComponentTypesRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.list_component_types(**kwargs)
list_entities
Lists all entities in a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").list_entities
method.
boto3 documentation
def list_entities(
self,
*,
workspaceId: str,
filters: Sequence[ListEntitiesFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListEntitiesResponseTypeDef: # (2)
...
kwargs: ListEntitiesRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.list_entities(**kwargs)
list_scenes
Lists all scenes in a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").list_scenes
method.
boto3 documentation
def list_scenes(
self,
*,
workspaceId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListScenesResponseTypeDef: # (1)
...
kwargs: ListScenesRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.list_scenes(**kwargs)
list_sync_jobs
List all SyncJobs.
Type annotations and code completion for boto3.client("iottwinmaker").list_sync_jobs
method.
boto3 documentation
def list_sync_jobs(
self,
*,
workspaceId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSyncJobsResponseTypeDef: # (1)
...
kwargs: ListSyncJobsRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.list_sync_jobs(**kwargs)
list_sync_resources
Lists the sync resources.
Type annotations and code completion for boto3.client("iottwinmaker").list_sync_resources
method.
boto3 documentation
def list_sync_resources(
self,
*,
workspaceId: str,
syncSource: str,
filters: Sequence[SyncResourceFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListSyncResourcesResponseTypeDef: # (2)
...
kwargs: ListSyncResourcesRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"syncSource": ...,
}
parent.list_sync_resources(**kwargs)
list_tags_for_resource
Lists all tags associated with a resource.
Type annotations and code completion for boto3.client("iottwinmaker").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceARN: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_workspaces
Retrieves information about workspaces in the current account.
Type annotations and code completion for boto3.client("iottwinmaker").list_workspaces
method.
boto3 documentation
def list_workspaces(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef: # (1)
...
kwargs: ListWorkspacesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_workspaces(**kwargs)
tag_resource
Adds tags to a resource.
Type annotations and code completion for boto3.client("iottwinmaker").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceARN: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a resource.
Type annotations and code completion for boto3.client("iottwinmaker").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceARN: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_component_type
Updates information in a component type.
Type annotations and code completion for boto3.client("iottwinmaker").update_component_type
method.
boto3 documentation
def update_component_type(
self,
*,
workspaceId: str,
componentTypeId: str,
isSingleton: bool = ...,
description: str = ...,
propertyDefinitions: Mapping[str, PropertyDefinitionRequestTypeDef] = ..., # (1)
extendsFrom: Sequence[str] = ...,
functions: Mapping[str, FunctionRequestTypeDef] = ..., # (2)
propertyGroups: Mapping[str, PropertyGroupRequestTypeDef] = ..., # (3)
componentTypeName: str = ...,
) -> UpdateComponentTypeResponseTypeDef: # (4)
...
- See PropertyDefinitionRequestTypeDef
- See FunctionRequestTypeDef
- See PropertyGroupRequestTypeDef
- See UpdateComponentTypeResponseTypeDef
kwargs: UpdateComponentTypeRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"componentTypeId": ...,
}
parent.update_component_type(**kwargs)
update_entity
Updates an entity.
Type annotations and code completion for boto3.client("iottwinmaker").update_entity
method.
boto3 documentation
def update_entity(
self,
*,
workspaceId: str,
entityId: str,
entityName: str = ...,
description: str = ...,
componentUpdates: Mapping[str, ComponentUpdateRequestTypeDef] = ..., # (1)
parentEntityUpdate: ParentEntityUpdateRequestTypeDef = ..., # (2)
) -> UpdateEntityResponseTypeDef: # (3)
...
- See ComponentUpdateRequestTypeDef
- See ParentEntityUpdateRequestTypeDef
- See UpdateEntityResponseTypeDef
kwargs: UpdateEntityRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entityId": ...,
}
parent.update_entity(**kwargs)
update_pricing_plan
Update the pricing plan.
Type annotations and code completion for boto3.client("iottwinmaker").update_pricing_plan
method.
boto3 documentation
def update_pricing_plan(
self,
*,
pricingMode: PricingModeType, # (1)
bundleNames: Sequence[str] = ...,
) -> UpdatePricingPlanResponseTypeDef: # (2)
...
kwargs: UpdatePricingPlanRequestRequestTypeDef = { # (1)
"pricingMode": ...,
}
parent.update_pricing_plan(**kwargs)
update_scene
Updates a scene.
Type annotations and code completion for boto3.client("iottwinmaker").update_scene
method.
boto3 documentation
def update_scene(
self,
*,
workspaceId: str,
sceneId: str,
contentLocation: str = ...,
description: str = ...,
capabilities: Sequence[str] = ...,
) -> UpdateSceneResponseTypeDef: # (1)
...
kwargs: UpdateSceneRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"sceneId": ...,
}
parent.update_scene(**kwargs)
update_workspace
Updates a workspace.
Type annotations and code completion for boto3.client("iottwinmaker").update_workspace
method.
boto3 documentation
def update_workspace(
self,
*,
workspaceId: str,
description: str = ...,
role: str = ...,
) -> UpdateWorkspaceResponseTypeDef: # (1)
...