Skip to content

Type definitions#

Index > IoTTwinMaker > Type definitions

Auto-generated documentation for IoTTwinMaker type annotations stubs module mypy-boto3-iottwinmaker.

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

EntityPropertyReferenceUnionTypeDef#

# EntityPropertyReferenceUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import EntityPropertyReferenceUnionTypeDef


def get_value() -> EntityPropertyReferenceUnionTypeDef:
    return ...


# EntityPropertyReferenceUnionTypeDef definition

EntityPropertyReferenceUnionTypeDef = Union[
    EntityPropertyReferenceTypeDef,  # (1)
    EntityPropertyReferenceOutputTypeDef,  # (2)
]
  1. See EntityPropertyReferenceTypeDef
  2. See EntityPropertyReferenceOutputTypeDef

DataValueUnionTypeDef#

# DataValueUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import DataValueUnionTypeDef


def get_value() -> DataValueUnionTypeDef:
    return ...


# DataValueUnionTypeDef definition

DataValueUnionTypeDef = Union[
    DataValueTypeDef,  # (1)
    DataValueOutputTypeDef,  # (2)
]
  1. See DataValueTypeDef
  2. See DataValueOutputTypeDef

IotSiteWiseSourceConfigurationUnionTypeDef#

# IotSiteWiseSourceConfigurationUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import IotSiteWiseSourceConfigurationUnionTypeDef


def get_value() -> IotSiteWiseSourceConfigurationUnionTypeDef:
    return ...


# IotSiteWiseSourceConfigurationUnionTypeDef definition

IotSiteWiseSourceConfigurationUnionTypeDef = Union[
    IotSiteWiseSourceConfigurationTypeDef,  # (1)
    IotSiteWiseSourceConfigurationOutputTypeDef,  # (2)
]
  1. See IotSiteWiseSourceConfigurationTypeDef
  2. See IotSiteWiseSourceConfigurationOutputTypeDef

IotTwinMakerSourceConfigurationUnionTypeDef#

# IotTwinMakerSourceConfigurationUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import IotTwinMakerSourceConfigurationUnionTypeDef


def get_value() -> IotTwinMakerSourceConfigurationUnionTypeDef:
    return ...


# IotTwinMakerSourceConfigurationUnionTypeDef definition

IotTwinMakerSourceConfigurationUnionTypeDef = Union[
    IotTwinMakerSourceConfigurationTypeDef,  # (1)
    IotTwinMakerSourceConfigurationOutputTypeDef,  # (2)
]
  1. See IotTwinMakerSourceConfigurationTypeDef
  2. See IotTwinMakerSourceConfigurationOutputTypeDef

DataTypeUnionTypeDef#

# DataTypeUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import DataTypeUnionTypeDef


def get_value() -> DataTypeUnionTypeDef:
    return ...


# DataTypeUnionTypeDef definition

DataTypeUnionTypeDef = Union[
    DataTypeTypeDef,  # (1)
    DataTypeOutputTypeDef,  # (2)
]
  1. See DataTypeTypeDef
  2. See DataTypeOutputTypeDef

PropertyValueUnionTypeDef#

# PropertyValueUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueUnionTypeDef


def get_value() -> PropertyValueUnionTypeDef:
    return ...


# PropertyValueUnionTypeDef definition

PropertyValueUnionTypeDef = Union[
    PropertyValueTypeDef,  # (1)
    PropertyValueOutputTypeDef,  # (2)
]
  1. See PropertyValueTypeDef
  2. See PropertyValueOutputTypeDef

SourceConfigurationUnionTypeDef#

# SourceConfigurationUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import SourceConfigurationUnionTypeDef


def get_value() -> SourceConfigurationUnionTypeDef:
    return ...


# SourceConfigurationUnionTypeDef definition

SourceConfigurationUnionTypeDef = Union[
    SourceConfigurationTypeDef,  # (1)
    SourceConfigurationOutputTypeDef,  # (2)
]
  1. See SourceConfigurationTypeDef
  2. See SourceConfigurationOutputTypeDef

PropertyValueEntryUnionTypeDef#

# PropertyValueEntryUnionTypeDef Union usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueEntryUnionTypeDef


def get_value() -> PropertyValueEntryUnionTypeDef:
    return ...


# PropertyValueEntryUnionTypeDef definition

PropertyValueEntryUnionTypeDef = Union[
    PropertyValueEntryTypeDef,  # (1)
    PropertyValueEntryOutputTypeDef,  # (2)
]
  1. See PropertyValueEntryTypeDef
  2. See PropertyValueEntryOutputTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BundleInformationTypeDef#

# BundleInformationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import BundleInformationTypeDef


def get_value() -> BundleInformationTypeDef:
    return {
        "bundleNames": ...,
    }


# BundleInformationTypeDef definition

class BundleInformationTypeDef(TypedDict):
    bundleNames: List[str],
    pricingTier: NotRequired[PricingTierType],  # (1)
  1. See PricingTierType

CancelMetadataTransferJobRequestTypeDef#

# CancelMetadataTransferJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CancelMetadataTransferJobRequestTypeDef


def get_value() -> CancelMetadataTransferJobRequestTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# CancelMetadataTransferJobRequestTypeDef definition

class CancelMetadataTransferJobRequestTypeDef(TypedDict):
    metadataTransferJobId: str,

MetadataTransferJobProgressTypeDef#

# MetadataTransferJobProgressTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import MetadataTransferJobProgressTypeDef


def get_value() -> MetadataTransferJobProgressTypeDef:
    return {
        "totalCount": ...,
    }


# MetadataTransferJobProgressTypeDef definition

class MetadataTransferJobProgressTypeDef(TypedDict):
    totalCount: NotRequired[int],
    succeededCount: NotRequired[int],
    skippedCount: NotRequired[int],
    failedCount: NotRequired[int],

ColumnDescriptionTypeDef#

# ColumnDescriptionTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ColumnDescriptionTypeDef


def get_value() -> ColumnDescriptionTypeDef:
    return {
        "name": ...,
    }


# ColumnDescriptionTypeDef definition

class ColumnDescriptionTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[ColumnTypeType],  # (1)
  1. See ColumnTypeType

ComponentPropertyGroupRequestTypeDef#

# ComponentPropertyGroupRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentPropertyGroupRequestTypeDef


def get_value() -> ComponentPropertyGroupRequestTypeDef:
    return {
        "groupType": ...,
    }


# ComponentPropertyGroupRequestTypeDef definition

class ComponentPropertyGroupRequestTypeDef(TypedDict):
    groupType: NotRequired[GroupTypeType],  # (1)
    propertyNames: NotRequired[Sequence[str]],
    updateType: NotRequired[PropertyGroupUpdateTypeType],  # (2)
  1. See GroupTypeType
  2. See PropertyGroupUpdateTypeType

ComponentPropertyGroupResponseTypeDef#

# ComponentPropertyGroupResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentPropertyGroupResponseTypeDef


def get_value() -> ComponentPropertyGroupResponseTypeDef:
    return {
        "groupType": ...,
    }


# ComponentPropertyGroupResponseTypeDef definition

class ComponentPropertyGroupResponseTypeDef(TypedDict):
    groupType: GroupTypeType,  # (1)
    propertyNames: List[str],
    isInherited: bool,
  1. See GroupTypeType

CompositeComponentTypeRequestTypeDef#

# CompositeComponentTypeRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CompositeComponentTypeRequestTypeDef


def get_value() -> CompositeComponentTypeRequestTypeDef:
    return {
        "componentTypeId": ...,
    }


# CompositeComponentTypeRequestTypeDef definition

class CompositeComponentTypeRequestTypeDef(TypedDict):
    componentTypeId: NotRequired[str],

CompositeComponentTypeResponseTypeDef#

# CompositeComponentTypeResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CompositeComponentTypeResponseTypeDef


def get_value() -> CompositeComponentTypeResponseTypeDef:
    return {
        "componentTypeId": ...,
    }


# CompositeComponentTypeResponseTypeDef definition

class CompositeComponentTypeResponseTypeDef(TypedDict):
    componentTypeId: NotRequired[str],
    isInherited: NotRequired[bool],

PropertyGroupRequestTypeDef#

# PropertyGroupRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyGroupRequestTypeDef


def get_value() -> PropertyGroupRequestTypeDef:
    return {
        "groupType": ...,
    }


# PropertyGroupRequestTypeDef definition

class PropertyGroupRequestTypeDef(TypedDict):
    groupType: NotRequired[GroupTypeType],  # (1)
    propertyNames: NotRequired[Sequence[str]],
  1. See GroupTypeType

CreateSceneRequestTypeDef#

# CreateSceneRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateSceneRequestTypeDef


def get_value() -> CreateSceneRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# CreateSceneRequestTypeDef definition

class CreateSceneRequestTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,
    contentLocation: str,
    description: NotRequired[str],
    capabilities: NotRequired[Sequence[str]],
    tags: NotRequired[Mapping[str, str]],
    sceneMetadata: NotRequired[Mapping[str, str]],

CreateSyncJobRequestTypeDef#

# CreateSyncJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateSyncJobRequestTypeDef


def get_value() -> CreateSyncJobRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# CreateSyncJobRequestTypeDef definition

class CreateSyncJobRequestTypeDef(TypedDict):
    workspaceId: str,
    syncSource: str,
    syncRole: str,
    tags: NotRequired[Mapping[str, str]],

CreateWorkspaceRequestTypeDef#

# CreateWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateWorkspaceRequestTypeDef


def get_value() -> CreateWorkspaceRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# CreateWorkspaceRequestTypeDef definition

class CreateWorkspaceRequestTypeDef(TypedDict):
    workspaceId: str,
    description: NotRequired[str],
    s3Location: NotRequired[str],
    role: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

LambdaFunctionTypeDef#

# LambdaFunctionTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import LambdaFunctionTypeDef


def get_value() -> LambdaFunctionTypeDef:
    return {
        "arn": ...,
    }


# LambdaFunctionTypeDef definition

class LambdaFunctionTypeDef(TypedDict):
    arn: str,

RelationshipTypeDef#

# RelationshipTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import RelationshipTypeDef


def get_value() -> RelationshipTypeDef:
    return {
        "targetComponentTypeId": ...,
    }


# RelationshipTypeDef definition

class RelationshipTypeDef(TypedDict):
    targetComponentTypeId: NotRequired[str],
    relationshipType: NotRequired[str],

