Skip to content

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[Union[PropertyValueEntryTypeDef, PropertyValueEntryOutputTypeDef]],  # (1)
) -> BatchPutPropertyValuesResponseTypeDef:  # (2)
    ...
  1. See PropertyValueEntryTypeDef PropertyValueEntryOutputTypeDef
  2. See BatchPutPropertyValuesResponseTypeDef
# batch_put_property_values method usage example with argument unpacking

kwargs: BatchPutPropertyValuesRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entries": ...,
}

parent.batch_put_property_values(**kwargs)
  1. See BatchPutPropertyValuesRequestRequestTypeDef

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)
    ...
  1. See CancelMetadataTransferJobResponseTypeDef
# cancel_metadata_transfer_job method usage example with argument unpacking

kwargs: CancelMetadataTransferJobRequestRequestTypeDef = {  # (1)
    "metadataTransferJobId": ...,
}

parent.cancel_metadata_transfer_job(**kwargs)
  1. See CancelMetadataTransferJobRequestRequestTypeDef

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)
    ...
  1. See PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef
  4. See CompositeComponentTypeRequestTypeDef
  5. See CreateComponentTypeResponseTypeDef
# create_component_type method usage example with argument unpacking

kwargs: CreateComponentTypeRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "componentTypeId": ...,
}

parent.create_component_type(**kwargs)
  1. See CreateComponentTypeRequestRequestTypeDef

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)
    ...
  1. See ComponentRequestTypeDef
  2. See CompositeComponentRequestTypeDef
  3. See CreateEntityResponseTypeDef
# create_entity method usage example with argument unpacking

kwargs: CreateEntityRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityName": ...,
}

parent.create_entity(**kwargs)
  1. See CreateEntityRequestRequestTypeDef

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[Union[SourceConfigurationTypeDef, SourceConfigurationOutputTypeDef]],  # (1)
    destination: DestinationConfigurationTypeDef,  # (2)
    metadataTransferJobId: str = ...,
    description: str = ...,
) -> CreateMetadataTransferJobResponseTypeDef:  # (3)
    ...
  1. See SourceConfigurationTypeDef SourceConfigurationOutputTypeDef
  2. See DestinationConfigurationTypeDef
  3. See CreateMetadataTransferJobResponseTypeDef
# create_metadata_transfer_job method usage example with argument unpacking

kwargs: CreateMetadataTransferJobRequestRequestTypeDef = {  # (1)
    "sources": ...,
    "destination": ...,
}

parent.create_metadata_transfer_job(**kwargs)
  1. See CreateMetadataTransferJobRequestRequestTypeDef

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)
    ...
  1. See CreateSceneResponseTypeDef
# create_scene method usage example with argument unpacking

kwargs: CreateSceneRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "sceneId": ...,
    "contentLocation": ...,
}

parent.create_scene(**kwargs)
  1. See CreateSceneRequestRequestTypeDef

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)
    ...
  1. See CreateSyncJobResponseTypeDef
# create_sync_job method usage example with argument unpacking

kwargs: CreateSyncJobRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "syncSource": ...,
    "syncRole": ...,
}

parent.create_sync_job(**kwargs)
  1. See CreateSyncJobRequestRequestTypeDef

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)
    ...
  1. See