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
# IoTTwinMakerClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("iottwinmaker")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ConnectorFailureException,
client.exceptions.ConnectorTimeoutException,
client.exceptions.InternalServerException,
client.exceptions.QueryTimeoutException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
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
# batch_put_property_values method definition
def batch_put_property_values(
self,
*,
workspaceId: str,
entries: Sequence[PropertyValueEntryTypeDef], # (1)
) -> BatchPutPropertyValuesResponseTypeDef: # (2)
...
# batch_put_property_values method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_metadata_transfer_job#
Cancels the metadata transfer job.
Type annotations and code completion for boto3.client("iottwinmaker").cancel_metadata_transfer_job
method.
boto3 documentation
# cancel_metadata_transfer_job method definition
def cancel_metadata_transfer_job(
self,
*,
metadataTransferJobId: str,
) -> CancelMetadataTransferJobResponseTypeDef: # (1)
...
# cancel_metadata_transfer_job method usage example with argument unpacking
kwargs: CancelMetadataTransferJobRequestRequestTypeDef = { # (1)
"metadataTransferJobId": ...,
}
parent.cancel_metadata_transfer_job(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iottwinmaker").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_component_type#
Creates a component type.
Type annotations and code completion for boto3.client("iottwinmaker").create_component_type
method.
boto3 documentation
# create_component_type method definition
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 = ...,
compositeComponentTypes: Mapping[str, CompositeComponentTypeRequestTypeDef] = ..., # (4)
) -> CreateComponentTypeResponseTypeDef: # (5)
...
- See PropertyDefinitionRequestTypeDef
- See FunctionRequestTypeDef
- See PropertyGroupRequestTypeDef
- See CompositeComponentTypeRequestTypeDef
- See CreateComponentTypeResponseTypeDef
# create_component_type method usage example with argument unpacking
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
# create_entity method definition
def create_entity(
self,
*,
workspaceId: str,
entityName: str,
entityId: str = ...,
description: str = ...,
components: Mapping[str, ComponentRequestTypeDef] = ..., # (1)
compositeComponents: Mapping[str, CompositeComponentRequestTypeDef] = ..., # (2)
parentEntityId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateEntityResponseTypeDef: # (3)
...
# create_entity method usage example with argument unpacking
kwargs: CreateEntityRequestRequestTypeDef = { # (1)
"workspaceId": ...,
"entityName": ...,
}
parent.create_entity(**kwargs)
create_metadata_transfer_job#
Creates a new metadata transfer job.
Type annotations and code completion for boto3.client("iottwinmaker").create_metadata_transfer_job
method.
boto3 documentation
# create_metadata_transfer_job method definition
def create_metadata_transfer_job(
self,
*,
sources: Sequence[SourceConfigurationTypeDef], # (1)
destination: DestinationConfigurationTypeDef, # (2)
metadataTransferJobId: str = ...,
description: str = ...,
) -> CreateMetadataTransferJobResponseTypeDef: # (3)
...
- See SourceConfigurationTypeDef
- See DestinationConfigurationTypeDef
- See CreateMetadataTransferJobResponseTypeDef
# create_metadata_transfer_job method usage example with argument unpacking
kwargs: CreateMetadataTransferJobRequestRequestTypeDef = { # (1)
"sources": ...,
"destination": ...,
}
parent.create_metadata_transfer_job(**kwargs)
create_scene#
Creates a scene.
Type annotations and code completion for boto3.client("iottwinmaker").create_scene
method.
boto3 documentation
# create_scene method definition
def create_scene(
self,
*,
workspaceId: str,
sceneId: str,
contentLocation: str,
description: str = ...,
capabilities: Sequence[str] = ...,
tags: Mapping[str, str] = ...,
sceneMetadata: Mapping[str, str] = ...,
) -> CreateSceneResponseTypeDef: # (1)
...
# create_scene method usage example with argument unpacking
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
# create_sync_job method definition
def create_sync_job(
self,
*,
workspaceId: str,
syncSource: str,
syncRole: str,
tags: Mapping[str, str] = ...,
) -> CreateSyncJobResponseTypeDef: # (1)
...
# create_sync_job method usage example with argument unpacking
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
# create_workspace method definition
def create_workspace(
self,
*,
workspaceId: str,
description: str = ...,
s3Location: str = ...,
role: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef: # (1)
...
# create_workspace method usage example with argument unpacking
kwargs: CreateWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
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
# delete_component_type method definition
def delete_component_type(
self,
*,
workspaceId: str,
componentTypeId: str,
) -> DeleteComponentTypeResponseTypeDef: # (1)
...
# delete_component_type method usage example with argument unpacking
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
# delete_entity method definition
def delete_entity(
self,
*,
workspaceId: str,
entityId: str,
isRecursive: bool = ...,
) -> DeleteEntityResponseTypeDef: # (1)
...
# delete_entity method usage example with argument unpacking
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
# delete_scene method definition
def delete_scene(
self,
*,
workspaceId: str,
sceneId: str,
) -> Dict[str, Any]:
...
# delete_scene method usage example with argument unpacking
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
# delete_sync_job method definition
def delete_sync_job(
self,
*,
workspaceId: str,
syncSource: str,
) -> DeleteSyncJobResponseTypeDef: # (1)
...
# delete_sync_job method usage example with argument unpacking
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
# delete_workspace method definition
def delete_workspace(
self,
*,
workspaceId: str,
) -> DeleteWorkspaceResponseTypeDef: # (1)
...
# delete_workspace method usage example with argument unpacking
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.