RelationshipValueTypeDef#

# RelationshipValueTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import RelationshipValueTypeDef


def get_value() -> RelationshipValueTypeDef:
    return {
        "targetEntityId": ...,
    }


# RelationshipValueTypeDef definition

class RelationshipValueTypeDef(TypedDict):
    targetEntityId: NotRequired[str],
    targetComponentName: NotRequired[str],

DeleteComponentTypeRequestTypeDef#

# DeleteComponentTypeRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteComponentTypeRequestTypeDef


def get_value() -> DeleteComponentTypeRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# DeleteComponentTypeRequestTypeDef definition

class DeleteComponentTypeRequestTypeDef(TypedDict):
    workspaceId: str,
    componentTypeId: str,

DeleteEntityRequestTypeDef#

# DeleteEntityRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteEntityRequestTypeDef


def get_value() -> DeleteEntityRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# DeleteEntityRequestTypeDef definition

class DeleteEntityRequestTypeDef(TypedDict):
    workspaceId: str,
    entityId: str,
    isRecursive: NotRequired[bool],

DeleteSceneRequestTypeDef#

# DeleteSceneRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteSceneRequestTypeDef


def get_value() -> DeleteSceneRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# DeleteSceneRequestTypeDef definition

class DeleteSceneRequestTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,

DeleteSyncJobRequestTypeDef#

# DeleteSyncJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteSyncJobRequestTypeDef


def get_value() -> DeleteSyncJobRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# DeleteSyncJobRequestTypeDef definition

class DeleteSyncJobRequestTypeDef(TypedDict):
    workspaceId: str,
    syncSource: str,

DeleteWorkspaceRequestTypeDef#

# DeleteWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteWorkspaceRequestTypeDef


def get_value() -> DeleteWorkspaceRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# DeleteWorkspaceRequestTypeDef definition

class DeleteWorkspaceRequestTypeDef(TypedDict):
    workspaceId: str,

IotTwinMakerDestinationConfigurationTypeDef#

# IotTwinMakerDestinationConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotTwinMakerDestinationConfigurationTypeDef


def get_value() -> IotTwinMakerDestinationConfigurationTypeDef:
    return {
        "workspace": ...,
    }


# IotTwinMakerDestinationConfigurationTypeDef definition

class IotTwinMakerDestinationConfigurationTypeDef(TypedDict):
    workspace: str,

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import S3DestinationConfigurationTypeDef


def get_value() -> S3DestinationConfigurationTypeDef:
    return {
        "location": ...,
    }


# S3DestinationConfigurationTypeDef definition

class S3DestinationConfigurationTypeDef(TypedDict):
    location: str,

EntityPropertyReferenceOutputTypeDef#

# EntityPropertyReferenceOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import EntityPropertyReferenceOutputTypeDef


def get_value() -> EntityPropertyReferenceOutputTypeDef:
    return {
        "componentName": ...,
    }


# EntityPropertyReferenceOutputTypeDef definition

class EntityPropertyReferenceOutputTypeDef(TypedDict):
    propertyName: str,
    componentName: NotRequired[str],
    componentPath: NotRequired[str],
    externalIdProperty: NotRequired[Dict[str, str]],
    entityId: NotRequired[str],

EntityPropertyReferenceTypeDef#

# EntityPropertyReferenceTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import EntityPropertyReferenceTypeDef


def get_value() -> EntityPropertyReferenceTypeDef:
    return {
        "componentName": ...,
    }


# EntityPropertyReferenceTypeDef definition

class EntityPropertyReferenceTypeDef(TypedDict):
    propertyName: str,
    componentName: NotRequired[str],
    componentPath: NotRequired[str],
    externalIdProperty: NotRequired[Mapping[str, str]],
    entityId: NotRequired[str],

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ErrorDetailsTypeDef


def get_value() -> ErrorDetailsTypeDef:
    return {
        "code": ...,
    }


# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    code: NotRequired[ErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See ErrorCodeType

ExecuteQueryRequestTypeDef#

# ExecuteQueryRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ExecuteQueryRequestTypeDef


def get_value() -> ExecuteQueryRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ExecuteQueryRequestTypeDef definition

class ExecuteQueryRequestTypeDef(TypedDict):
    workspaceId: str,
    queryStatement: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

RowTypeDef#

# RowTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import RowTypeDef


def get_value() -> RowTypeDef:
    return {
        "rowData": ...,
    }


# RowTypeDef definition

class RowTypeDef(TypedDict):
    rowData: NotRequired[List[Dict[str, Any]]],

FilterByAssetModelTypeDef#

# FilterByAssetModelTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FilterByAssetModelTypeDef


def get_value() -> FilterByAssetModelTypeDef:
    return {
        "assetModelId": ...,
    }


# FilterByAssetModelTypeDef definition

class FilterByAssetModelTypeDef(TypedDict):
    assetModelId: NotRequired[str],
    assetModelExternalId: NotRequired[str],
    includeOffspring: NotRequired[bool],
    includeAssets: NotRequired[bool],

FilterByAssetTypeDef#

# FilterByAssetTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FilterByAssetTypeDef


def get_value() -> FilterByAssetTypeDef:
    return {
        "assetId": ...,
    }


# FilterByAssetTypeDef definition

class FilterByAssetTypeDef(TypedDict):
    assetId: NotRequired[str],
    assetExternalId: NotRequired[str],
    includeOffspring: NotRequired[bool],
    includeAssetModel: NotRequired[bool],

FilterByComponentTypeTypeDef#

# FilterByComponentTypeTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FilterByComponentTypeTypeDef


def get_value() -> FilterByComponentTypeTypeDef:
    return {
        "componentTypeId": ...,
    }


# FilterByComponentTypeTypeDef definition

class FilterByComponentTypeTypeDef(TypedDict):
    componentTypeId: str,

FilterByEntityTypeDef#

# FilterByEntityTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FilterByEntityTypeDef


def get_value() -> FilterByEntityTypeDef:
    return {
        "entityId": ...,
    }


# FilterByEntityTypeDef definition

class FilterByEntityTypeDef(TypedDict):
    entityId: str,

GetComponentTypeRequestTypeDef#

# GetComponentTypeRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetComponentTypeRequestTypeDef


def get_value() -> GetComponentTypeRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# GetComponentTypeRequestTypeDef definition

class GetComponentTypeRequestTypeDef(TypedDict):
    workspaceId: str,
    componentTypeId: str,

PropertyGroupResponseTypeDef#

# PropertyGroupResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyGroupResponseTypeDef


def get_value() -> PropertyGroupResponseTypeDef:
    return {
        "groupType": ...,
    }


# PropertyGroupResponseTypeDef definition

class PropertyGroupResponseTypeDef(TypedDict):
    groupType: GroupTypeType,  # (1)
    propertyNames: List[str],
    isInherited: bool,
  1. See GroupTypeType

GetEntityRequestTypeDef#

# GetEntityRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetEntityRequestTypeDef


def get_value() -> GetEntityRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# GetEntityRequestTypeDef definition

class GetEntityRequestTypeDef(TypedDict):
    workspaceId: str,
    entityId: str,

GetMetadataTransferJobRequestTypeDef#

# GetMetadataTransferJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetMetadataTransferJobRequestTypeDef


def get_value() -> GetMetadataTransferJobRequestTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# GetMetadataTransferJobRequestTypeDef definition

class GetMetadataTransferJobRequestTypeDef(TypedDict):
    metadataTransferJobId: str,

InterpolationParametersTypeDef#

# InterpolationParametersTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import InterpolationParametersTypeDef


def get_value() -> InterpolationParametersTypeDef:
    return {
        "interpolationType": ...,
    }


# InterpolationParametersTypeDef definition

class InterpolationParametersTypeDef(TypedDict):
    interpolationType: NotRequired[InterpolationTypeType],  # (1)
    intervalInSeconds: NotRequired[int],
  1. See InterpolationTypeType

GetSceneRequestTypeDef#

# GetSceneRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetSceneRequestTypeDef


def get_value() -> GetSceneRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# GetSceneRequestTypeDef definition

class GetSceneRequestTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,

SceneErrorTypeDef#

# SceneErrorTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SceneErrorTypeDef


def get_value() -> SceneErrorTypeDef:
    return {
        "code": ...,
    }


# SceneErrorTypeDef definition

