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[PropertyValueEntryUnionTypeDef],  # (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[SourceConfigurationUnionTypeDef],  # (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 CreateWorkspaceResponseTypeDef 
# create_workspace method usage example with argument unpacking

kwargs: CreateWorkspaceRequestRequestTypeDef = {  # (1)
    "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

# delete_component_type method definition

def delete_component_type(
    self,
    *,
    workspaceId: str,
    componentTypeId: str,
) -> DeleteComponentTypeResponseTypeDef:  # (1)
    ...
  1. See DeleteComponentTypeResponseTypeDef 
# delete_component_type method usage example with argument unpacking

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

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

# delete_entity method definition

def delete_entity(
    self,
    *,
    workspaceId: str,
    entityId: str,
    isRecursive: bool = ...,
) -> DeleteEntityResponseTypeDef:  # (1)
    ...
  1. See DeleteEntityResponseTypeDef 
# delete_entity method usage example with argument unpacking

kwargs: DeleteEntityRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityId": ...,
}

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

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

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

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

parent.delete_sync_job(**kwargs)
  1. See DeleteSyncJobRequestRequestTypeDef

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

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

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

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

# execute_query method definition

def execute_query(
    self,
    *,
    workspaceId: str,
    queryStatement: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ExecuteQueryResponseTypeDef:  # (1)
    ...
  1. See ExecuteQueryResponseTypeDef 
# execute_query method usage example with argument unpacking

kwargs: ExecuteQueryRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "queryStatement": ...,
}

parent.execute_query(**kwargs)
  1. See ExecuteQueryRequestRequestTypeDef

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

# generate_presigned_url 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

# get_component_type method definition

def get_component_type(
    self,
    *,
    workspaceId: str,
    componentTypeId: str,
) -> GetComponentTypeResponseTypeDef:  # (1)
    ...
  1. See GetComponentTypeResponseTypeDef 
# get_component_type method usage example with argument unpacking

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

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

# get_entity method definition

def get_entity(
    self,
    *,
    workspaceId: str,
    entityId: str,
) -> GetEntityResponseTypeDef:  # (1)
    ...
  1. See GetEntityResponseTypeDef 
# get_entity method usage example with argument unpacking

kwargs: GetEntityRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityId": ...,
}

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

get_metadata_transfer_job#

Gets a nmetadata transfer job.

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

# get_metadata_transfer_job method definition

def get_metadata_transfer_job(
    self,
    *,
    metadataTransferJobId: str,
) -> GetMetadataTransferJobResponseTypeDef:  # (1)
    ...
  1. See GetMetadataTransferJobResponseTypeDef 
# get_metadata_transfer_job method usage example with argument unpacking

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

parent.get_metadata_transfer_job(**kwargs)
  1. See GetMetadataTransferJobRequestRequestTypeDef

get_pricing_plan#

Gets the pricing plan.

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

# get_pricing_plan method definition

def get_pricing_plan(
    self,
) -> GetPricingPlanResponseTypeDef:  # (1)
    ...
  1. See GetPricingPlanResponseTypeDef

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

# get_property_value method definition

def get_property_value(
    self,
    *,
    selectedProperties: Sequence[str],
    workspaceId: str,
    componentName: str = ...,
    componentPath: str = ...,
    componentTypeId: str = ...,
    entityId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    propertyGroupName: str = ...,
    tabularConditions: TabularConditionsTypeDef = ...,  # (1)
) -> GetPropertyValueResponseTypeDef:  # (2)
    ...
  1. See TabularConditionsTypeDef
  2. See GetPropertyValueResponseTypeDef 
# get_property_value method usage example with argument unpacking

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

# get_property_value_history method definition

def get_property_value_history(
    self,
    *,
    workspaceId: str,
    selectedProperties: Sequence[str],
    entityId: str = ...,
    componentName: str = ...,
    componentPath: str = ...,
    componentTypeId: str = ...,
    propertyFilters: Sequence[PropertyFilterTypeDef] = ...,  # (1)
    startDateTime: TimestampTypeDef = ...,
    endDateTime: TimestampTypeDef = ...,
    interpolation: InterpolationParametersTypeDef = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
    orderByTime: OrderByTimeType = ...,  # (3)
    startTime: str = ...,
    endTime: str = ...,
) -> GetPropertyValueHistoryResponseTypeDef:  # (4)
    ...
  1. See PropertyFilterTypeDef
  2. See InterpolationParametersTypeDef
  3. See OrderByTimeType
  4. See GetPropertyValueHistoryResponseTypeDef 
