Skip to content

Type definitions#

Index > IoTTwinMaker > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EntityPropertyReferenceUnionTypeDef#

# EntityPropertyReferenceUnionTypeDef definition

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

DataValueUnionTypeDef#

# DataValueUnionTypeDef definition

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

IotSiteWiseSourceConfigurationUnionTypeDef#

# IotSiteWiseSourceConfigurationUnionTypeDef definition

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

IotTwinMakerSourceConfigurationUnionTypeDef#

# IotTwinMakerSourceConfigurationUnionTypeDef definition

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

DataTypeUnionTypeDef#

# DataTypeUnionTypeDef definition

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

PropertyValueUnionTypeDef#

# PropertyValueUnionTypeDef definition

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

SourceConfigurationUnionTypeDef#

# SourceConfigurationUnionTypeDef definition

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

PropertyValueEntryUnionTypeDef#

# PropertyValueEntryUnionTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BundleInformationTypeDef#

# BundleInformationTypeDef definition

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

CancelMetadataTransferJobRequestRequestTypeDef#

# CancelMetadataTransferJobRequestRequestTypeDef definition

class CancelMetadataTransferJobRequestRequestTypeDef(TypedDict):
    metadataTransferJobId: str,

MetadataTransferJobProgressTypeDef#

# MetadataTransferJobProgressTypeDef definition

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

ColumnDescriptionTypeDef#

# ColumnDescriptionTypeDef definition

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

ComponentPropertyGroupRequestTypeDef#

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

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

CompositeComponentTypeRequestTypeDef#

# CompositeComponentTypeRequestTypeDef definition

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

CompositeComponentTypeResponseTypeDef#

# CompositeComponentTypeResponseTypeDef definition

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

PropertyGroupRequestTypeDef#

# PropertyGroupRequestTypeDef definition

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

CreateSceneRequestRequestTypeDef#

# CreateSceneRequestRequestTypeDef definition

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

CreateSyncJobRequestRequestTypeDef#

# CreateSyncJobRequestRequestTypeDef definition

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

CreateWorkspaceRequestRequestTypeDef#

# CreateWorkspaceRequestRequestTypeDef definition

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

LambdaFunctionTypeDef#

# LambdaFunctionTypeDef definition

class LambdaFunctionTypeDef(TypedDict):
    arn: str,

RelationshipTypeDef#

# RelationshipTypeDef definition

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

RelationshipValueTypeDef#

# RelationshipValueTypeDef definition

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

DeleteComponentTypeRequestRequestTypeDef#

# DeleteComponentTypeRequestRequestTypeDef definition

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

DeleteEntityRequestRequestTypeDef#

# DeleteEntityRequestRequestTypeDef definition

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

DeleteSceneRequestRequestTypeDef#

# DeleteSceneRequestRequestTypeDef definition

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

DeleteSyncJobRequestRequestTypeDef#

# DeleteSyncJobRequestRequestTypeDef definition

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

DeleteWorkspaceRequestRequestTypeDef#

# DeleteWorkspaceRequestRequestTypeDef definition

class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

IotTwinMakerDestinationConfigurationTypeDef#

# IotTwinMakerDestinationConfigurationTypeDef definition

class IotTwinMakerDestinationConfigurationTypeDef(TypedDict):
    workspace: str,

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef definition

class S3DestinationConfigurationTypeDef(TypedDict):
    location: str,

EntityPropertyReferenceOutputTypeDef#

# EntityPropertyReferenceOutputTypeDef definition

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

EntityPropertyReferenceTypeDef#

# EntityPropertyReferenceTypeDef definition

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

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

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

ExecuteQueryRequestRequestTypeDef#

# ExecuteQueryRequestRequestTypeDef definition

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

RowTypeDef#

# RowTypeDef definition

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

FilterByAssetModelTypeDef#

# FilterByAssetModelTypeDef definition

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

FilterByAssetTypeDef#

# FilterByAssetTypeDef definition

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

FilterByComponentTypeTypeDef#

# FilterByComponentTypeTypeDef definition

class FilterByComponentTypeTypeDef(TypedDict):
    componentTypeId: str,

FilterByEntityTypeDef#

# FilterByEntityTypeDef definition

class FilterByEntityTypeDef(TypedDict):
    entityId: str,

GetComponentTypeRequestRequestTypeDef#

# GetComponentTypeRequestRequestTypeDef definition

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

PropertyGroupResponseTypeDef#

