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

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.

Usage example
client = boto3.client("iottwinmaker")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.ConnectorFailureException,
    client.ConnectorTimeoutException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.TooManyTagsException,
    client.ValidationException,
) as e:
    print(e)
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

Method definition
def batch_put_property_values(
    self,
    *,
    entries: Sequence[PropertyValueEntryTypeDef],  # (1)
    workspaceId: str,
) -> BatchPutPropertyValuesResponseTypeDef:  # (2)
    ...
  1. See PropertyValueEntryTypeDef
  2. See BatchPutPropertyValuesResponseTypeDef
Usage example with kwargs
kwargs: BatchPutPropertyValuesRequestRequestTypeDef = {  # (1)
    "entries": ...,
    "workspaceId": ...,
}

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

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iottwinmaker").close method. boto3 documentation

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

Method definition
def create_component_type(
    self,
    *,
    componentTypeId: str,
    workspaceId: str,
    description: str = ...,
    extendsFrom: Sequence[str] = ...,
    functions: Mapping[str, FunctionRequestTypeDef] = ...,  # (1)
    isSingleton: bool = ...,
    propertyDefinitions: Mapping[str, PropertyDefinitionRequestTypeDef] = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateComponentTypeResponseTypeDef:  # (3)
    ...
  1. See FunctionRequestTypeDef
  2. See PropertyDefinitionRequestTypeDef
  3. See CreateComponentTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateComponentTypeRequestRequestTypeDef = {  # (1)
    "componentTypeId": ...,
    "workspaceId": ...,
}

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

Method definition
def create_entity(
    self,
    *,
    entityName: str,
    workspaceId: str,
    components: Mapping[str, ComponentRequestTypeDef] = ...,  # (1)
    description: str = ...,
    entityId: str = ...,
    parentEntityId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateEntityResponseTypeDef:  # (2)
    ...
  1. See ComponentRequestTypeDef
  2. See CreateEntityResponseTypeDef
Usage example with kwargs
kwargs: CreateEntityRequestRequestTypeDef = {  # (1)
    "entityName": ...,
    "workspaceId": ...,
}

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

create_scene

Creates a scene.

Type annotations and code completion for boto3.client("iottwinmaker").create_scene method. boto3 documentation

Method definition
def create_scene(
    self,
    *,
    contentLocation: str,
    sceneId: str,
    workspaceId: str,
    capabilities: Sequence[str] = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateSceneResponseTypeDef:  # (1)
    ...
  1. See CreateSceneResponseTypeDef
Usage example with kwargs
kwargs: CreateSceneRequestRequestTypeDef = {  # (1)
    "contentLocation": ...,
    "sceneId": ...,
    "workspaceId": ...,
}

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

create_workspace

Creates a workplace.

Type annotations and code completion for boto3.client("iottwinmaker").create_workspace method. boto3 documentation

Method definition
def create_workspace(
    self,
    *,
    role: str,
    s3Location: str,
    workspaceId: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkspaceResponseTypeDef:  # (1)
    ...
  1. See CreateWorkspaceResponseTypeDef
Usage example with kwargs
kwargs: CreateWorkspaceRequestRequestTypeDef = {  # (1)
    "role": ...,
    "s3Location": ...,
    "workspaceId": ...,
}

parent.create_workspace(**kwargs)
  1. See CreateWorkspaceRequestRequestTypeDef

delete_component_type

Deletes a component type.

Type annotations and code completion for boto3.client("iottwinmaker").delete_component_type method. boto3 documentation

Method definition
def delete_component_type(
    self,
    *,
    componentTypeId: str,
    workspaceId: str,
) -> DeleteComponentTypeResponseTypeDef:  # (1)
    ...
  1. See DeleteComponentTypeResponseTypeDef
Usage example with kwargs
kwargs: DeleteComponentTypeRequestRequestTypeDef = {  # (1)
    "componentTypeId": ...,
    "workspaceId": ...,
}

parent.delete_component_type(**kwargs)
  1. See DeleteComponentTypeRequestRequestTypeDef

delete_entity

Deletes an entity.

Type annotations and code completion for boto3.client("iottwinmaker").delete_entity method. boto3 documentation

Method definition
def delete_entity(
    self,
    *,
    entityId: str,
    workspaceId: str,
    isRecursive: bool = ...,
) -> DeleteEntityResponseTypeDef:  # (1)
    ...
  1. See DeleteEntityResponseTypeDef
Usage example with kwargs
kwargs: DeleteEntityRequestRequestTypeDef = {  # (1)
    "entityId": ...,
    "workspaceId": ...,
}

parent.delete_entity(**kwargs)
  1. See DeleteEntityRequestRequestTypeDef

delete_scene

Deletes a scene.

Type annotations and code completion for boto3.client("iottwinmaker").delete_scene method. boto3 documentation

Method definition
def delete_scene(
    self,
    *,
    sceneId: str,
    workspaceId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSceneRequestRequestTypeDef = {  # (1)
    "sceneId": ...,
    "workspaceId": ...,
}

parent.delete_scene(**kwargs)
  1. See DeleteSceneRequestRequestTypeDef

delete_workspace

Deletes a workspace.

Type annotations and code completion for boto3.client("iottwinmaker").delete_workspace method. boto3 documentation

Method definition
def delete_workspace(
    self,
    *,
    workspaceId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.delete_workspace(**kwargs)
  1. See DeleteWorkspaceRequestRequestTypeDef

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

Method definition
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

Method definition
def get_component_type(
    self,
    *,
    componentTypeId: str,
    workspaceId: str,
) -> GetComponentTypeResponseTypeDef:  # (1)
    ...
  1. See GetComponentTypeResponseTypeDef
Usage example with kwargs
kwargs: GetComponentTypeRequestRequestTypeDef = {  # (1)
    "componentTypeId": ...,
    "workspaceId": ...,
}

parent.get_component_type(**kwargs)
  1. See GetComponentTypeRequestRequestTypeDef

get_entity

Retrieves information about an entity.

Type annotations and code completion for boto3.client("iottwinmaker").get_entity method. boto3 documentation

Method definition
def get_entity(
    self,
    *,
    entityId: str,
    workspaceId: str,
) -> GetEntityResponseTypeDef:  # (1)
    ...
  1. See GetEntityResponseTypeDef
Usage example with kwargs
kwargs: GetEntityRequestRequestTypeDef = {  # (1)
    "entityId": ...,
    "workspaceId": ...,
}

parent.get_entity(**kwargs)
  1. See GetEntityRequestRequestTypeDef

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

Method definition
def get_property_value(
    self,
    *,
    selectedProperties: Sequence[str],
    workspaceId: str,
    componentName: str = ...,
    componentTypeId: str = ...,
    entityId: str = ...,
) -> GetPropertyValueResponseTypeDef:  # (1)
    ...
  1. See GetPropertyValueResponseTypeDef
Usage example with kwargs
kwargs: GetPropertyValueRequestRequestTypeDef = {  # (1)
    "selectedProperties": ...,
    "workspaceId": ...,
}

parent.get_property_value(**kwargs)
  1. See GetPropertyValueRequestRequestTypeDef

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

Method definition
def get_property_value_history(
    self,
    *,
    selectedProperties: Sequence[str],
    workspaceId: str,
    componentName: str = ...,
    componentTypeId: str = ...,
    endDateTime: Union[datetime, str] = ...,
    endTime: str = ...,
    entityId: str = ...,
    interpolation: InterpolationParametersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    orderByTime: OrderByTimeType = ...,  # (2)
    propertyFilters: Sequence[PropertyFilterTypeDef] = ...,  # (3)
    startDateTime: Union[datetime, str] = ...,
    startTime: str = ...,
) -> GetPropertyValueHistoryResponseTypeDef:  # (4)
    ...
  1. See InterpolationParametersTypeDef
  2. See OrderByTimeType
  3. See PropertyFilterTypeDef
  4. See GetPropertyValueHistoryResponseTypeDef
Usage example with kwargs
kwargs: GetPropertyValueHistoryRequestRequestTypeDef = {  # (1)
    "selectedProperties": ...,
    "workspaceId": ...,
}

parent.get_property_value_history(**kwargs)
  1. See GetPropertyValueHistoryRequestRequestTypeDef

get_scene

Retrieves information about a scene.

Type annotations and code completion for boto3.client("iottwinmaker").get_scene method. boto3 documentation

Method definition
def get_scene(
    self,
    *,
    sceneId: str,
    workspaceId: str,
) -> GetSceneResponseTypeDef:  # (1)
    ...
  1. See GetSceneResponseTypeDef
Usage example with kwargs
kwargs: GetSceneRequestRequestTypeDef = {  # (1)
    "sceneId": ...,
    "workspaceId": ...,
}

parent.get_scene(**kwargs)
  1. See GetSceneRequestRequestTypeDef

get_workspace

Retrieves information about a workspace.

Type annotations and code completion for boto3.client("iottwinmaker").get_workspace method. boto3 documentation

Method definition
def get_workspace(
    self,
    *,
    workspaceId: str,
) -> GetWorkspaceResponseTypeDef:  # (1)
    ...
  1. See GetWorkspaceResponseTypeDef
Usage example with kwargs
kwargs: GetWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.get_workspace(**kwargs)
  1. See GetWorkspaceRequestRequestTypeDef

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

Method definition
def list_component_types(
    self,
    *,
    workspaceId: str,
    filters: Sequence[ListComponentTypesFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComponentTypesResponseTypeDef:  # (2)
    ...
  1. See ListComponentTypesFilterTypeDef
  2. See ListComponentTypesResponseTypeDef
Usage example with kwargs
kwargs: ListComponentTypesRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_component_types(**kwargs)
  1. See ListComponentTypesRequestRequestTypeDef

list_entities

Lists all entities in a workspace.

Type annotations and code completion for boto3.client("iottwinmaker").list_entities method. boto3 documentation

Method definition
def list_entities(
    self,
    *,
    workspaceId: str,
    filters: Sequence[ListEntitiesFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEntitiesResponseTypeDef:  # (2)
    ...
  1. See ListEntitiesFilterTypeDef
  2. See ListEntitiesResponseTypeDef
Usage example with kwargs
kwargs: ListEntitiesRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_entities(**kwargs)
  1. See ListEntitiesRequestRequestTypeDef

list_scenes

Lists all scenes in a workspace.

Type annotations and code completion for boto3.client("iottwinmaker").list_scenes method. boto3 documentation

Method definition
def list_scenes(
    self,
    *,
    workspaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListScenesResponseTypeDef:  # (1)
    ...
  1. See ListScenesResponseTypeDef
Usage example with kwargs
kwargs: ListScenesRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_scenes(**kwargs)
  1. See ListScenesRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceARN: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_workspaces

Retrieves information about workspaces in the current account.

Type annotations and code completion for boto3.client("iottwinmaker").list_workspaces method. boto3 documentation

Method definition
def list_workspaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef:  # (1)
    ...
  1. See ListWorkspacesResponseTypeDef
Usage example with kwargs
kwargs: ListWorkspacesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workspaces(**kwargs)
  1. See ListWorkspacesRequestRequestTypeDef

tag_resource

Adds tags to a resource.

Type annotations and code completion for boto3.client("iottwinmaker").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceARN: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a resource.

Type annotations and code completion for boto3.client("iottwinmaker").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceARN: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_component_type

Updates information in a component type.

Type annotations and code completion for boto3.client("iottwinmaker").update_component_type method. boto3 documentation

Method definition
def update_component_type(
    self,
    *,
    componentTypeId: str,
    workspaceId: str,
    description: str = ...,
    extendsFrom: Sequence[str] = ...,
    functions: Mapping[str, FunctionRequestTypeDef] = ...,  # (1)
    isSingleton: bool = ...,
    propertyDefinitions: Mapping[str, PropertyDefinitionRequestTypeDef] = ...,  # (2)
) -> UpdateComponentTypeResponseTypeDef:  # (3)
    ...
  1. See FunctionRequestTypeDef
  2. See PropertyDefinitionRequestTypeDef
  3. See UpdateComponentTypeResponseTypeDef
Usage example with kwargs
kwargs: UpdateComponentTypeRequestRequestTypeDef = {  # (1)
    "componentTypeId": ...,
    "workspaceId": ...,
}

parent.update_component_type(**kwargs)
  1. See UpdateComponentTypeRequestRequestTypeDef

update_entity

Updates an entity.

Type annotations and code completion for boto3.client("iottwinmaker").update_entity method. boto3 documentation

Method definition
def update_entity(
    self,
    *,
    entityId: str,
    workspaceId: str,
    componentUpdates: Mapping[str, ComponentUpdateRequestTypeDef] = ...,  # (1)
    description: str = ...,
    entityName: str = ...,
    parentEntityUpdate: ParentEntityUpdateRequestTypeDef = ...,  # (2)
) -> UpdateEntityResponseTypeDef:  # (3)
    ...
  1. See ComponentUpdateRequestTypeDef
  2. See ParentEntityUpdateRequestTypeDef
  3. See UpdateEntityResponseTypeDef
Usage example with kwargs
kwargs: UpdateEntityRequestRequestTypeDef = {  # (1)
    "entityId": ...,
    "workspaceId": ...,
}

parent.update_entity(**kwargs)
  1. See UpdateEntityRequestRequestTypeDef

update_scene

Updates a scene.

Type annotations and code completion for boto3.client("iottwinmaker").update_scene method. boto3 documentation

Method definition
def update_scene(
    self,
    *,
    sceneId: str,
    workspaceId: str,
    capabilities: Sequence[str] = ...,
    contentLocation: str = ...,
    description: str = ...,
) -> UpdateSceneResponseTypeDef:  # (1)
    ...
  1. See UpdateSceneResponseTypeDef
Usage example with kwargs
kwargs: UpdateSceneRequestRequestTypeDef = {  # (1)
    "sceneId": ...,
    "workspaceId": ...,
}

parent.update_scene(**kwargs)
  1. See UpdateSceneRequestRequestTypeDef

update_workspace

Updates a workspace.

Type annotations and code completion for boto3.client("iottwinmaker").update_workspace method. boto3 documentation

Method definition
def update_workspace(
    self,
    *,
    workspaceId: str,
    description: str = ...,
    role: str = ...,
) -> UpdateWorkspaceResponseTypeDef:  # (1)
    ...
  1. See UpdateWorkspaceResponseTypeDef
Usage example with kwargs
kwargs: UpdateWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.update_workspace(**kwargs)
  1. See UpdateWorkspaceRequestRequestTypeDef