# get_property_value_history method usage example with argument unpacking

kwargs: GetPropertyValueHistoryRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "selectedProperties": ...,
}

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

# get_scene method definition

def get_scene(
    self,
    *,
    workspaceId: str,
    sceneId: str,
) -> GetSceneResponseTypeDef:  # (1)
    ...
  1. See GetSceneResponseTypeDef 
# get_scene method usage example with argument unpacking

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

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

get_sync_job#

Gets the SyncJob.

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

# get_sync_job method definition

def get_sync_job(
    self,
    *,
    syncSource: str,
    workspaceId: str = ...,
) -> GetSyncJobResponseTypeDef:  # (1)
    ...
  1. See GetSyncJobResponseTypeDef 
# get_sync_job method usage example with argument unpacking

kwargs: GetSyncJobRequestRequestTypeDef = {  # (1)
    "syncSource": ...,
}

parent.get_sync_job(**kwargs)
  1. See GetSyncJobRequestRequestTypeDef

get_workspace#

Retrieves information about a workspace.

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

# get_workspace method definition

def get_workspace(
    self,
    *,
    workspaceId: str,
) -> GetWorkspaceResponseTypeDef:  # (1)
    ...
  1. See GetWorkspaceResponseTypeDef 
# get_workspace method usage example with argument unpacking

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

# list_component_types method definition