# PropertyGroupResponseTypeDef definition

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

GetEntityRequestRequestTypeDef#

# GetEntityRequestRequestTypeDef definition

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

GetMetadataTransferJobRequestRequestTypeDef#

# GetMetadataTransferJobRequestRequestTypeDef definition

class GetMetadataTransferJobRequestRequestTypeDef(TypedDict):
    metadataTransferJobId: str,

InterpolationParametersTypeDef#

# InterpolationParametersTypeDef definition

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

GetSceneRequestRequestTypeDef#

# GetSceneRequestRequestTypeDef definition

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

SceneErrorTypeDef#

# SceneErrorTypeDef definition

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

GetSyncJobRequestRequestTypeDef#

# GetSyncJobRequestRequestTypeDef definition

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

GetWorkspaceRequestRequestTypeDef#

# GetWorkspaceRequestRequestTypeDef definition

class GetWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

ListComponentTypesFilterTypeDef#

# ListComponentTypesFilterTypeDef definition

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

ListComponentsRequestRequestTypeDef#

# ListComponentsRequestRequestTypeDef definition

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

ListEntitiesFilterTypeDef#

# ListEntitiesFilterTypeDef definition

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

ListMetadataTransferJobsFilterTypeDef#

# ListMetadataTransferJobsFilterTypeDef definition

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

ListPropertiesRequestRequestTypeDef#

# ListPropertiesRequestRequestTypeDef definition

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

ListScenesRequestRequestTypeDef#

# ListScenesRequestRequestTypeDef definition

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

SceneSummaryTypeDef#

# SceneSummaryTypeDef definition

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

ListSyncJobsRequestRequestTypeDef#

# ListSyncJobsRequestRequestTypeDef definition

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

SyncResourceFilterTypeDef#

# 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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

ListWorkspacesRequestRequestTypeDef#

# ListWorkspacesRequestRequestTypeDef definition

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

WorkspaceSummaryTypeDef#

# WorkspaceSummaryTypeDef definition

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

OrderByTypeDef#

# OrderByTypeDef definition

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

ParentEntityUpdateRequestTypeDef#

# ParentEntityUpdateRequestTypeDef definition

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

S3SourceConfigurationTypeDef#

# S3SourceConfigurationTypeDef definition

class S3SourceConfigurationTypeDef(TypedDict):
    location: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdatePricingPlanRequestRequestTypeDef#

# UpdatePricingPlanRequestRequestTypeDef definition

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

UpdateSceneRequestRequestTypeDef#

# UpdateSceneRequestRequestTypeDef definition

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

UpdateWorkspaceRequestRequestTypeDef#

# UpdateWorkspaceRequestRequestTypeDef definition

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

CreateComponentTypeResponseTypeDef#

# CreateComponentTypeResponseTypeDef definition

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

CreateEntityResponseTypeDef#

# CreateEntityResponseTypeDef definition

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

CreateSceneResponseTypeDef#

# CreateSceneResponseTypeDef definition

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

CreateSyncJobResponseTypeDef#

# CreateSyncJobResponseTypeDef definition

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

CreateWorkspaceResponseTypeDef#

# CreateWorkspaceResponseTypeDef definition

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

DeleteComponentTypeResponseTypeDef#

# DeleteComponentTypeResponseTypeDef definition

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

DeleteEntityResponseTypeDef#

# DeleteEntityResponseTypeDef definition

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

DeleteSyncJobResponseTypeDef#

# DeleteSyncJobResponseTypeDef definition

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

DeleteWorkspaceResponseTypeDef#

# DeleteWorkspaceResponseTypeDef definition

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

GetWorkspaceResponseTypeDef#

# GetWorkspaceResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

UpdateComponentTypeResponseTypeDef#

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

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

UpdateSceneResponseTypeDef#

# UpdateSceneResponseTypeDef definition

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

UpdateWorkspaceResponseTypeDef#

# UpdateWorkspaceResponseTypeDef definition

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

PricingPlanTypeDef#

# PricingPlanTypeDef definition

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

DataConnectorTypeDef#

# DataConnectorTypeDef definition

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

DataValueOutputTypeDef#

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

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

StatusTypeDef#

# StatusTypeDef definition

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

SyncJobStatusTypeDef#

# SyncJobStatusTypeDef definition

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

SyncResourceStatusTypeDef#

# SyncResourceStatusTypeDef definition

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

ExecuteQueryResponseTypeDef#

# ExecuteQueryResponseTypeDef definition

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

