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,
]

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BundleInformationTypeDef#

# BundleInformationTypeDef definition

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

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

PropertyDefinitionRequestTypeDef#

# PropertyDefinitionRequestTypeDef definition

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

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,
    s3Location: str,
    role: str,
    description: 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,

EntityPropertyReferenceTypeDef#

# EntityPropertyReferenceTypeDef definition

class EntityPropertyReferenceTypeDef(TypedDict):
    propertyName: str,
    componentName: 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]]],

GetComponentTypeRequestRequestTypeDef#

# GetComponentTypeRequestRequestTypeDef definition

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

PropertyDefinitionResponseTypeDef#

# PropertyDefinitionResponseTypeDef definition

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

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,

InterpolationParametersTypeDef#

# InterpolationParametersTypeDef definition

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

PropertyFilterTypeDef#

# PropertyFilterTypeDef definition

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

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],

ListEntitiesFilterTypeDef#

# ListEntitiesFilterTypeDef definition

class ListEntitiesFilterTypeDef(TypedDict):
    parentEntityId: NotRequired[str],
    componentTypeId: NotRequired[str],
    externalId: 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],

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

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],

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

GetWorkspaceResponseTypeDef#

# GetWorkspaceResponseTypeDef definition

class GetWorkspaceResponseTypeDef(TypedDict):
    workspaceId: str,
    arn: str,
    description: 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],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  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

PropertyRequestTypeDef#

# PropertyRequestTypeDef definition

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

DataConnectorTypeDef#

# DataConnectorTypeDef definition

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

DataTypeTypeDef#

# DataTypeTypeDef definition

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

DataValueTypeDef#

# DataValueTypeDef definition

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

PropertyLatestValueTypeDef#

# PropertyLatestValueTypeDef definition

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

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)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ColumnDescriptionTypeDef
  2. See RowTypeDef
  3. See ResponseMetadataTypeDef

PropertyResponseTypeDef#

# PropertyResponseTypeDef definition

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

GetPropertyValueHistoryRequestRequestTypeDef#

# GetPropertyValueHistoryRequestRequestTypeDef definition

class GetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    selectedProperties: Sequence[str],
    entityId: NotRequired[str],
    componentName: NotRequired[str],
    componentTypeId: NotRequired[str],
    propertyFilters: NotRequired[Sequence[PropertyFilterTypeDef]],  # (1)
    startDateTime: NotRequired[Union[datetime, str]],
    endDateTime: NotRequired[Union[datetime, str]],
    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

PropertyValueTypeDef#

# PropertyValueTypeDef definition

class PropertyValueTypeDef(TypedDict):
    value: DataValueTypeDef,  # (1)
    timestamp: NotRequired[Union[datetime, str]],
    time: NotRequired[str],
  1. See DataValueTypeDef

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

ListScenesResponseTypeDef#

# ListScenesResponseTypeDef definition

class ListScenesResponseTypeDef(TypedDict):
    sceneSummaries: List[SceneSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  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)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

TabularConditionsTypeDef#

# TabularConditionsTypeDef definition

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

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

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

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

GetPropertyValueResponseTypeDef#

# GetPropertyValueResponseTypeDef definition

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

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

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],
  1. See StatusTypeDef
  2. See PropertyResponseTypeDef
  3. See ComponentPropertyGroupResponseTypeDef

PropertyValueEntryTypeDef#

# PropertyValueEntryTypeDef definition

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

PropertyValueHistoryTypeDef#

# PropertyValueHistoryTypeDef definition

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

GetPropertyValueRequestRequestTypeDef#

# GetPropertyValueRequestRequestTypeDef definition

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

CreateEntityRequestRequestTypeDef#

# CreateEntityRequestRequestTypeDef definition

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

UpdateEntityRequestRequestTypeDef#

# UpdateEntityRequestRequestTypeDef definition

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

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],
  1. See PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef

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],
  1. See PropertyDefinitionRequestTypeDef
  2. See FunctionRequestTypeDef
  3. See PropertyGroupRequestTypeDef

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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See PropertyDefinitionResponseTypeDef
  2. See FunctionResponseTypeDef
  3. See StatusTypeDef
  4. See PropertyGroupResponseTypeDef
  5. See ResponseMetadataTypeDef

ListComponentTypesResponseTypeDef#

# ListComponentTypesResponseTypeDef definition

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

ListEntitiesResponseTypeDef#

# ListEntitiesResponseTypeDef definition

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

ListSyncJobsResponseTypeDef#

# ListSyncJobsResponseTypeDef definition

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

ListSyncResourcesResponseTypeDef#

# ListSyncResourcesResponseTypeDef definition

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

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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StatusTypeDef
  2. See ComponentResponseTypeDef
  3. See ResponseMetadataTypeDef

BatchPutPropertyErrorTypeDef#

# BatchPutPropertyErrorTypeDef definition

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

BatchPutPropertyValuesRequestRequestTypeDef#

# BatchPutPropertyValuesRequestRequestTypeDef definition

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

GetPropertyValueHistoryResponseTypeDef#

# GetPropertyValueHistoryResponseTypeDef definition

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

BatchPutPropertyErrorEntryTypeDef#

# BatchPutPropertyErrorEntryTypeDef definition

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

BatchPutPropertyValuesResponseTypeDef#

# BatchPutPropertyValuesResponseTypeDef definition

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