def list_component_types(
    self,
    *,
    workspaceId: str,
    filters: Sequence[ListComponentTypesFilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListComponentTypesResponseTypeDef:  # (2)
    ...
  1. See ListComponentTypesFilterTypeDef
  2. See ListComponentTypesResponseTypeDef 
# list_component_types method usage example with argument unpacking

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

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

list_components#

This API lists the components of an entity.

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

# list_components method definition

def list_components(
    self,
    *,
    workspaceId: str,
    entityId: str,
    componentPath: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComponentsResponseTypeDef:  # (1)
    ...
  1. See ListComponentsResponseTypeDef 
# list_components method usage example with argument unpacking

kwargs: ListComponentsRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityId": ...,
}

parent.list_components(**kwargs)
  1. See ListComponentsRequestRequestTypeDef

list_entities#

Lists all entities in a workspace.

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

# list_entities method definition

def list_entities(
    self,
    *,
    workspaceId: str,
    filters: Sequence[ListEntitiesFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEntitiesResponseTypeDef:  # (2)
    ...
  1. See ListEntitiesFilterTypeDef
  2. See ListEntitiesResponseTypeDef 
# list_entities method usage example with argument unpacking

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

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

list_metadata_transfer_jobs#

Lists the metadata transfer jobs.

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

# list_metadata_transfer_jobs method definition

def list_metadata_transfer_jobs(
    self,
    *,
    sourceType: SourceTypeType,  # (1)
    destinationType: DestinationTypeType,  # (2)
    filters: Sequence[ListMetadataTransferJobsFilterTypeDef] = ...,  # (3)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMetadataTransferJobsResponseTypeDef:  # (4)
    ...
  1. See SourceTypeType
  2. See DestinationTypeType
  3. See ListMetadataTransferJobsFilterTypeDef
  4. See ListMetadataTransferJobsResponseTypeDef 
# list_metadata_transfer_jobs method usage example with argument unpacking

kwargs: ListMetadataTransferJobsRequestRequestTypeDef = {  # (1)
    "sourceType": ...,
    "destinationType": ...,
}

parent.list_metadata_transfer_jobs(**kwargs)
  1. See ListMetadataTransferJobsRequestRequestTypeDef

list_properties#

This API lists the properties of a component.

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

# list_properties method definition

def list_properties(
    self,
    *,
    workspaceId: str,
    entityId: str,
    componentName: str = ...,
    componentPath: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPropertiesResponseTypeDef:  # (1)
    ...
  1. See ListPropertiesResponseTypeDef 
# list_properties method usage example with argument unpacking

kwargs: ListPropertiesRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityId": ...,
}

parent.list_properties(**kwargs)
  1. See ListPropertiesRequestRequestTypeDef

list_scenes#

Lists all scenes in a workspace.

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

# list_scenes method definition

def list_scenes(
    self,
    *,
    workspaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListScenesResponseTypeDef:  # (1)
    ...
  1. See ListScenesResponseTypeDef 
# list_scenes method usage example with argument unpacking

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

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

list_sync_jobs#

List all SyncJobs.

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

# list_sync_jobs method definition

def list_sync_jobs(
    self,
    *,
    workspaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSyncJobsResponseTypeDef:  # (1)
    ...
  1. See ListSyncJobsResponseTypeDef 
# list_sync_jobs method usage example with argument unpacking

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

parent.list_sync_jobs(**kwargs)
  1. See ListSyncJobsRequestRequestTypeDef

list_sync_resources#

Lists the sync resources.

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

# list_sync_resources method definition

def list_sync_resources(
    self,
    *,
    workspaceId: str,
    syncSource: str,
    filters: Sequence[SyncResourceFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSyncResourcesResponseTypeDef:  # (2)
    ...
  1. See SyncResourceFilterTypeDef
  2. See ListSyncResourcesResponseTypeDef 
# list_sync_resources method usage example with argument unpacking

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

parent.list_sync_resources(**kwargs)
  1. See ListSyncResourcesRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceARN: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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

# list_workspaces method definition

def list_workspaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef:  # (1)
    ...
  1. See ListWorkspacesResponseTypeDef 
# list_workspaces method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceARN: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceARN: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

# update_component_type method definition

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 = ...,
    compositeComponentTypes: Mapping[str, CompositeComponentTypeRequestTypeDef] = ...,  # (4)
) -> UpdateComponentTypeResponseTypeDef:  # (5)
    ...
  1. See PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef
  4. See CompositeComponentTypeRequestTypeDef
  5. See UpdateComponentTypeResponseTypeDef 
# update_component_type method usage example with argument unpacking

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

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

# update_entity method definition

def update_entity(
    self,
    *,
    workspaceId: str,
    entityId: str,
    entityName: str = ...,
    description: str = ...,
    componentUpdates: Mapping[str, ComponentUpdateRequestTypeDef] = ...,  # (1)
    compositeComponentUpdates: Mapping[str, CompositeComponentUpdateRequestTypeDef] = ...,  # (2)
    parentEntityUpdate: ParentEntityUpdateRequestTypeDef = ...,  # (3)
) -> UpdateEntityResponseTypeDef:  # (4)
    ...
  1. See ComponentUpdateRequestTypeDef
  2. See CompositeComponentUpdateRequestTypeDef
  3. See ParentEntityUpdateRequestTypeDef
  4. See UpdateEntityResponseTypeDef 
# update_entity method usage example with argument unpacking

kwargs: UpdateEntityRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
    "entityId": ...,
}

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

update_pricing_plan#

Update the pricing plan.

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

# update_pricing_plan method definition

def update_pricing_plan(
    self,
    *,
    pricingMode: PricingModeType,  # (1)
    bundleNames: Sequence[str] = ...,
) -> UpdatePricingPlanResponseTypeDef:  # (2)
    ...
  1. See PricingModeType
  2. See UpdatePricingPlanResponseTypeDef 
# update_pricing_plan method usage example with argument unpacking

kwargs: UpdatePricingPlanRequestRequestTypeDef = {  # (1)
    "pricingMode": ...,
}

parent.update_pricing_plan(**kwargs)
  1. See UpdatePricingPlanRequestRequestTypeDef

update_scene#

Updates a scene.

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

# update_scene method definition

def update_scene(
    self,
    *,
    workspaceId: str,
    sceneId: str,
    contentLocation: str = ...,
    description: str = ...,
    capabilities: Sequence[str] = ...,
    sceneMetadata: Mapping[str, str] = ...,
) -> UpdateSceneResponseTypeDef:  # (1)
    ...
  1. See UpdateSceneResponseTypeDef 
# update_scene method usage example with argument unpacking

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

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

# update_workspace method definition

def update_workspace(
    self,
    *,
    workspaceId: str,
    description: str = ...,
    role: str = ...,
    s3Location: str = ...,
) -> UpdateWorkspaceResponseTypeDef:  # (1)
    ...
  1. See UpdateWorkspaceResponseTypeDef 
# update_workspace method usage example with argument unpacking

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

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