class SceneErrorTypeDef(TypedDict):
    code: NotRequired[SceneErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See SceneErrorCodeType

GetSyncJobRequestTypeDef#

# GetSyncJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetSyncJobRequestTypeDef


def get_value() -> GetSyncJobRequestTypeDef:
    return {
        "syncSource": ...,
    }


# GetSyncJobRequestTypeDef definition

class GetSyncJobRequestTypeDef(TypedDict):
    syncSource: str,
    workspaceId: NotRequired[str],

GetWorkspaceRequestTypeDef#

# GetWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetWorkspaceRequestTypeDef


def get_value() -> GetWorkspaceRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# GetWorkspaceRequestTypeDef definition

class GetWorkspaceRequestTypeDef(TypedDict):
    workspaceId: str,

ListComponentTypesFilterTypeDef#

# ListComponentTypesFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListComponentTypesFilterTypeDef


def get_value() -> ListComponentTypesFilterTypeDef:
    return {
        "extendsFrom": ...,
    }


# ListComponentTypesFilterTypeDef definition

class ListComponentTypesFilterTypeDef(TypedDict):
    extendsFrom: NotRequired[str],
    namespace: NotRequired[str],
    isAbstract: NotRequired[bool],

ListComponentsRequestTypeDef#

# ListComponentsRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListComponentsRequestTypeDef


def get_value() -> ListComponentsRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListComponentsRequestTypeDef definition

class ListComponentsRequestTypeDef(TypedDict):
    workspaceId: str,
    entityId: str,
    componentPath: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListEntitiesFilterTypeDef#

# ListEntitiesFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListEntitiesFilterTypeDef


def get_value() -> ListEntitiesFilterTypeDef:
    return {
        "parentEntityId": ...,
    }


# ListEntitiesFilterTypeDef definition

class ListEntitiesFilterTypeDef(TypedDict):
    parentEntityId: NotRequired[str],
    componentTypeId: NotRequired[str],
    externalId: NotRequired[str],

ListMetadataTransferJobsFilterTypeDef#

# ListMetadataTransferJobsFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListMetadataTransferJobsFilterTypeDef


def get_value() -> ListMetadataTransferJobsFilterTypeDef:
    return {
        "workspaceId": ...,
    }


# ListMetadataTransferJobsFilterTypeDef definition

class ListMetadataTransferJobsFilterTypeDef(TypedDict):
    workspaceId: NotRequired[str],
    state: NotRequired[MetadataTransferJobStateType],  # (1)
  1. See MetadataTransferJobStateType

ListPropertiesRequestTypeDef#

# ListPropertiesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListPropertiesRequestTypeDef


def get_value() -> ListPropertiesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListPropertiesRequestTypeDef definition

class ListPropertiesRequestTypeDef(TypedDict):
    workspaceId: str,
    entityId: str,
    componentName: NotRequired[str],
    componentPath: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListScenesRequestTypeDef#

# ListScenesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListScenesRequestTypeDef


def get_value() -> ListScenesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListScenesRequestTypeDef definition

class ListScenesRequestTypeDef(TypedDict):
    workspaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SceneSummaryTypeDef#

# SceneSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SceneSummaryTypeDef


def get_value() -> SceneSummaryTypeDef:
    return {
        "sceneId": ...,
    }


# SceneSummaryTypeDef definition

class SceneSummaryTypeDef(TypedDict):
    sceneId: str,
    contentLocation: str,
    arn: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    description: NotRequired[str],

ListSyncJobsRequestTypeDef#

# ListSyncJobsRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListSyncJobsRequestTypeDef


def get_value() -> ListSyncJobsRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListSyncJobsRequestTypeDef definition

class ListSyncJobsRequestTypeDef(TypedDict):
    workspaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SyncResourceFilterTypeDef#

# SyncResourceFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SyncResourceFilterTypeDef


def get_value() -> SyncResourceFilterTypeDef:
    return {
        "state": ...,
    }


# SyncResourceFilterTypeDef definition

class SyncResourceFilterTypeDef(TypedDict):
    state: NotRequired[SyncResourceStateType],  # (1)
    resourceType: NotRequired[SyncResourceTypeType],  # (2)
    resourceId: NotRequired[str],
    externalId: NotRequired[str],
  1. See SyncResourceStateType
  2. See SyncResourceTypeType

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListWorkspacesRequestTypeDef#

# ListWorkspacesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListWorkspacesRequestTypeDef


def get_value() -> ListWorkspacesRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListWorkspacesRequestTypeDef definition

class ListWorkspacesRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

WorkspaceSummaryTypeDef#

# WorkspaceSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import WorkspaceSummaryTypeDef


def get_value() -> WorkspaceSummaryTypeDef:
    return {
        "workspaceId": ...,
    }


# WorkspaceSummaryTypeDef definition

class WorkspaceSummaryTypeDef(TypedDict):
    workspaceId: str,
    arn: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    description: NotRequired[str],
    linkedServices: NotRequired[List[str]],

OrderByTypeDef#

# OrderByTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import OrderByTypeDef


def get_value() -> OrderByTypeDef:
    return {
        "order": ...,
    }


# OrderByTypeDef definition

class OrderByTypeDef(TypedDict):
    propertyName: str,
    order: NotRequired[OrderType],  # (1)
  1. See OrderType

ParentEntityUpdateRequestTypeDef#

# ParentEntityUpdateRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ParentEntityUpdateRequestTypeDef


def get_value() -> ParentEntityUpdateRequestTypeDef:
    return {
        "updateType": ...,
    }


# ParentEntityUpdateRequestTypeDef definition

class ParentEntityUpdateRequestTypeDef(TypedDict):
    updateType: ParentEntityUpdateTypeType,  # (1)
    parentEntityId: NotRequired[str],
  1. See ParentEntityUpdateTypeType

S3SourceConfigurationTypeDef#

# S3SourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import S3SourceConfigurationTypeDef


def get_value() -> S3SourceConfigurationTypeDef:
    return {
        "location": ...,
    }


# S3SourceConfigurationTypeDef definition

class S3SourceConfigurationTypeDef(TypedDict):
    location: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    tags: Mapping[str, str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    tagKeys: Sequence[str],

UpdatePricingPlanRequestTypeDef#

# UpdatePricingPlanRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdatePricingPlanRequestTypeDef


def get_value() -> UpdatePricingPlanRequestTypeDef:
    return {
        "pricingMode": ...,
    }


# UpdatePricingPlanRequestTypeDef definition

class UpdatePricingPlanRequestTypeDef(TypedDict):
    pricingMode: PricingModeType,  # (1)
    bundleNames: NotRequired[Sequence[str]],
  1. See PricingModeType

UpdateSceneRequestTypeDef#

# UpdateSceneRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateSceneRequestTypeDef


def get_value() -> UpdateSceneRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# UpdateSceneRequestTypeDef definition

class UpdateSceneRequestTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,
    contentLocation: NotRequired[str],
    description: NotRequired[str],
    capabilities: NotRequired[Sequence[str]],
    sceneMetadata: NotRequired[Mapping[str, str]],

UpdateWorkspaceRequestTypeDef#

# UpdateWorkspaceRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateWorkspaceRequestTypeDef


def get_value() -> UpdateWorkspaceRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# UpdateWorkspaceRequestTypeDef definition

class UpdateWorkspaceRequestTypeDef(TypedDict):
    workspaceId: str,
    description: NotRequired[str],
    role: NotRequired[str],
    s3Location: NotRequired[str],

CreateComponentTypeResponseTypeDef#

# CreateComponentTypeResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateComponentTypeResponseTypeDef


def get_value() -> CreateComponentTypeResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateComponentTypeResponseTypeDef definition

class CreateComponentTypeResponseTypeDef(TypedDict):
    arn: str,
    creationDateTime: datetime.datetime,
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

CreateEntityResponseTypeDef#

# CreateEntityResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateEntityResponseTypeDef


def get_value() -> CreateEntityResponseTypeDef:
    return {
        "entityId": ...,
    }


# CreateEntityResponseTypeDef definition

class CreateEntityResponseTypeDef(TypedDict):
    entityId: str,
    arn: str,
    creationDateTime: datetime.datetime,
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

CreateSceneResponseTypeDef#

# CreateSceneResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateSceneResponseTypeDef


def get_value() -> CreateSceneResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateSceneResponseTypeDef definition

class CreateSceneResponseTypeDef(TypedDict):
    arn: str,
    creationDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSyncJobResponseTypeDef#

# CreateSyncJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateSyncJobResponseTypeDef


def get_value() -> CreateSyncJobResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateSyncJobResponseTypeDef definition

class CreateSyncJobResponseTypeDef(TypedDict):
    arn: str,
    creationDateTime: datetime.datetime,
    state: SyncJobStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SyncJobStateType
  2. See ResponseMetadataTypeDef

CreateWorkspaceResponseTypeDef#

# CreateWorkspaceResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateWorkspaceResponseTypeDef


def get_value() -> CreateWorkspaceResponseTypeDef:
    return {
        "arn": ...,
    }


# CreateWorkspaceResponseTypeDef definition

class CreateWorkspaceResponseTypeDef(TypedDict):
    arn: str,
    creationDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteComponentTypeResponseTypeDef#

# DeleteComponentTypeResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteComponentTypeResponseTypeDef


def get_value() -> DeleteComponentTypeResponseTypeDef:
    return {
        "state": ...,
    }


# DeleteComponentTypeResponseTypeDef definition

class DeleteComponentTypeResponseTypeDef(TypedDict):
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

DeleteEntityResponseTypeDef#

# DeleteEntityResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteEntityResponseTypeDef


def get_value() -> DeleteEntityResponseTypeDef:
    return {
        "state": ...,
    }


# DeleteEntityResponseTypeDef definition

class DeleteEntityResponseTypeDef(TypedDict):
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

DeleteSyncJobResponseTypeDef#

# DeleteSyncJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteSyncJobResponseTypeDef


def get_value() -> DeleteSyncJobResponseTypeDef:
    return {
        "state": ...,
    }


# DeleteSyncJobResponseTypeDef definition

class DeleteSyncJobResponseTypeDef(TypedDict):
    state: SyncJobStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SyncJobStateType
  2. See ResponseMetadataTypeDef

DeleteWorkspaceResponseTypeDef#

# DeleteWorkspaceResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DeleteWorkspaceResponseTypeDef


def get_value() -> DeleteWorkspaceResponseTypeDef:
    return {
        "message": ...,
    }


# DeleteWorkspaceResponseTypeDef definition

class DeleteWorkspaceResponseTypeDef(TypedDict):
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetWorkspaceResponseTypeDef#

# GetWorkspaceResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetWorkspaceResponseTypeDef


def get_value() -> GetWorkspaceResponseTypeDef:
    return {
        "workspaceId": ...,
    }


# GetWorkspaceResponseTypeDef definition

class GetWorkspaceResponseTypeDef(TypedDict):
    workspaceId: str,
    arn: str,
    description: str,
    linkedServices: List[str],
    s3Location: str,
    role: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

UpdateComponentTypeResponseTypeDef#

# UpdateComponentTypeResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateComponentTypeResponseTypeDef


def get_value() -> UpdateComponentTypeResponseTypeDef:
    return {
        "workspaceId": ...,
    }


# UpdateComponentTypeResponseTypeDef definition

class UpdateComponentTypeResponseTypeDef(TypedDict):
    workspaceId: str,
    arn: str,
    componentTypeId: str,
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

UpdateEntityResponseTypeDef#

# UpdateEntityResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateEntityResponseTypeDef


def get_value() -> UpdateEntityResponseTypeDef:
    return {
        "updateDateTime": ...,
    }


# UpdateEntityResponseTypeDef definition

class UpdateEntityResponseTypeDef(TypedDict):
    updateDateTime: datetime.datetime,
    state: StateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateType
  2. See ResponseMetadataTypeDef

UpdateSceneResponseTypeDef#

# UpdateSceneResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateSceneResponseTypeDef


def get_value() -> UpdateSceneResponseTypeDef:
    return {
        "updateDateTime": ...,
    }


# UpdateSceneResponseTypeDef definition

class UpdateSceneResponseTypeDef(TypedDict):
    updateDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWorkspaceResponseTypeDef#

# UpdateWorkspaceResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateWorkspaceResponseTypeDef


def get_value() -> UpdateWorkspaceResponseTypeDef:
    return {
        "updateDateTime": ...,
    }


# UpdateWorkspaceResponseTypeDef definition

class UpdateWorkspaceResponseTypeDef(TypedDict):
    updateDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PricingPlanTypeDef#

# PricingPlanTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PricingPlanTypeDef


def get_value() -> PricingPlanTypeDef:
    return {
        "billableEntityCount": ...,
    }


# PricingPlanTypeDef definition

class PricingPlanTypeDef(TypedDict):
    effectiveDateTime: datetime.datetime,
    pricingMode: PricingModeType,  # (2)
    updateDateTime: datetime.datetime,
    updateReason: UpdateReasonType,  # (3)
    billableEntityCount: NotRequired[int],
    bundleInformation: NotRequired[BundleInformationTypeDef],  # (1)
  1. See BundleInformationTypeDef
  2. See PricingModeType
  3. See UpdateReasonType

DataConnectorTypeDef#

# DataConnectorTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DataConnectorTypeDef


def get_value() -> DataConnectorTypeDef:
    return {
        "lambda": ...,
    }


# DataConnectorTypeDef definition

class DataConnectorTypeDef(TypedDict):
    lambda: NotRequired[LambdaFunctionTypeDef],  # (1)
    isNative: NotRequired[bool],
  1. See LambdaFunctionTypeDef

DataValueOutputTypeDef#

# DataValueOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DataValueOutputTypeDef


def get_value() -> DataValueOutputTypeDef:
    return {
        "booleanValue": ...,
    }


# DataValueOutputTypeDef definition

class DataValueOutputTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    integerValue: NotRequired[int],
    longValue: NotRequired[int],
    stringValue: NotRequired[str],
    listValue: NotRequired[List[Dict[str, Any]]],
    mapValue: NotRequired[Dict[str, Dict[str, Any]]],
    relationshipValue: NotRequired[RelationshipValueTypeDef],  # (1)
    expression: NotRequired[str],
  1. See RelationshipValueTypeDef

DataValueTypeDef#

# DataValueTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DataValueTypeDef


def get_value() -> DataValueTypeDef:
    return {
        "booleanValue": ...,
    }


# DataValueTypeDef definition

class DataValueTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    integerValue: NotRequired[int],
    longValue: NotRequired[int],
    stringValue: NotRequired[str],
    listValue: NotRequired[Sequence[Mapping[str, Any]]],
    mapValue: NotRequired[Mapping[str, Mapping[str, Any]]],
    relationshipValue: NotRequired[RelationshipValueTypeDef],  # (1)
    expression: NotRequired[str],
  1. See RelationshipValueTypeDef

DestinationConfigurationTypeDef#

# DestinationConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DestinationConfigurationTypeDef


def get_value() -> DestinationConfigurationTypeDef:
    return {
        "type": ...,
    }


# DestinationConfigurationTypeDef definition

class DestinationConfigurationTypeDef(TypedDict):
    type: DestinationTypeType,  # (1)
    s3Configuration: NotRequired[S3DestinationConfigurationTypeDef],  # (2)
    iotTwinMakerConfiguration: NotRequired[IotTwinMakerDestinationConfigurationTypeDef],  # (3)
  1. See DestinationTypeType
  2. See S3DestinationConfigurationTypeDef
  3. See IotTwinMakerDestinationConfigurationTypeDef

MetadataTransferJobStatusTypeDef#

# MetadataTransferJobStatusTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import MetadataTransferJobStatusTypeDef


def get_value() -> MetadataTransferJobStatusTypeDef:
    return {
        "state": ...,
    }


# MetadataTransferJobStatusTypeDef definition

class MetadataTransferJobStatusTypeDef(TypedDict):
    state: NotRequired[MetadataTransferJobStateType],  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
    queuedPosition: NotRequired[int],
  1. See MetadataTransferJobStateType
  2. See ErrorDetailsTypeDef

StatusTypeDef#

# StatusTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import StatusTypeDef


def get_value() -> StatusTypeDef:
    return {
        "state": ...,
    }


# StatusTypeDef definition

class StatusTypeDef(TypedDict):
    state: NotRequired[StateType],  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
  1. See StateType
  2. See ErrorDetailsTypeDef

SyncJobStatusTypeDef#

# SyncJobStatusTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SyncJobStatusTypeDef


def get_value() -> SyncJobStatusTypeDef:
    return {
        "state": ...,
    }


# SyncJobStatusTypeDef definition

class SyncJobStatusTypeDef(TypedDict):
    state: NotRequired[SyncJobStateType],  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
  1. See SyncJobStateType
  2. See ErrorDetailsTypeDef

SyncResourceStatusTypeDef#

# SyncResourceStatusTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SyncResourceStatusTypeDef


def get_value() -> SyncResourceStatusTypeDef:
    return {
        "state": ...,
    }


# SyncResourceStatusTypeDef definition

class SyncResourceStatusTypeDef(TypedDict):
    state: NotRequired[SyncResourceStateType],  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
  1. See SyncResourceStateType
  2. See ErrorDetailsTypeDef

ExecuteQueryResponseTypeDef#

# ExecuteQueryResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ExecuteQueryResponseTypeDef


def get_value() -> ExecuteQueryResponseTypeDef:
    return {
        "columnDescriptions": ...,
    }


# ExecuteQueryResponseTypeDef definition

class ExecuteQueryResponseTypeDef(TypedDict):
    columnDescriptions: List[ColumnDescriptionTypeDef],  # (1)
    rows: List[RowTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See List[ColumnDescriptionTypeDef]
  2. See List[RowTypeDef]
  3. See ResponseMetadataTypeDef

IotSiteWiseSourceConfigurationFilterTypeDef#

# IotSiteWiseSourceConfigurationFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotSiteWiseSourceConfigurationFilterTypeDef


def get_value() -> IotSiteWiseSourceConfigurationFilterTypeDef:
    return {
        "filterByAssetModel": ...,
    }


# IotSiteWiseSourceConfigurationFilterTypeDef definition

class IotSiteWiseSourceConfigurationFilterTypeDef(TypedDict):
    filterByAssetModel: NotRequired[FilterByAssetModelTypeDef],  # (1)
    filterByAsset: NotRequired[FilterByAssetTypeDef],  # (2)
  1. See FilterByAssetModelTypeDef
  2. See FilterByAssetTypeDef

IotTwinMakerSourceConfigurationFilterTypeDef#

# IotTwinMakerSourceConfigurationFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotTwinMakerSourceConfigurationFilterTypeDef


def get_value() -> IotTwinMakerSourceConfigurationFilterTypeDef:
    return {
        "filterByComponentType": ...,
    }


# IotTwinMakerSourceConfigurationFilterTypeDef definition

class IotTwinMakerSourceConfigurationFilterTypeDef(TypedDict):
    filterByComponentType: NotRequired[FilterByComponentTypeTypeDef],  # (1)
    filterByEntity: NotRequired[FilterByEntityTypeDef],  # (2)
  1. See FilterByComponentTypeTypeDef
  2. See FilterByEntityTypeDef

GetSceneResponseTypeDef#

# GetSceneResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetSceneResponseTypeDef


def get_value() -> GetSceneResponseTypeDef:
    return {
        "workspaceId": ...,
    }


# GetSceneResponseTypeDef definition

class GetSceneResponseTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,
    contentLocation: str,
    arn: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    description: str,
    capabilities: List[str],
    sceneMetadata: Dict[str, str],
    generatedSceneMetadata: Dict[str, str],
    error: SceneErrorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SceneErrorTypeDef
  2. See ResponseMetadataTypeDef

ListComponentTypesRequestTypeDef#

# ListComponentTypesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListComponentTypesRequestTypeDef


def get_value() -> ListComponentTypesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListComponentTypesRequestTypeDef definition

class ListComponentTypesRequestTypeDef(TypedDict):
    workspaceId: str,
    filters: NotRequired[Sequence[ListComponentTypesFilterTypeDef]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See Sequence[ListComponentTypesFilterTypeDef]

ListEntitiesRequestTypeDef#

# ListEntitiesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListEntitiesRequestTypeDef


def get_value() -> ListEntitiesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListEntitiesRequestTypeDef definition

class ListEntitiesRequestTypeDef(TypedDict):
    workspaceId: str,
    filters: NotRequired[Sequence[ListEntitiesFilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See Sequence[ListEntitiesFilterTypeDef]

ListMetadataTransferJobsRequestTypeDef#

# ListMetadataTransferJobsRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListMetadataTransferJobsRequestTypeDef


def get_value() -> ListMetadataTransferJobsRequestTypeDef:
    return {
        "sourceType": ...,
    }


# ListMetadataTransferJobsRequestTypeDef definition

class ListMetadataTransferJobsRequestTypeDef(TypedDict):
    sourceType: SourceTypeType,  # (1)
    destinationType: DestinationTypeType,  # (2)
    filters: NotRequired[Sequence[ListMetadataTransferJobsFilterTypeDef]],  # (3)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See SourceTypeType
  2. See DestinationTypeType
  3. See Sequence[ListMetadataTransferJobsFilterTypeDef]

ListScenesResponseTypeDef#

# ListScenesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListScenesResponseTypeDef


def get_value() -> ListScenesResponseTypeDef:
    return {
        "sceneSummaries": ...,
    }


# ListScenesResponseTypeDef definition

class ListScenesResponseTypeDef(TypedDict):
    sceneSummaries: List[SceneSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SceneSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListSyncResourcesRequestTypeDef#

# ListSyncResourcesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListSyncResourcesRequestTypeDef


def get_value() -> ListSyncResourcesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# ListSyncResourcesRequestTypeDef definition

class ListSyncResourcesRequestTypeDef(TypedDict):
    workspaceId: str,
    syncSource: str,
    filters: NotRequired[Sequence[SyncResourceFilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See Sequence[SyncResourceFilterTypeDef]

ListWorkspacesResponseTypeDef#

# ListWorkspacesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListWorkspacesResponseTypeDef


def get_value() -> ListWorkspacesResponseTypeDef:
    return {
        "workspaceSummaries": ...,
    }


# ListWorkspacesResponseTypeDef definition

class ListWorkspacesResponseTypeDef(TypedDict):
    workspaceSummaries: List[WorkspaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[WorkspaceSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetPricingPlanResponseTypeDef#

# GetPricingPlanResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetPricingPlanResponseTypeDef


def get_value() -> GetPricingPlanResponseTypeDef:
    return {
        "currentPricingPlan": ...,
    }


# GetPricingPlanResponseTypeDef definition

class GetPricingPlanResponseTypeDef(TypedDict):
    currentPricingPlan: PricingPlanTypeDef,  # (1)
    pendingPricingPlan: PricingPlanTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PricingPlanTypeDef
  2. See PricingPlanTypeDef
  3. See ResponseMetadataTypeDef

UpdatePricingPlanResponseTypeDef#

# UpdatePricingPlanResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdatePricingPlanResponseTypeDef


def get_value() -> UpdatePricingPlanResponseTypeDef:
    return {
        "currentPricingPlan": ...,
    }


# UpdatePricingPlanResponseTypeDef definition

class UpdatePricingPlanResponseTypeDef(TypedDict):
    currentPricingPlan: PricingPlanTypeDef,  # (1)
    pendingPricingPlan: PricingPlanTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PricingPlanTypeDef
  2. See PricingPlanTypeDef
  3. See ResponseMetadataTypeDef

FunctionRequestTypeDef#

# FunctionRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FunctionRequestTypeDef


def get_value() -> FunctionRequestTypeDef:
    return {
        "requiredProperties": ...,
    }


# FunctionRequestTypeDef definition

class FunctionRequestTypeDef(TypedDict):
    requiredProperties: NotRequired[Sequence[str]],
    scope: NotRequired[ScopeType],  # (1)
    implementedBy: NotRequired[DataConnectorTypeDef],  # (2)
  1. See ScopeType
  2. See DataConnectorTypeDef

FunctionResponseTypeDef#

# FunctionResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import FunctionResponseTypeDef


def get_value() -> FunctionResponseTypeDef:
    return {
        "requiredProperties": ...,
    }


# FunctionResponseTypeDef definition

class FunctionResponseTypeDef(TypedDict):
    requiredProperties: NotRequired[List[str]],
    scope: NotRequired[ScopeType],  # (1)
    implementedBy: NotRequired[DataConnectorTypeDef],  # (2)
    isInherited: NotRequired[bool],
  1. See ScopeType
  2. See DataConnectorTypeDef

DataTypeOutputTypeDef#

# DataTypeOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DataTypeOutputTypeDef


def get_value() -> DataTypeOutputTypeDef:
    return {
        "type": ...,
    }


# DataTypeOutputTypeDef definition

class DataTypeOutputTypeDef(TypedDict):
    type: TypeType,  # (1)
    nestedType: NotRequired[Dict[str, Any]],
    allowedValues: NotRequired[List[DataValueOutputTypeDef]],  # (2)
    unitOfMeasure: NotRequired[str],
    relationship: NotRequired[RelationshipTypeDef],  # (3)
  1. See TypeType
  2. See List[DataValueOutputTypeDef]
  3. See RelationshipTypeDef

PropertyLatestValueTypeDef#

# PropertyLatestValueTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyLatestValueTypeDef


def get_value() -> PropertyLatestValueTypeDef:
    return {
        "propertyReference": ...,
    }


# PropertyLatestValueTypeDef definition

class PropertyLatestValueTypeDef(TypedDict):
    propertyReference: EntityPropertyReferenceOutputTypeDef,  # (1)
    propertyValue: NotRequired[DataValueOutputTypeDef],  # (2)
  1. See EntityPropertyReferenceOutputTypeDef
  2. See DataValueOutputTypeDef

PropertyValueOutputTypeDef#

# PropertyValueOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueOutputTypeDef


def get_value() -> PropertyValueOutputTypeDef:
    return {
        "timestamp": ...,
    }


# PropertyValueOutputTypeDef definition

class PropertyValueOutputTypeDef(TypedDict):
    value: DataValueOutputTypeDef,  # (1)
    timestamp: NotRequired[datetime.datetime],
    time: NotRequired[str],
  1. See DataValueOutputTypeDef

CancelMetadataTransferJobResponseTypeDef#

# CancelMetadataTransferJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CancelMetadataTransferJobResponseTypeDef


def get_value() -> CancelMetadataTransferJobResponseTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# CancelMetadataTransferJobResponseTypeDef definition

class CancelMetadataTransferJobResponseTypeDef(TypedDict):
    metadataTransferJobId: str,
    arn: str,
    updateDateTime: datetime.datetime,
    status: MetadataTransferJobStatusTypeDef,  # (1)
    progress: MetadataTransferJobProgressTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MetadataTransferJobStatusTypeDef
  2. See MetadataTransferJobProgressTypeDef
  3. See ResponseMetadataTypeDef

CreateMetadataTransferJobResponseTypeDef#

# CreateMetadataTransferJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateMetadataTransferJobResponseTypeDef


def get_value() -> CreateMetadataTransferJobResponseTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# CreateMetadataTransferJobResponseTypeDef definition

class CreateMetadataTransferJobResponseTypeDef(TypedDict):
    metadataTransferJobId: str,
    arn: str,
    creationDateTime: datetime.datetime,
    status: MetadataTransferJobStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetadataTransferJobStatusTypeDef
  2. See ResponseMetadataTypeDef

MetadataTransferJobSummaryTypeDef#

# MetadataTransferJobSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import MetadataTransferJobSummaryTypeDef


def get_value() -> MetadataTransferJobSummaryTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# MetadataTransferJobSummaryTypeDef definition

class MetadataTransferJobSummaryTypeDef(TypedDict):
    metadataTransferJobId: str,
    arn: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    status: MetadataTransferJobStatusTypeDef,  # (1)
    progress: NotRequired[MetadataTransferJobProgressTypeDef],  # (2)
  1. See MetadataTransferJobStatusTypeDef
  2. See MetadataTransferJobProgressTypeDef

ComponentSummaryTypeDef#

# ComponentSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentSummaryTypeDef


def get_value() -> ComponentSummaryTypeDef:
    return {
        "componentName": ...,
    }


# ComponentSummaryTypeDef definition

class ComponentSummaryTypeDef(TypedDict):
    componentName: str,
    componentTypeId: str,
    status: StatusTypeDef,  # (2)
    definedIn: NotRequired[str],
    description: NotRequired[str],
    propertyGroups: NotRequired[Dict[str, ComponentPropertyGroupResponseTypeDef]],  # (1)
    syncSource: NotRequired[str],
    componentPath: NotRequired[str],
  1. See Dict[str, ComponentPropertyGroupResponseTypeDef]
  2. See StatusTypeDef

ComponentTypeSummaryTypeDef#

# ComponentTypeSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentTypeSummaryTypeDef


def get_value() -> ComponentTypeSummaryTypeDef:
    return {
        "arn": ...,
    }


# ComponentTypeSummaryTypeDef definition

class ComponentTypeSummaryTypeDef(TypedDict):
    arn: str,
    componentTypeId: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    description: NotRequired[str],
    status: NotRequired[StatusTypeDef],  # (1)
    componentTypeName: NotRequired[str],
  1. See StatusTypeDef

EntitySummaryTypeDef#

# EntitySummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import EntitySummaryTypeDef


def get_value() -> EntitySummaryTypeDef:
    return {
        "entityId": ...,
    }


# EntitySummaryTypeDef definition

class EntitySummaryTypeDef(TypedDict):
    entityId: str,
    entityName: str,
    arn: str,
    status: StatusTypeDef,  # (1)
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    parentEntityId: NotRequired[str],
    description: NotRequired[str],
    hasChildEntities: NotRequired[bool],
  1. See StatusTypeDef

GetSyncJobResponseTypeDef#

# GetSyncJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetSyncJobResponseTypeDef


def get_value() -> GetSyncJobResponseTypeDef:
    return {
        "arn": ...,
    }


# GetSyncJobResponseTypeDef definition

class GetSyncJobResponseTypeDef(TypedDict):
    arn: str,
    workspaceId: str,
    syncSource: str,
    syncRole: str,
    status: SyncJobStatusTypeDef,  # (1)
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SyncJobStatusTypeDef
  2. See ResponseMetadataTypeDef

SyncJobSummaryTypeDef#

# SyncJobSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SyncJobSummaryTypeDef


def get_value() -> SyncJobSummaryTypeDef:
    return {
        "arn": ...,
    }


# SyncJobSummaryTypeDef definition

class SyncJobSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    workspaceId: NotRequired[str],
    syncSource: NotRequired[str],
    status: NotRequired[SyncJobStatusTypeDef],  # (1)
    creationDateTime: NotRequired[datetime.datetime],
    updateDateTime: NotRequired[datetime.datetime],
  1. See SyncJobStatusTypeDef

SyncResourceSummaryTypeDef#

# SyncResourceSummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SyncResourceSummaryTypeDef


def get_value() -> SyncResourceSummaryTypeDef:
    return {
        "resourceType": ...,
    }


# SyncResourceSummaryTypeDef definition

class SyncResourceSummaryTypeDef(TypedDict):
    resourceType: NotRequired[SyncResourceTypeType],  # (1)
    externalId: NotRequired[str],
    resourceId: NotRequired[str],
    status: NotRequired[SyncResourceStatusTypeDef],  # (2)
    updateDateTime: NotRequired[datetime.datetime],
  1. See SyncResourceTypeType
  2. See SyncResourceStatusTypeDef

IotSiteWiseSourceConfigurationOutputTypeDef#

# IotSiteWiseSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotSiteWiseSourceConfigurationOutputTypeDef


def get_value() -> IotSiteWiseSourceConfigurationOutputTypeDef:
    return {
        "filters": ...,
    }


# IotSiteWiseSourceConfigurationOutputTypeDef definition

class IotSiteWiseSourceConfigurationOutputTypeDef(TypedDict):
    filters: NotRequired[List[IotSiteWiseSourceConfigurationFilterTypeDef]],  # (1)
  1. See List[IotSiteWiseSourceConfigurationFilterTypeDef]

IotSiteWiseSourceConfigurationTypeDef#

# IotSiteWiseSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotSiteWiseSourceConfigurationTypeDef


def get_value() -> IotSiteWiseSourceConfigurationTypeDef:
    return {
        "filters": ...,
    }


# IotSiteWiseSourceConfigurationTypeDef definition

class IotSiteWiseSourceConfigurationTypeDef(TypedDict):
    filters: NotRequired[Sequence[IotSiteWiseSourceConfigurationFilterTypeDef]],  # (1)
  1. See Sequence[IotSiteWiseSourceConfigurationFilterTypeDef]

IotTwinMakerSourceConfigurationOutputTypeDef#

# IotTwinMakerSourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotTwinMakerSourceConfigurationOutputTypeDef


def get_value() -> IotTwinMakerSourceConfigurationOutputTypeDef:
    return {
        "workspace": ...,
    }


# IotTwinMakerSourceConfigurationOutputTypeDef definition

class IotTwinMakerSourceConfigurationOutputTypeDef(TypedDict):
    workspace: str,
    filters: NotRequired[List[IotTwinMakerSourceConfigurationFilterTypeDef]],  # (1)
  1. See List[IotTwinMakerSourceConfigurationFilterTypeDef]

IotTwinMakerSourceConfigurationTypeDef#

# IotTwinMakerSourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import IotTwinMakerSourceConfigurationTypeDef


def get_value() -> IotTwinMakerSourceConfigurationTypeDef:
    return {
        "workspace": ...,
    }


# IotTwinMakerSourceConfigurationTypeDef definition

class IotTwinMakerSourceConfigurationTypeDef(TypedDict):
    workspace: str,
    filters: NotRequired[Sequence[IotTwinMakerSourceConfigurationFilterTypeDef]],  # (1)
  1. See Sequence[IotTwinMakerSourceConfigurationFilterTypeDef]

PropertyDefinitionResponseTypeDef#

# PropertyDefinitionResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyDefinitionResponseTypeDef


def get_value() -> PropertyDefinitionResponseTypeDef:
    return {
        "dataType": ...,
    }


# PropertyDefinitionResponseTypeDef definition

class PropertyDefinitionResponseTypeDef(TypedDict):
    dataType: DataTypeOutputTypeDef,  # (1)
    isTimeSeries: bool,
    isRequiredInEntity: bool,
    isExternalId: bool,
    isStoredExternally: bool,
    isImported: bool,
    isFinal: bool,
    isInherited: bool,
    defaultValue: NotRequired[DataValueOutputTypeDef],  # (2)
    configuration: NotRequired[Dict[str, str]],
    displayName: NotRequired[str],
  1. See DataTypeOutputTypeDef
  2. See DataValueOutputTypeDef

GetPropertyValueResponseTypeDef#

# GetPropertyValueResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueResponseTypeDef


def get_value() -> GetPropertyValueResponseTypeDef:
    return {
        "propertyValues": ...,
    }


# GetPropertyValueResponseTypeDef definition

class GetPropertyValueResponseTypeDef(TypedDict):
    propertyValues: Dict[str, PropertyLatestValueTypeDef],  # (1)
    tabularPropertyValues: List[List[Dict[str, DataValueOutputTypeDef]]],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See Dict[str, PropertyLatestValueTypeDef]
  2. See List[List[Dict[str, DataValueOutputTypeDef]]]
  3. See ResponseMetadataTypeDef

PropertyValueEntryOutputTypeDef#

# PropertyValueEntryOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueEntryOutputTypeDef


def get_value() -> PropertyValueEntryOutputTypeDef:
    return {
        "entityPropertyReference": ...,
    }


# PropertyValueEntryOutputTypeDef definition

class PropertyValueEntryOutputTypeDef(TypedDict):
    entityPropertyReference: EntityPropertyReferenceOutputTypeDef,  # (1)
    propertyValues: NotRequired[List[PropertyValueOutputTypeDef]],  # (2)
  1. See EntityPropertyReferenceOutputTypeDef
  2. See List[PropertyValueOutputTypeDef]

PropertyValueHistoryTypeDef#

# PropertyValueHistoryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueHistoryTypeDef


def get_value() -> PropertyValueHistoryTypeDef:
    return {
        "entityPropertyReference": ...,
    }


# PropertyValueHistoryTypeDef definition

class PropertyValueHistoryTypeDef(TypedDict):
    entityPropertyReference: EntityPropertyReferenceOutputTypeDef,  # (1)
    values: NotRequired[List[PropertyValueOutputTypeDef]],  # (2)
  1. See EntityPropertyReferenceOutputTypeDef
  2. See List[PropertyValueOutputTypeDef]

DataTypeTypeDef#

# DataTypeTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import DataTypeTypeDef


def get_value() -> DataTypeTypeDef:
    return {
        "type": ...,
    }


# DataTypeTypeDef definition

class DataTypeTypeDef(TypedDict):
    type: TypeType,  # (1)
    nestedType: NotRequired[Mapping[str, Any]],
    allowedValues: NotRequired[Sequence[DataValueUnionTypeDef]],  # (2)
    unitOfMeasure: NotRequired[str],
    relationship: NotRequired[RelationshipTypeDef],  # (3)
  1. See TypeType
  2. See Sequence[DataValueUnionTypeDef]
  3. See RelationshipTypeDef

PropertyFilterTypeDef#

# PropertyFilterTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyFilterTypeDef


def get_value() -> PropertyFilterTypeDef:
    return {
        "propertyName": ...,
    }


# PropertyFilterTypeDef definition

class PropertyFilterTypeDef(TypedDict):
    propertyName: NotRequired[str],
    operator: NotRequired[str],
    value: NotRequired[DataValueUnionTypeDef],  # (1)
  1. See DataValueUnionTypeDef

PropertyValueTypeDef#

# PropertyValueTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueTypeDef


def get_value() -> PropertyValueTypeDef:
    return {
        "timestamp": ...,
    }


# PropertyValueTypeDef definition

class PropertyValueTypeDef(TypedDict):
    value: DataValueUnionTypeDef,  # (1)
    timestamp: NotRequired[TimestampTypeDef],
    time: NotRequired[str],
  1. See DataValueUnionTypeDef

ListMetadataTransferJobsResponseTypeDef#

# ListMetadataTransferJobsResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListMetadataTransferJobsResponseTypeDef


def get_value() -> ListMetadataTransferJobsResponseTypeDef:
    return {
        "metadataTransferJobSummaries": ...,
    }


# ListMetadataTransferJobsResponseTypeDef definition

class ListMetadataTransferJobsResponseTypeDef(TypedDict):
    metadataTransferJobSummaries: List[MetadataTransferJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[MetadataTransferJobSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListComponentsResponseTypeDef#

# ListComponentsResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListComponentsResponseTypeDef


def get_value() -> ListComponentsResponseTypeDef:
    return {
        "componentSummaries": ...,
    }


# ListComponentsResponseTypeDef definition

class ListComponentsResponseTypeDef(TypedDict):
    componentSummaries: List[ComponentSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ComponentSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListComponentTypesResponseTypeDef#

# ListComponentTypesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListComponentTypesResponseTypeDef


def get_value() -> ListComponentTypesResponseTypeDef:
    return {
        "workspaceId": ...,
    }


# ListComponentTypesResponseTypeDef definition

class ListComponentTypesResponseTypeDef(TypedDict):
    workspaceId: str,
    componentTypeSummaries: List[ComponentTypeSummaryTypeDef],  # (1)
    maxResults: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ComponentTypeSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListEntitiesResponseTypeDef#

# ListEntitiesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListEntitiesResponseTypeDef


def get_value() -> ListEntitiesResponseTypeDef:
    return {
        "entitySummaries": ...,
    }


# ListEntitiesResponseTypeDef definition

class ListEntitiesResponseTypeDef(TypedDict):
    entitySummaries: List[EntitySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[EntitySummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListSyncJobsResponseTypeDef#

# ListSyncJobsResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListSyncJobsResponseTypeDef


def get_value() -> ListSyncJobsResponseTypeDef:
    return {
        "syncJobSummaries": ...,
    }


# ListSyncJobsResponseTypeDef definition

class ListSyncJobsResponseTypeDef(TypedDict):
    syncJobSummaries: List[SyncJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SyncJobSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListSyncResourcesResponseTypeDef#

# ListSyncResourcesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListSyncResourcesResponseTypeDef


def get_value() -> ListSyncResourcesResponseTypeDef:
    return {
        "syncResources": ...,
    }


# ListSyncResourcesResponseTypeDef definition

class ListSyncResourcesResponseTypeDef(TypedDict):
    syncResources: List[SyncResourceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SyncResourceSummaryTypeDef]
  2. See ResponseMetadataTypeDef

SourceConfigurationOutputTypeDef#

# SourceConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SourceConfigurationOutputTypeDef


def get_value() -> SourceConfigurationOutputTypeDef:
    return {
        "type": ...,
    }


# SourceConfigurationOutputTypeDef definition

class SourceConfigurationOutputTypeDef(TypedDict):
    type: SourceTypeType,  # (1)
    s3Configuration: NotRequired[S3SourceConfigurationTypeDef],  # (2)
    iotSiteWiseConfiguration: NotRequired[IotSiteWiseSourceConfigurationOutputTypeDef],  # (3)
    iotTwinMakerConfiguration: NotRequired[IotTwinMakerSourceConfigurationOutputTypeDef],  # (4)
  1. See SourceTypeType
  2. See S3SourceConfigurationTypeDef
  3. See IotSiteWiseSourceConfigurationOutputTypeDef
  4. See IotTwinMakerSourceConfigurationOutputTypeDef

GetComponentTypeResponseTypeDef#

# GetComponentTypeResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetComponentTypeResponseTypeDef


def get_value() -> GetComponentTypeResponseTypeDef:
    return {
        "workspaceId": ...,
    }


# GetComponentTypeResponseTypeDef definition

class GetComponentTypeResponseTypeDef(TypedDict):
    workspaceId: str,
    isSingleton: bool,
    componentTypeId: str,
    description: str,
    propertyDefinitions: Dict[str, PropertyDefinitionResponseTypeDef],  # (1)
    extendsFrom: List[str],
    functions: Dict[str, FunctionResponseTypeDef],  # (2)
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    arn: str,
    isAbstract: bool,
    isSchemaInitialized: bool,
    status: StatusTypeDef,  # (3)
    propertyGroups: Dict[str, PropertyGroupResponseTypeDef],  # (4)
    syncSource: str,
    componentTypeName: str,
    compositeComponentTypes: Dict[str, CompositeComponentTypeResponseTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See Dict[str, PropertyDefinitionResponseTypeDef]
  2. See Dict[str, FunctionResponseTypeDef]
  3. See StatusTypeDef
  4. See Dict[str, PropertyGroupResponseTypeDef]
  5. See Dict[str, CompositeComponentTypeResponseTypeDef]
  6. See ResponseMetadataTypeDef

PropertyResponseTypeDef#

# PropertyResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyResponseTypeDef


def get_value() -> PropertyResponseTypeDef:
    return {
        "definition": ...,
    }


# PropertyResponseTypeDef definition

class PropertyResponseTypeDef(TypedDict):
    definition: NotRequired[PropertyDefinitionResponseTypeDef],  # (1)
    value: NotRequired[DataValueOutputTypeDef],  # (2)
    areAllPropertyValuesReturned: NotRequired[bool],
  1. See PropertyDefinitionResponseTypeDef
  2. See DataValueOutputTypeDef

PropertySummaryTypeDef#

# PropertySummaryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertySummaryTypeDef


def get_value() -> PropertySummaryTypeDef:
    return {
        "definition": ...,
    }


# PropertySummaryTypeDef definition

class PropertySummaryTypeDef(TypedDict):
    propertyName: str,
    definition: NotRequired[PropertyDefinitionResponseTypeDef],  # (1)
    value: NotRequired[DataValueOutputTypeDef],  # (2)
    areAllPropertyValuesReturned: NotRequired[bool],
  1. See PropertyDefinitionResponseTypeDef
  2. See DataValueOutputTypeDef

BatchPutPropertyErrorTypeDef#

# BatchPutPropertyErrorTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyErrorTypeDef


def get_value() -> BatchPutPropertyErrorTypeDef:
    return {
        "errorCode": ...,
    }


# BatchPutPropertyErrorTypeDef definition

class BatchPutPropertyErrorTypeDef(TypedDict):
    errorCode: str,
    errorMessage: str,
    entry: PropertyValueEntryOutputTypeDef,  # (1)
  1. See PropertyValueEntryOutputTypeDef

GetPropertyValueHistoryResponseTypeDef#

# GetPropertyValueHistoryResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueHistoryResponseTypeDef


def get_value() -> GetPropertyValueHistoryResponseTypeDef:
    return {
        "propertyValues": ...,
    }


# GetPropertyValueHistoryResponseTypeDef definition

class GetPropertyValueHistoryResponseTypeDef(TypedDict):
    propertyValues: List[PropertyValueHistoryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PropertyValueHistoryTypeDef]
  2. See ResponseMetadataTypeDef

GetPropertyValueHistoryRequestTypeDef#

# GetPropertyValueHistoryRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueHistoryRequestTypeDef


def get_value() -> GetPropertyValueHistoryRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# GetPropertyValueHistoryRequestTypeDef definition

class GetPropertyValueHistoryRequestTypeDef(TypedDict):
    workspaceId: str,
    selectedProperties: Sequence[str],
    entityId: NotRequired[str],
    componentName: NotRequired[str],
    componentPath: NotRequired[str],
    componentTypeId: NotRequired[str],
    propertyFilters: NotRequired[Sequence[PropertyFilterTypeDef]],  # (1)
    startDateTime: NotRequired[TimestampTypeDef],
    endDateTime: NotRequired[TimestampTypeDef],
    interpolation: NotRequired[InterpolationParametersTypeDef],  # (2)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    orderByTime: NotRequired[OrderByTimeType],  # (3)
    startTime: NotRequired[str],
    endTime: NotRequired[str],
  1. See Sequence[PropertyFilterTypeDef]
  2. See InterpolationParametersTypeDef
  3. See OrderByTimeType

TabularConditionsTypeDef#

# TabularConditionsTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import TabularConditionsTypeDef


def get_value() -> TabularConditionsTypeDef:
    return {
        "orderBy": ...,
    }


# TabularConditionsTypeDef definition

class TabularConditionsTypeDef(TypedDict):
    orderBy: NotRequired[Sequence[OrderByTypeDef]],  # (1)
    propertyFilters: NotRequired[Sequence[PropertyFilterTypeDef]],  # (2)
  1. See Sequence[OrderByTypeDef]
  2. See Sequence[PropertyFilterTypeDef]

GetMetadataTransferJobResponseTypeDef#

# GetMetadataTransferJobResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetMetadataTransferJobResponseTypeDef


def get_value() -> GetMetadataTransferJobResponseTypeDef:
    return {
        "metadataTransferJobId": ...,
    }


# GetMetadataTransferJobResponseTypeDef definition

class GetMetadataTransferJobResponseTypeDef(TypedDict):
    metadataTransferJobId: str,
    arn: str,
    description: str,
    sources: List[SourceConfigurationOutputTypeDef],  # (1)
    destination: DestinationConfigurationTypeDef,  # (2)
    metadataTransferJobRole: str,
    reportUrl: str,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    status: MetadataTransferJobStatusTypeDef,  # (3)
    progress: MetadataTransferJobProgressTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See List[SourceConfigurationOutputTypeDef]
  2. See DestinationConfigurationTypeDef
  3. See MetadataTransferJobStatusTypeDef
  4. See MetadataTransferJobProgressTypeDef
  5. See ResponseMetadataTypeDef

SourceConfigurationTypeDef#

# SourceConfigurationTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import SourceConfigurationTypeDef


def get_value() -> SourceConfigurationTypeDef:
    return {
        "type": ...,
    }


# SourceConfigurationTypeDef definition

class SourceConfigurationTypeDef(TypedDict):
    type: SourceTypeType,  # (1)
    s3Configuration: NotRequired[S3SourceConfigurationTypeDef],  # (2)
    iotSiteWiseConfiguration: NotRequired[IotSiteWiseSourceConfigurationUnionTypeDef],  # (3)
    iotTwinMakerConfiguration: NotRequired[IotTwinMakerSourceConfigurationUnionTypeDef],  # (4)
  1. See SourceTypeType
  2. See S3SourceConfigurationTypeDef
  3. See IotSiteWiseSourceConfigurationUnionTypeDef
  4. See IotTwinMakerSourceConfigurationUnionTypeDef

ComponentResponseTypeDef#

# ComponentResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentResponseTypeDef


def get_value() -> ComponentResponseTypeDef:
    return {
        "componentName": ...,
    }


# ComponentResponseTypeDef definition

class ComponentResponseTypeDef(TypedDict):
    componentName: NotRequired[str],
    description: NotRequired[str],
    componentTypeId: NotRequired[str],
    status: NotRequired[StatusTypeDef],  # (1)
    definedIn: NotRequired[str],
    properties: NotRequired[Dict[str, PropertyResponseTypeDef]],  # (2)
    propertyGroups: NotRequired[Dict[str, ComponentPropertyGroupResponseTypeDef]],  # (3)
    syncSource: NotRequired[str],
    areAllPropertiesReturned: NotRequired[bool],
    compositeComponents: NotRequired[Dict[str, ComponentSummaryTypeDef]],  # (4)
    areAllCompositeComponentsReturned: NotRequired[bool],
  1. See StatusTypeDef
  2. See Dict[str, PropertyResponseTypeDef]
  3. See Dict[str, ComponentPropertyGroupResponseTypeDef]
  4. See Dict[str, ComponentSummaryTypeDef]

ListPropertiesResponseTypeDef#

# ListPropertiesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ListPropertiesResponseTypeDef


def get_value() -> ListPropertiesResponseTypeDef:
    return {
        "propertySummaries": ...,
    }


# ListPropertiesResponseTypeDef definition

class ListPropertiesResponseTypeDef(TypedDict):
    propertySummaries: List[PropertySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PropertySummaryTypeDef]
  2. See ResponseMetadataTypeDef

BatchPutPropertyErrorEntryTypeDef#

# BatchPutPropertyErrorEntryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyErrorEntryTypeDef


def get_value() -> BatchPutPropertyErrorEntryTypeDef:
    return {
        "errors": ...,
    }


# BatchPutPropertyErrorEntryTypeDef definition

class BatchPutPropertyErrorEntryTypeDef(TypedDict):
    errors: List[BatchPutPropertyErrorTypeDef],  # (1)
  1. See List[BatchPutPropertyErrorTypeDef]

PropertyDefinitionRequestTypeDef#

# PropertyDefinitionRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyDefinitionRequestTypeDef


def get_value() -> PropertyDefinitionRequestTypeDef:
    return {
        "dataType": ...,
    }


# PropertyDefinitionRequestTypeDef definition

class PropertyDefinitionRequestTypeDef(TypedDict):
    dataType: NotRequired[DataTypeUnionTypeDef],  # (1)
    isRequiredInEntity: NotRequired[bool],
    isExternalId: NotRequired[bool],
    isStoredExternally: NotRequired[bool],
    isTimeSeries: NotRequired[bool],
    defaultValue: NotRequired[DataValueUnionTypeDef],  # (2)
    configuration: NotRequired[Mapping[str, str]],
    displayName: NotRequired[str],
  1. See DataTypeUnionTypeDef
  2. See DataValueUnionTypeDef

GetPropertyValueRequestTypeDef#

# GetPropertyValueRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueRequestTypeDef


def get_value() -> GetPropertyValueRequestTypeDef:
    return {
        "selectedProperties": ...,
    }


# GetPropertyValueRequestTypeDef definition

class GetPropertyValueRequestTypeDef(TypedDict):
    selectedProperties: Sequence[str],
    workspaceId: str,
    componentName: NotRequired[str],
    componentPath: NotRequired[str],
    componentTypeId: NotRequired[str],
    entityId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    propertyGroupName: NotRequired[str],
    tabularConditions: NotRequired[TabularConditionsTypeDef],  # (1)
  1. See TabularConditionsTypeDef

PropertyValueEntryTypeDef#

# PropertyValueEntryTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyValueEntryTypeDef


def get_value() -> PropertyValueEntryTypeDef:
    return {
        "entityPropertyReference": ...,
    }


# PropertyValueEntryTypeDef definition

class PropertyValueEntryTypeDef(TypedDict):
    entityPropertyReference: EntityPropertyReferenceUnionTypeDef,  # (1)
    propertyValues: NotRequired[Sequence[PropertyValueUnionTypeDef]],  # (2)
  1. See EntityPropertyReferenceUnionTypeDef
  2. See Sequence[PropertyValueUnionTypeDef]

GetEntityResponseTypeDef#

# GetEntityResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import GetEntityResponseTypeDef


def get_value() -> GetEntityResponseTypeDef:
    return {
        "entityId": ...,
    }


# GetEntityResponseTypeDef definition

class GetEntityResponseTypeDef(TypedDict):
    entityId: str,
    entityName: str,
    arn: str,
    status: StatusTypeDef,  # (1)
    workspaceId: str,
    description: str,
    components: Dict[str, ComponentResponseTypeDef],  # (2)
    parentEntityId: str,
    hasChildEntities: bool,
    creationDateTime: datetime.datetime,
    updateDateTime: datetime.datetime,
    syncSource: str,
    areAllComponentsReturned: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StatusTypeDef
  2. See Dict[str, ComponentResponseTypeDef]
  3. See ResponseMetadataTypeDef

BatchPutPropertyValuesResponseTypeDef#

# BatchPutPropertyValuesResponseTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyValuesResponseTypeDef


def get_value() -> BatchPutPropertyValuesResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchPutPropertyValuesResponseTypeDef definition

class BatchPutPropertyValuesResponseTypeDef(TypedDict):
    errorEntries: List[BatchPutPropertyErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[BatchPutPropertyErrorEntryTypeDef]
  2. See ResponseMetadataTypeDef

CreateComponentTypeRequestTypeDef#

# CreateComponentTypeRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateComponentTypeRequestTypeDef


def get_value() -> CreateComponentTypeRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# CreateComponentTypeRequestTypeDef definition

class CreateComponentTypeRequestTypeDef(TypedDict):
    workspaceId: str,
    componentTypeId: str,
    isSingleton: NotRequired[bool],
    description: NotRequired[str],
    propertyDefinitions: NotRequired[Mapping[str, PropertyDefinitionRequestTypeDef]],  # (1)
    extendsFrom: NotRequired[Sequence[str]],
    functions: NotRequired[Mapping[str, FunctionRequestTypeDef]],  # (2)
    tags: NotRequired[Mapping[str, str]],
    propertyGroups: NotRequired[Mapping[str, PropertyGroupRequestTypeDef]],  # (3)
    componentTypeName: NotRequired[str],
    compositeComponentTypes: NotRequired[Mapping[str, CompositeComponentTypeRequestTypeDef]],  # (4)
  1. See Mapping[str, PropertyDefinitionRequestTypeDef]
  2. See Mapping[str, FunctionRequestTypeDef]
  3. See Mapping[str, PropertyGroupRequestTypeDef]
  4. See Mapping[str, CompositeComponentTypeRequestTypeDef]

PropertyRequestTypeDef#

# PropertyRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import PropertyRequestTypeDef


def get_value() -> PropertyRequestTypeDef:
    return {
        "definition": ...,
    }


# PropertyRequestTypeDef definition

class PropertyRequestTypeDef(TypedDict):
    definition: NotRequired[PropertyDefinitionRequestTypeDef],  # (1)
    value: NotRequired[DataValueUnionTypeDef],  # (2)
    updateType: NotRequired[PropertyUpdateTypeType],  # (3)
  1. See PropertyDefinitionRequestTypeDef
  2. See DataValueUnionTypeDef
  3. See PropertyUpdateTypeType

UpdateComponentTypeRequestTypeDef#

# UpdateComponentTypeRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateComponentTypeRequestTypeDef


def get_value() -> UpdateComponentTypeRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# UpdateComponentTypeRequestTypeDef definition

class UpdateComponentTypeRequestTypeDef(TypedDict):
    workspaceId: str,
    componentTypeId: str,
    isSingleton: NotRequired[bool],
    description: NotRequired[str],
    propertyDefinitions: NotRequired[Mapping[str, PropertyDefinitionRequestTypeDef]],  # (1)
    extendsFrom: NotRequired[Sequence[str]],
    functions: NotRequired[Mapping[str, FunctionRequestTypeDef]],  # (2)
    propertyGroups: NotRequired[Mapping[str, PropertyGroupRequestTypeDef]],  # (3)
    componentTypeName: NotRequired[str],
    compositeComponentTypes: NotRequired[Mapping[str, CompositeComponentTypeRequestTypeDef]],  # (4)
  1. See Mapping[str, PropertyDefinitionRequestTypeDef]
  2. See Mapping[str, FunctionRequestTypeDef]
  3. See Mapping[str, PropertyGroupRequestTypeDef]
  4. See Mapping[str, CompositeComponentTypeRequestTypeDef]

CreateMetadataTransferJobRequestTypeDef#

# CreateMetadataTransferJobRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateMetadataTransferJobRequestTypeDef


def get_value() -> CreateMetadataTransferJobRequestTypeDef:
    return {
        "sources": ...,
    }


# CreateMetadataTransferJobRequestTypeDef definition

class CreateMetadataTransferJobRequestTypeDef(TypedDict):
    sources: Sequence[SourceConfigurationUnionTypeDef],  # (1)
    destination: DestinationConfigurationTypeDef,  # (2)
    metadataTransferJobId: NotRequired[str],
    description: NotRequired[str],
  1. See Sequence[SourceConfigurationUnionTypeDef]
  2. See DestinationConfigurationTypeDef

ComponentRequestTypeDef#

# ComponentRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentRequestTypeDef


def get_value() -> ComponentRequestTypeDef:
    return {
        "description": ...,
    }


# ComponentRequestTypeDef definition

class ComponentRequestTypeDef(TypedDict):
    description: NotRequired[str],
    componentTypeId: NotRequired[str],
    properties: NotRequired[Mapping[str, PropertyRequestTypeDef]],  # (1)
    propertyGroups: NotRequired[Mapping[str, ComponentPropertyGroupRequestTypeDef]],  # (2)
  1. See Mapping[str, PropertyRequestTypeDef]
  2. See Mapping[str, ComponentPropertyGroupRequestTypeDef]

ComponentUpdateRequestTypeDef#

# ComponentUpdateRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import ComponentUpdateRequestTypeDef


def get_value() -> ComponentUpdateRequestTypeDef:
    return {
        "updateType": ...,
    }


# ComponentUpdateRequestTypeDef definition

class ComponentUpdateRequestTypeDef(TypedDict):
    updateType: NotRequired[ComponentUpdateTypeType],  # (1)
    description: NotRequired[str],
    componentTypeId: NotRequired[str],
    propertyUpdates: NotRequired[Mapping[str, PropertyRequestTypeDef]],  # (2)
    propertyGroupUpdates: NotRequired[Mapping[str, ComponentPropertyGroupRequestTypeDef]],  # (3)
  1. See ComponentUpdateTypeType
  2. See Mapping[str, PropertyRequestTypeDef]
  3. See Mapping[str, ComponentPropertyGroupRequestTypeDef]

CompositeComponentRequestTypeDef#

# CompositeComponentRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CompositeComponentRequestTypeDef


def get_value() -> CompositeComponentRequestTypeDef:
    return {
        "description": ...,
    }


# CompositeComponentRequestTypeDef definition

class CompositeComponentRequestTypeDef(TypedDict):
    description: NotRequired[str],
    properties: NotRequired[Mapping[str, PropertyRequestTypeDef]],  # (1)
    propertyGroups: NotRequired[Mapping[str, ComponentPropertyGroupRequestTypeDef]],  # (2)
  1. See Mapping[str, PropertyRequestTypeDef]
  2. See Mapping[str, ComponentPropertyGroupRequestTypeDef]

CompositeComponentUpdateRequestTypeDef#

# CompositeComponentUpdateRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CompositeComponentUpdateRequestTypeDef


def get_value() -> CompositeComponentUpdateRequestTypeDef:
    return {
        "updateType": ...,
    }


# CompositeComponentUpdateRequestTypeDef definition

class CompositeComponentUpdateRequestTypeDef(TypedDict):
    updateType: NotRequired[ComponentUpdateTypeType],  # (1)
    description: NotRequired[str],
    propertyUpdates: NotRequired[Mapping[str, PropertyRequestTypeDef]],  # (2)
    propertyGroupUpdates: NotRequired[Mapping[str, ComponentPropertyGroupRequestTypeDef]],  # (3)
  1. See ComponentUpdateTypeType
  2. See Mapping[str, PropertyRequestTypeDef]
  3. See Mapping[str, ComponentPropertyGroupRequestTypeDef]

BatchPutPropertyValuesRequestTypeDef#

# BatchPutPropertyValuesRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyValuesRequestTypeDef


def get_value() -> BatchPutPropertyValuesRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# BatchPutPropertyValuesRequestTypeDef definition

class BatchPutPropertyValuesRequestTypeDef(TypedDict):
    workspaceId: str,
    entries: Sequence[PropertyValueEntryUnionTypeDef],  # (1)
  1. See Sequence[PropertyValueEntryUnionTypeDef]

CreateEntityRequestTypeDef#

# CreateEntityRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import CreateEntityRequestTypeDef


def get_value() -> CreateEntityRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# CreateEntityRequestTypeDef definition

class CreateEntityRequestTypeDef(TypedDict):
    workspaceId: str,
    entityName: str,
    entityId: NotRequired[str],
    description: NotRequired[str],
    components: NotRequired[Mapping[str, ComponentRequestTypeDef]],  # (1)
    compositeComponents: NotRequired[Mapping[str, CompositeComponentRequestTypeDef]],  # (2)
    parentEntityId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See Mapping[str, ComponentRequestTypeDef]
  2. See Mapping[str, CompositeComponentRequestTypeDef]

UpdateEntityRequestTypeDef#

# UpdateEntityRequestTypeDef TypedDict usage example

from mypy_boto3_iottwinmaker.type_defs import UpdateEntityRequestTypeDef


def get_value() -> UpdateEntityRequestTypeDef:
    return {
        "workspaceId": ...,
    }


# UpdateEntityRequestTypeDef definition

class UpdateEntityRequestTypeDef(TypedDict):
    workspaceId: str,
    entityId: str,
    entityName: NotRequired[str],
    description: NotRequired[str],
    componentUpdates: NotRequired[Mapping[str, ComponentUpdateRequestTypeDef]],  # (1)
    compositeComponentUpdates: NotRequired[Mapping[str, CompositeComponentUpdateRequestTypeDef]],  # (2)
    parentEntityUpdate: NotRequired[ParentEntityUpdateRequestTypeDef],  # (3)
  1. See Mapping[str, ComponentUpdateRequestTypeDef]
  2. See Mapping[str, CompositeComponentUpdateRequestTypeDef]
  3. See ParentEntityUpdateRequestTypeDef