IotSiteWiseSourceConfigurationFilterTypeDef#

# IotSiteWiseSourceConfigurationFilterTypeDef definition

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

IotTwinMakerSourceConfigurationFilterTypeDef#

# IotTwinMakerSourceConfigurationFilterTypeDef definition

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

GetSceneResponseTypeDef#

# GetSceneResponseTypeDef definition

class GetSceneResponseTypeDef(TypedDict):
    workspaceId: str,
    sceneId: str,
    contentLocation: str,
    arn: str,
    creationDateTime: datetime,
    updateDateTime: 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

ListComponentTypesRequestRequestTypeDef#

# ListComponentTypesRequestRequestTypeDef definition

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

ListEntitiesRequestRequestTypeDef#

# ListEntitiesRequestRequestTypeDef definition

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

ListMetadataTransferJobsRequestRequestTypeDef#

# ListMetadataTransferJobsRequestRequestTypeDef definition

class ListMetadataTransferJobsRequestRequestTypeDef(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 ListMetadataTransferJobsFilterTypeDef

ListScenesResponseTypeDef#

# ListScenesResponseTypeDef definition

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

ListSyncResourcesRequestRequestTypeDef#

# ListSyncResourcesRequestRequestTypeDef definition

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

ListWorkspacesResponseTypeDef#

# ListWorkspacesResponseTypeDef definition

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

GetPricingPlanResponseTypeDef#

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

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

FunctionRequestTypeDef#

# 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 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 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 DataValueOutputTypeDef
  3. See RelationshipTypeDef

PropertyLatestValueTypeDef#

# PropertyLatestValueTypeDef definition

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

PropertyValueOutputTypeDef#

# PropertyValueOutputTypeDef definition

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

CancelMetadataTransferJobResponseTypeDef#

# CancelMetadataTransferJobResponseTypeDef definition

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

CreateMetadataTransferJobResponseTypeDef#

# CreateMetadataTransferJobResponseTypeDef definition

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

MetadataTransferJobSummaryTypeDef#

# MetadataTransferJobSummaryTypeDef definition

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

ComponentSummaryTypeDef#

# 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 ComponentPropertyGroupResponseTypeDef
  2. See StatusTypeDef

ComponentTypeSummaryTypeDef#

# ComponentTypeSummaryTypeDef definition

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

EntitySummaryTypeDef#

# EntitySummaryTypeDef definition

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

GetSyncJobResponseTypeDef#

# GetSyncJobResponseTypeDef definition

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

SyncJobSummaryTypeDef#

# SyncJobSummaryTypeDef definition

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

SyncResourceSummaryTypeDef#

# SyncResourceSummaryTypeDef definition

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

IotSiteWiseSourceConfigurationOutputTypeDef#

# IotSiteWiseSourceConfigurationOutputTypeDef definition

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

IotSiteWiseSourceConfigurationTypeDef#

# IotSiteWiseSourceConfigurationTypeDef definition

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

IotTwinMakerSourceConfigurationOutputTypeDef#

# IotTwinMakerSourceConfigurationOutputTypeDef definition

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

IotTwinMakerSourceConfigurationTypeDef#

# IotTwinMakerSourceConfigurationTypeDef definition

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

PropertyDefinitionResponseTypeDef#

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

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

PropertyValueEntryOutputTypeDef#

# PropertyValueEntryOutputTypeDef definition

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

PropertyValueHistoryTypeDef#

# PropertyValueHistoryTypeDef definition

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

DataTypeTypeDef#

# 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 DataValueTypeDef DataValueOutputTypeDef
  3. See RelationshipTypeDef

PropertyFilterTypeDef#

# PropertyFilterTypeDef definition

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

PropertyValueTypeDef#

# PropertyValueTypeDef definition

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

ListMetadataTransferJobsResponseTypeDef#

# ListMetadataTransferJobsResponseTypeDef definition

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

ListComponentsResponseTypeDef#

# ListComponentsResponseTypeDef definition

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

ListComponentTypesResponseTypeDef#

# ListComponentTypesResponseTypeDef definition

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

ListEntitiesResponseTypeDef#

# ListEntitiesResponseTypeDef definition

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

ListSyncJobsResponseTypeDef#

# ListSyncJobsResponseTypeDef definition

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

ListSyncResourcesResponseTypeDef#

# ListSyncResourcesResponseTypeDef definition

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

SourceConfigurationOutputTypeDef#

# 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 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,
    updateDateTime: 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 PropertyDefinitionResponseTypeDef
  2. See FunctionResponseTypeDef
  3. See StatusTypeDef
  4. See PropertyGroupResponseTypeDef
  5. See CompositeComponentTypeResponseTypeDef
  6. See ResponseMetadataTypeDef

PropertyResponseTypeDef#

# PropertyResponseTypeDef definition

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

PropertySummaryTypeDef#

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

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

GetPropertyValueHistoryResponseTypeDef#

# GetPropertyValueHistoryResponseTypeDef definition

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

GetPropertyValueHistoryRequestRequestTypeDef#

# GetPropertyValueHistoryRequestRequestTypeDef definition

class GetPropertyValueHistoryRequestRequestTypeDef(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 PropertyFilterTypeDef
  2. See InterpolationParametersTypeDef
  3. See OrderByTimeType

TabularConditionsTypeDef#

# TabularConditionsTypeDef definition

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

GetMetadataTransferJobResponseTypeDef#

# GetMetadataTransferJobResponseTypeDef definition

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

SourceConfigurationTypeDef#

# 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 IotSiteWiseSourceConfigurationTypeDef IotSiteWiseSourceConfigurationOutputTypeDef
  4. See IotTwinMakerSourceConfigurationTypeDef IotTwinMakerSourceConfigurationOutputTypeDef

ComponentResponseTypeDef#

# 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 PropertyResponseTypeDef
  3. See ComponentPropertyGroupResponseTypeDef
  4. See ComponentSummaryTypeDef

ListPropertiesResponseTypeDef#

# ListPropertiesResponseTypeDef definition

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

BatchPutPropertyErrorEntryTypeDef#

# BatchPutPropertyErrorEntryTypeDef definition

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

PropertyDefinitionRequestTypeDef#

# 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 DataTypeTypeDef DataTypeOutputTypeDef
  2. See DataValueTypeDef DataValueOutputTypeDef

GetPropertyValueRequestRequestTypeDef#

# GetPropertyValueRequestRequestTypeDef definition

class GetPropertyValueRequestRequestTypeDef(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 definition

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

GetEntityResponseTypeDef#

# 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,
    updateDateTime: datetime,
    syncSource: str,
    areAllComponentsReturned: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StatusTypeDef
  2. See ComponentResponseTypeDef
  3. See ResponseMetadataTypeDef

BatchPutPropertyValuesResponseTypeDef#

# BatchPutPropertyValuesResponseTypeDef definition

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

CreateComponentTypeRequestRequestTypeDef#

# CreateComponentTypeRequestRequestTypeDef definition

class CreateComponentTypeRequestRequestTypeDef(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 PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef
  4. See CompositeComponentTypeRequestTypeDef

PropertyRequestTypeDef#

# PropertyRequestTypeDef definition

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

UpdateComponentTypeRequestRequestTypeDef#

# UpdateComponentTypeRequestRequestTypeDef definition

class UpdateComponentTypeRequestRequestTypeDef(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 PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef
  4. See CompositeComponentTypeRequestTypeDef

CreateMetadataTransferJobRequestRequestTypeDef#

# CreateMetadataTransferJobRequestRequestTypeDef definition

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

ComponentRequestTypeDef#

# 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 PropertyRequestTypeDef
  2. See ComponentPropertyGroupRequestTypeDef

ComponentUpdateRequestTypeDef#

# 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 PropertyRequestTypeDef
  3. See ComponentPropertyGroupRequestTypeDef

CompositeComponentRequestTypeDef#

# CompositeComponentRequestTypeDef definition

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

CompositeComponentUpdateRequestTypeDef#

# 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 PropertyRequestTypeDef
  3. See ComponentPropertyGroupRequestTypeDef

BatchPutPropertyValuesRequestRequestTypeDef#

# BatchPutPropertyValuesRequestRequestTypeDef definition

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

CreateEntityRequestRequestTypeDef#

# CreateEntityRequestRequestTypeDef definition

class CreateEntityRequestRequestTypeDef(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 ComponentRequestTypeDef
  2. See CompositeComponentRequestTypeDef

UpdateEntityRequestRequestTypeDef#

# UpdateEntityRequestRequestTypeDef definition

class UpdateEntityRequestRequestTypeDef(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 ComponentUpdateRequestTypeDef
  2. See CompositeComponentUpdateRequestTypeDef
  3. See ParentEntityUpdateRequestTypeDef