Typed dictionaries#
Index > IoTTwinMaker > Typed dictionaries
Auto-generated documentation for IoTTwinMaker type annotations stubs module mypy-boto3-iottwinmaker.
BundleInformationTypeDef#
# BundleInformationTypeDef 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)
- See PricingTierType
ColumnDescriptionTypeDef#
# ColumnDescriptionTypeDef 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)
- See ColumnTypeType
ComponentPropertyGroupRequestTypeDef#
# ComponentPropertyGroupRequestTypeDef 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)
ComponentPropertyGroupResponseTypeDef#
# ComponentPropertyGroupResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ComponentPropertyGroupResponseTypeDef
def get_value() -> ComponentPropertyGroupResponseTypeDef:
return {
"groupType": ...,
"propertyNames": ...,
"isInherited": ...,
}
# ComponentPropertyGroupResponseTypeDef definition
class ComponentPropertyGroupResponseTypeDef(TypedDict):
groupType: GroupTypeType, # (1)
propertyNames: List[str],
isInherited: bool,
- See GroupTypeType
PropertyDefinitionRequestTypeDef#
# PropertyDefinitionRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyDefinitionRequestTypeDef
def get_value() -> PropertyDefinitionRequestTypeDef:
return {
"dataType": ...,
}
# 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],
- See DataTypeTypeDef
- See DataValueTypeDef
PropertyGroupRequestTypeDef#
# PropertyGroupRequestTypeDef 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]],
- See GroupTypeType
CreateComponentTypeResponseTypeDef#
# CreateComponentTypeResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateComponentTypeResponseTypeDef
def get_value() -> CreateComponentTypeResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"state": ...,
"ResponseMetadata": ...,
}
# CreateComponentTypeResponseTypeDef definition
class CreateComponentTypeResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
CreateEntityResponseTypeDef#
# CreateEntityResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateEntityResponseTypeDef
def get_value() -> CreateEntityResponseTypeDef:
return {
"entityId": ...,
"arn": ...,
"creationDateTime": ...,
"state": ...,
"ResponseMetadata": ...,
}
# CreateEntityResponseTypeDef definition
class CreateEntityResponseTypeDef(TypedDict):
entityId: str,
arn: str,
creationDateTime: datetime,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
CreateSceneRequestRequestTypeDef#
# CreateSceneRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateSceneRequestRequestTypeDef
def get_value() -> CreateSceneRequestRequestTypeDef:
return {
"workspaceId": ...,
"sceneId": ...,
"contentLocation": ...,
}
# 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]],
CreateSceneResponseTypeDef#
# CreateSceneResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateSceneResponseTypeDef
def get_value() -> CreateSceneResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"ResponseMetadata": ...,
}
# CreateSceneResponseTypeDef definition
class CreateSceneResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSyncJobRequestRequestTypeDef#
# CreateSyncJobRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateSyncJobRequestRequestTypeDef
def get_value() -> CreateSyncJobRequestRequestTypeDef:
return {
"workspaceId": ...,
"syncSource": ...,
"syncRole": ...,
}
# CreateSyncJobRequestRequestTypeDef definition
class CreateSyncJobRequestRequestTypeDef(TypedDict):
workspaceId: str,
syncSource: str,
syncRole: str,
tags: NotRequired[Mapping[str, str]],
CreateSyncJobResponseTypeDef#
# CreateSyncJobResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateSyncJobResponseTypeDef
def get_value() -> CreateSyncJobResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"state": ...,
"ResponseMetadata": ...,
}
# CreateSyncJobResponseTypeDef definition
class CreateSyncJobResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
state: SyncJobStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspaceRequestRequestTypeDef#
# CreateWorkspaceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateWorkspaceRequestRequestTypeDef
def get_value() -> CreateWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
"s3Location": ...,
"role": ...,
}
# CreateWorkspaceRequestRequestTypeDef definition
class CreateWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
s3Location: str,
role: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateWorkspaceResponseTypeDef#
# CreateWorkspaceResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateWorkspaceResponseTypeDef
def get_value() -> CreateWorkspaceResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"ResponseMetadata": ...,
}
# CreateWorkspaceResponseTypeDef definition
class CreateWorkspaceResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
LambdaFunctionTypeDef#
# LambdaFunctionTypeDef 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 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 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],
DeleteComponentTypeRequestRequestTypeDef#
# DeleteComponentTypeRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteComponentTypeRequestRequestTypeDef
def get_value() -> DeleteComponentTypeRequestRequestTypeDef:
return {
"workspaceId": ...,
"componentTypeId": ...,
}
# DeleteComponentTypeRequestRequestTypeDef definition
class DeleteComponentTypeRequestRequestTypeDef(TypedDict):
workspaceId: str,
componentTypeId: str,
DeleteComponentTypeResponseTypeDef#
# DeleteComponentTypeResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteComponentTypeResponseTypeDef
def get_value() -> DeleteComponentTypeResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
# DeleteComponentTypeResponseTypeDef definition
class DeleteComponentTypeResponseTypeDef(TypedDict):
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
DeleteEntityRequestRequestTypeDef#
# DeleteEntityRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteEntityRequestRequestTypeDef
def get_value() -> DeleteEntityRequestRequestTypeDef:
return {
"workspaceId": ...,
"entityId": ...,
}
# DeleteEntityRequestRequestTypeDef definition
class DeleteEntityRequestRequestTypeDef(TypedDict):
workspaceId: str,
entityId: str,
isRecursive: NotRequired[bool],
DeleteEntityResponseTypeDef#
# DeleteEntityResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteEntityResponseTypeDef
def get_value() -> DeleteEntityResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
# DeleteEntityResponseTypeDef definition
class DeleteEntityResponseTypeDef(TypedDict):
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
DeleteSceneRequestRequestTypeDef#
# DeleteSceneRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteSceneRequestRequestTypeDef
def get_value() -> DeleteSceneRequestRequestTypeDef:
return {
"workspaceId": ...,
"sceneId": ...,
}
# DeleteSceneRequestRequestTypeDef definition
class DeleteSceneRequestRequestTypeDef(TypedDict):
workspaceId: str,
sceneId: str,
DeleteSyncJobRequestRequestTypeDef#
# DeleteSyncJobRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteSyncJobRequestRequestTypeDef
def get_value() -> DeleteSyncJobRequestRequestTypeDef:
return {
"workspaceId": ...,
"syncSource": ...,
}
# DeleteSyncJobRequestRequestTypeDef definition
class DeleteSyncJobRequestRequestTypeDef(TypedDict):
workspaceId: str,
syncSource: str,
DeleteSyncJobResponseTypeDef#
# DeleteSyncJobResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteSyncJobResponseTypeDef
def get_value() -> DeleteSyncJobResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
# DeleteSyncJobResponseTypeDef definition
class DeleteSyncJobResponseTypeDef(TypedDict):
state: SyncJobStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWorkspaceRequestRequestTypeDef#
# DeleteWorkspaceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import DeleteWorkspaceRequestRequestTypeDef
def get_value() -> DeleteWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# DeleteWorkspaceRequestRequestTypeDef definition
class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
EntityPropertyReferenceTypeDef#
# EntityPropertyReferenceTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import EntityPropertyReferenceTypeDef
def get_value() -> EntityPropertyReferenceTypeDef:
return {
"propertyName": ...,
}
# EntityPropertyReferenceTypeDef definition
class EntityPropertyReferenceTypeDef(TypedDict):
propertyName: str,
componentName: NotRequired[str],
externalIdProperty: NotRequired[Mapping[str, str]],
entityId: NotRequired[str],
ErrorDetailsTypeDef#
# ErrorDetailsTypeDef 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],
- See ErrorCodeType
ExecuteQueryRequestRequestTypeDef#
# ExecuteQueryRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ExecuteQueryRequestRequestTypeDef
def get_value() -> ExecuteQueryRequestRequestTypeDef:
return {
"workspaceId": ...,
"queryStatement": ...,
}
# ExecuteQueryRequestRequestTypeDef definition
class ExecuteQueryRequestRequestTypeDef(TypedDict):
workspaceId: str,
queryStatement: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
RowTypeDef#
# RowTypeDef 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]]],
GetComponentTypeRequestRequestTypeDef#
# GetComponentTypeRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetComponentTypeRequestRequestTypeDef
def get_value() -> GetComponentTypeRequestRequestTypeDef:
return {
"workspaceId": ...,
"componentTypeId": ...,
}
# GetComponentTypeRequestRequestTypeDef definition
class GetComponentTypeRequestRequestTypeDef(TypedDict):
workspaceId: str,
componentTypeId: str,
PropertyDefinitionResponseTypeDef#
# PropertyDefinitionResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyDefinitionResponseTypeDef
def get_value() -> PropertyDefinitionResponseTypeDef:
return {
"dataType": ...,
"isTimeSeries": ...,
"isRequiredInEntity": ...,
"isExternalId": ...,
"isStoredExternally": ...,
"isImported": ...,
"isFinal": ...,
"isInherited": ...,
}
# 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],
- See DataTypeTypeDef
- See DataValueTypeDef
PropertyGroupResponseTypeDef#
# PropertyGroupResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyGroupResponseTypeDef
def get_value() -> PropertyGroupResponseTypeDef:
return {
"groupType": ...,
"propertyNames": ...,
"isInherited": ...,
}
# PropertyGroupResponseTypeDef definition
class PropertyGroupResponseTypeDef(TypedDict):
groupType: GroupTypeType, # (1)
propertyNames: List[str],
isInherited: bool,
- See GroupTypeType
GetEntityRequestRequestTypeDef#
# GetEntityRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetEntityRequestRequestTypeDef
def get_value() -> GetEntityRequestRequestTypeDef:
return {
"workspaceId": ...,
"entityId": ...,
}
# GetEntityRequestRequestTypeDef definition
class GetEntityRequestRequestTypeDef(TypedDict):
workspaceId: str,
entityId: str,
InterpolationParametersTypeDef#
# InterpolationParametersTypeDef 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],
PropertyFilterTypeDef#
# PropertyFilterTypeDef 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[DataValueTypeDef], # (1)
- See DataValueTypeDef
GetSceneRequestRequestTypeDef#
# GetSceneRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetSceneRequestRequestTypeDef
def get_value() -> GetSceneRequestRequestTypeDef:
return {
"workspaceId": ...,
"sceneId": ...,
}
# GetSceneRequestRequestTypeDef definition
class GetSceneRequestRequestTypeDef(TypedDict):
workspaceId: str,
sceneId: str,
SceneErrorTypeDef#
# SceneErrorTypeDef 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],
GetSyncJobRequestRequestTypeDef#
# GetSyncJobRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetSyncJobRequestRequestTypeDef
def get_value() -> GetSyncJobRequestRequestTypeDef:
return {
"syncSource": ...,
}
# GetSyncJobRequestRequestTypeDef definition
class GetSyncJobRequestRequestTypeDef(TypedDict):
syncSource: str,
workspaceId: NotRequired[str],
GetWorkspaceRequestRequestTypeDef#
# GetWorkspaceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetWorkspaceRequestRequestTypeDef
def get_value() -> GetWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# GetWorkspaceRequestRequestTypeDef definition
class GetWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
GetWorkspaceResponseTypeDef#
# GetWorkspaceResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetWorkspaceResponseTypeDef
def get_value() -> GetWorkspaceResponseTypeDef:
return {
"workspaceId": ...,
"arn": ...,
"description": ...,
"s3Location": ...,
"role": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"ResponseMetadata": ...,
}
# GetWorkspaceResponseTypeDef definition
class GetWorkspaceResponseTypeDef(TypedDict):
workspaceId: str,
arn: str,
description: str,
s3Location: str,
role: str,
creationDateTime: datetime,
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListComponentTypesFilterTypeDef#
# ListComponentTypesFilterTypeDef 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],
ListEntitiesFilterTypeDef#
# ListEntitiesFilterTypeDef 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],
ListScenesRequestRequestTypeDef#
# ListScenesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListScenesRequestRequestTypeDef
def get_value() -> ListScenesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# ListScenesRequestRequestTypeDef definition
class ListScenesRequestRequestTypeDef(TypedDict):
workspaceId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SceneSummaryTypeDef#
# SceneSummaryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import SceneSummaryTypeDef
def get_value() -> SceneSummaryTypeDef:
return {
"sceneId": ...,
"contentLocation": ...,
"arn": ...,
"creationDateTime": ...,
"updateDateTime": ...,
}
# SceneSummaryTypeDef definition
class SceneSummaryTypeDef(TypedDict):
sceneId: str,
contentLocation: str,
arn: str,
creationDateTime: datetime,
updateDateTime: datetime,
description: NotRequired[str],
ListSyncJobsRequestRequestTypeDef#
# ListSyncJobsRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListSyncJobsRequestRequestTypeDef
def get_value() -> ListSyncJobsRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# ListSyncJobsRequestRequestTypeDef definition
class ListSyncJobsRequestRequestTypeDef(TypedDict):
workspaceId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SyncResourceFilterTypeDef#
# SyncResourceFilterTypeDef 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],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListWorkspacesRequestRequestTypeDef#
# ListWorkspacesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListWorkspacesRequestRequestTypeDef
def get_value() -> ListWorkspacesRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListWorkspacesRequestRequestTypeDef definition
class ListWorkspacesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
WorkspaceSummaryTypeDef#
# WorkspaceSummaryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import WorkspaceSummaryTypeDef
def get_value() -> WorkspaceSummaryTypeDef:
return {
"workspaceId": ...,
"arn": ...,
"creationDateTime": ...,
"updateDateTime": ...,
}
# WorkspaceSummaryTypeDef definition
class WorkspaceSummaryTypeDef(TypedDict):
workspaceId: str,
arn: str,
creationDateTime: datetime,
updateDateTime: datetime,
description: NotRequired[str],
OrderByTypeDef#
# OrderByTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import OrderByTypeDef
def get_value() -> OrderByTypeDef:
return {
"propertyName": ...,
}
# OrderByTypeDef definition
class OrderByTypeDef(TypedDict):
propertyName: str,
order: NotRequired[OrderType], # (1)
- See OrderType
ParentEntityUpdateRequestTypeDef#
# ParentEntityUpdateRequestTypeDef 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],
PropertyValueTypeDef#
# PropertyValueTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyValueTypeDef
def get_value() -> PropertyValueTypeDef:
return {
"value": ...,
}
# PropertyValueTypeDef definition
class PropertyValueTypeDef(TypedDict):
value: DataValueTypeDef, # (1)
timestamp: NotRequired[Union[datetime, str]],
time: NotRequired[str],
- See DataValueTypeDef
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateComponentTypeResponseTypeDef#
# UpdateComponentTypeResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateComponentTypeResponseTypeDef
def get_value() -> UpdateComponentTypeResponseTypeDef:
return {
"workspaceId": ...,
"arn": ...,
"componentTypeId": ...,
"state": ...,
"ResponseMetadata": ...,
}
# UpdateComponentTypeResponseTypeDef definition
class UpdateComponentTypeResponseTypeDef(TypedDict):
workspaceId: str,
arn: str,
componentTypeId: str,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
UpdateEntityResponseTypeDef#
# UpdateEntityResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateEntityResponseTypeDef
def get_value() -> UpdateEntityResponseTypeDef:
return {
"updateDateTime": ...,
"state": ...,
"ResponseMetadata": ...,
}
# UpdateEntityResponseTypeDef definition
class UpdateEntityResponseTypeDef(TypedDict):
updateDateTime: datetime,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
UpdatePricingPlanRequestRequestTypeDef#
# UpdatePricingPlanRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdatePricingPlanRequestRequestTypeDef
def get_value() -> UpdatePricingPlanRequestRequestTypeDef:
return {
"pricingMode": ...,
}
# UpdatePricingPlanRequestRequestTypeDef definition
class UpdatePricingPlanRequestRequestTypeDef(TypedDict):
pricingMode: PricingModeType, # (1)
bundleNames: NotRequired[Sequence[str]],
- See PricingModeType
UpdateSceneRequestRequestTypeDef#
# UpdateSceneRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateSceneRequestRequestTypeDef
def get_value() -> UpdateSceneRequestRequestTypeDef:
return {
"workspaceId": ...,
"sceneId": ...,
}
# UpdateSceneRequestRequestTypeDef definition
class UpdateSceneRequestRequestTypeDef(TypedDict):
workspaceId: str,
sceneId: str,
contentLocation: NotRequired[str],
description: NotRequired[str],
capabilities: NotRequired[Sequence[str]],
sceneMetadata: NotRequired[Mapping[str, str]],
UpdateSceneResponseTypeDef#
# UpdateSceneResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateSceneResponseTypeDef
def get_value() -> UpdateSceneResponseTypeDef:
return {
"updateDateTime": ...,
"ResponseMetadata": ...,
}
# UpdateSceneResponseTypeDef definition
class UpdateSceneResponseTypeDef(TypedDict):
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateWorkspaceRequestRequestTypeDef#
# UpdateWorkspaceRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateWorkspaceRequestRequestTypeDef
def get_value() -> UpdateWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# UpdateWorkspaceRequestRequestTypeDef definition
class UpdateWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
description: NotRequired[str],
role: NotRequired[str],
UpdateWorkspaceResponseTypeDef#
# UpdateWorkspaceResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateWorkspaceResponseTypeDef
def get_value() -> UpdateWorkspaceResponseTypeDef:
return {
"updateDateTime": ...,
"ResponseMetadata": ...,
}
# UpdateWorkspaceResponseTypeDef definition
class UpdateWorkspaceResponseTypeDef(TypedDict):
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PricingPlanTypeDef#
# PricingPlanTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PricingPlanTypeDef
def get_value() -> PricingPlanTypeDef:
return {
"effectiveDateTime": ...,
"pricingMode": ...,
"updateDateTime": ...,
"updateReason": ...,
}
# PricingPlanTypeDef definition
class PricingPlanTypeDef(TypedDict):
effectiveDateTime: datetime,
pricingMode: PricingModeType, # (2)
updateDateTime: datetime,
updateReason: UpdateReasonType, # (3)
billableEntityCount: NotRequired[int],
bundleInformation: NotRequired[BundleInformationTypeDef], # (1)
- See BundleInformationTypeDef
- See PricingModeType
- See UpdateReasonType
PropertyRequestTypeDef#
# PropertyRequestTypeDef 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[DataValueTypeDef], # (2)
updateType: NotRequired[PropertyUpdateTypeType], # (3)
DataConnectorTypeDef#
# DataConnectorTypeDef 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],
DataTypeTypeDef#
# DataTypeTypeDef 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[DataTypeTypeDef], # (2)
allowedValues: NotRequired[Sequence[DataValueTypeDef]], # (3)
unitOfMeasure: NotRequired[str],
relationship: NotRequired[RelationshipTypeDef], # (4)
- See TypeType
- See DataTypeTypeDef
- See DataValueTypeDef
- See RelationshipTypeDef
DataValueTypeDef#
# DataValueTypeDef 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[DataValueTypeDef]], # (1)
mapValue: NotRequired[Mapping[str, DataValueTypeDef]], # (2)
relationshipValue: NotRequired[RelationshipValueTypeDef], # (3)
expression: NotRequired[str],
- See DataValueTypeDef
- See DataValueTypeDef
- See RelationshipValueTypeDef
PropertyLatestValueTypeDef#
# PropertyLatestValueTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyLatestValueTypeDef
def get_value() -> PropertyLatestValueTypeDef:
return {
"propertyReference": ...,
}
# PropertyLatestValueTypeDef definition
class PropertyLatestValueTypeDef(TypedDict):
propertyReference: EntityPropertyReferenceTypeDef, # (1)
propertyValue: NotRequired[DataValueTypeDef], # (2)
StatusTypeDef#
# StatusTypeDef 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)
- See StateType
- See ErrorDetailsTypeDef
SyncJobStatusTypeDef#
# SyncJobStatusTypeDef 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)
- See SyncJobStateType
- See ErrorDetailsTypeDef
SyncResourceStatusTypeDef#
# SyncResourceStatusTypeDef 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)
ExecuteQueryResponseTypeDef#
# ExecuteQueryResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ExecuteQueryResponseTypeDef
def get_value() -> ExecuteQueryResponseTypeDef:
return {
"columnDescriptions": ...,
"rows": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ExecuteQueryResponseTypeDef definition
class ExecuteQueryResponseTypeDef(TypedDict):
columnDescriptions: List[ColumnDescriptionTypeDef], # (1)
rows: List[RowTypeDef], # (2)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PropertyResponseTypeDef#
# PropertyResponseTypeDef 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[DataValueTypeDef], # (2)
GetPropertyValueHistoryRequestRequestTypeDef#
# GetPropertyValueHistoryRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueHistoryRequestRequestTypeDef
def get_value() -> GetPropertyValueHistoryRequestRequestTypeDef:
return {
"workspaceId": ...,
"selectedProperties": ...,
}
# 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],
GetSceneResponseTypeDef#
# GetSceneResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetSceneResponseTypeDef
def get_value() -> GetSceneResponseTypeDef:
return {
"workspaceId": ...,
"sceneId": ...,
"contentLocation": ...,
"arn": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"description": ...,
"capabilities": ...,
"sceneMetadata": ...,
"generatedSceneMetadata": ...,
"error": ...,
"ResponseMetadata": ...,
}
# 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)
ListComponentTypesRequestRequestTypeDef#
# ListComponentTypesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListComponentTypesRequestRequestTypeDef
def get_value() -> ListComponentTypesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# ListComponentTypesRequestRequestTypeDef definition
class ListComponentTypesRequestRequestTypeDef(TypedDict):
workspaceId: str,
filters: NotRequired[Sequence[ListComponentTypesFilterTypeDef]], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListEntitiesRequestRequestTypeDef#
# ListEntitiesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListEntitiesRequestRequestTypeDef
def get_value() -> ListEntitiesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
# ListEntitiesRequestRequestTypeDef definition
class ListEntitiesRequestRequestTypeDef(TypedDict):
workspaceId: str,
filters: NotRequired[Sequence[ListEntitiesFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListScenesResponseTypeDef#
# ListScenesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListScenesResponseTypeDef
def get_value() -> ListScenesResponseTypeDef:
return {
"sceneSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListScenesResponseTypeDef definition
class ListScenesResponseTypeDef(TypedDict):
sceneSummaries: List[SceneSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSyncResourcesRequestRequestTypeDef#
# ListSyncResourcesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListSyncResourcesRequestRequestTypeDef
def get_value() -> ListSyncResourcesRequestRequestTypeDef:
return {
"workspaceId": ...,
"syncSource": ...,
}
# ListSyncResourcesRequestRequestTypeDef definition
class ListSyncResourcesRequestRequestTypeDef(TypedDict):
workspaceId: str,
syncSource: str,
filters: NotRequired[Sequence[SyncResourceFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListWorkspacesResponseTypeDef#
# ListWorkspacesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListWorkspacesResponseTypeDef
def get_value() -> ListWorkspacesResponseTypeDef:
return {
"workspaceSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListWorkspacesResponseTypeDef definition
class ListWorkspacesResponseTypeDef(TypedDict):
workspaceSummaries: List[WorkspaceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TabularConditionsTypeDef#
# TabularConditionsTypeDef 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)
- See OrderByTypeDef
- See PropertyFilterTypeDef
PropertyValueEntryTypeDef#
# PropertyValueEntryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyValueEntryTypeDef
def get_value() -> PropertyValueEntryTypeDef:
return {
"entityPropertyReference": ...,
}
# PropertyValueEntryTypeDef definition
class PropertyValueEntryTypeDef(TypedDict):
entityPropertyReference: EntityPropertyReferenceTypeDef, # (1)
propertyValues: NotRequired[Sequence[PropertyValueTypeDef]], # (2)
PropertyValueHistoryTypeDef#
# PropertyValueHistoryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import PropertyValueHistoryTypeDef
def get_value() -> PropertyValueHistoryTypeDef:
return {
"entityPropertyReference": ...,
}
# PropertyValueHistoryTypeDef definition
class PropertyValueHistoryTypeDef(TypedDict):
entityPropertyReference: EntityPropertyReferenceTypeDef, # (1)
values: NotRequired[List[PropertyValueTypeDef]], # (2)
GetPricingPlanResponseTypeDef#
# GetPricingPlanResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetPricingPlanResponseTypeDef
def get_value() -> GetPricingPlanResponseTypeDef:
return {
"currentPricingPlan": ...,
"pendingPricingPlan": ...,
"ResponseMetadata": ...,
}
# GetPricingPlanResponseTypeDef definition
class GetPricingPlanResponseTypeDef(TypedDict):
currentPricingPlan: PricingPlanTypeDef, # (1)
pendingPricingPlan: PricingPlanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdatePricingPlanResponseTypeDef#
# UpdatePricingPlanResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdatePricingPlanResponseTypeDef
def get_value() -> UpdatePricingPlanResponseTypeDef:
return {
"currentPricingPlan": ...,
"pendingPricingPlan": ...,
"ResponseMetadata": ...,
}
# UpdatePricingPlanResponseTypeDef definition
class UpdatePricingPlanResponseTypeDef(TypedDict):
currentPricingPlan: PricingPlanTypeDef, # (1)
pendingPricingPlan: PricingPlanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ComponentRequestTypeDef#
# ComponentRequestTypeDef 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)
ComponentUpdateRequestTypeDef#
# ComponentUpdateRequestTypeDef 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)
FunctionRequestTypeDef#
# FunctionRequestTypeDef 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)
- See ScopeType
- See DataConnectorTypeDef
FunctionResponseTypeDef#
# FunctionResponseTypeDef 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],
- See ScopeType
- See DataConnectorTypeDef
GetPropertyValueResponseTypeDef#
# GetPropertyValueResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueResponseTypeDef
def get_value() -> GetPropertyValueResponseTypeDef:
return {
"propertyValues": ...,
"nextToken": ...,
"tabularPropertyValues": ...,
"ResponseMetadata": ...,
}
# GetPropertyValueResponseTypeDef definition
class GetPropertyValueResponseTypeDef(TypedDict):
propertyValues: Dict[str, PropertyLatestValueTypeDef], # (1)
nextToken: str,
tabularPropertyValues: List[List[Dict[str, DataValueTypeDef]]], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ComponentTypeSummaryTypeDef#
# ComponentTypeSummaryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ComponentTypeSummaryTypeDef
def get_value() -> ComponentTypeSummaryTypeDef:
return {
"arn": ...,
"componentTypeId": ...,
"creationDateTime": ...,
"updateDateTime": ...,
}
# ComponentTypeSummaryTypeDef definition
class ComponentTypeSummaryTypeDef(TypedDict):
arn: str,
componentTypeId: str,
creationDateTime: datetime,
updateDateTime: datetime,
description: NotRequired[str],
status: NotRequired[StatusTypeDef], # (1)
componentTypeName: NotRequired[str],
- See StatusTypeDef
EntitySummaryTypeDef#
# EntitySummaryTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import EntitySummaryTypeDef
def get_value() -> EntitySummaryTypeDef:
return {
"entityId": ...,
"entityName": ...,
"arn": ...,
"status": ...,
"creationDateTime": ...,
"updateDateTime": ...,
}
# 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],
- See StatusTypeDef
GetSyncJobResponseTypeDef#
# GetSyncJobResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetSyncJobResponseTypeDef
def get_value() -> GetSyncJobResponseTypeDef:
return {
"arn": ...,
"workspaceId": ...,
"syncSource": ...,
"syncRole": ...,
"status": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"ResponseMetadata": ...,
}
# GetSyncJobResponseTypeDef definition
class GetSyncJobResponseTypeDef(TypedDict):
arn: str,
workspaceId: str,
syncSource: str,
syncRole: str,
status: SyncJobStatusTypeDef, # (1)
creationDateTime: datetime,
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SyncJobSummaryTypeDef#
# SyncJobSummaryTypeDef 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],
updateDateTime: NotRequired[datetime],
SyncResourceSummaryTypeDef#
# SyncResourceSummaryTypeDef 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],
ComponentResponseTypeDef#
# ComponentResponseTypeDef 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],
GetPropertyValueRequestRequestTypeDef#
# GetPropertyValueRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueRequestRequestTypeDef
def get_value() -> GetPropertyValueRequestRequestTypeDef:
return {
"selectedProperties": ...,
"workspaceId": ...,
}
# 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)
BatchPutPropertyErrorTypeDef#
# BatchPutPropertyErrorTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyErrorTypeDef
def get_value() -> BatchPutPropertyErrorTypeDef:
return {
"errorCode": ...,
"errorMessage": ...,
"entry": ...,
}
# BatchPutPropertyErrorTypeDef definition
class BatchPutPropertyErrorTypeDef(TypedDict):
errorCode: str,
errorMessage: str,
entry: PropertyValueEntryTypeDef, # (1)
BatchPutPropertyValuesRequestRequestTypeDef#
# BatchPutPropertyValuesRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyValuesRequestRequestTypeDef
def get_value() -> BatchPutPropertyValuesRequestRequestTypeDef:
return {
"workspaceId": ...,
"entries": ...,
}
# BatchPutPropertyValuesRequestRequestTypeDef definition
class BatchPutPropertyValuesRequestRequestTypeDef(TypedDict):
workspaceId: str,
entries: Sequence[PropertyValueEntryTypeDef], # (1)
GetPropertyValueHistoryResponseTypeDef#
# GetPropertyValueHistoryResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetPropertyValueHistoryResponseTypeDef
def get_value() -> GetPropertyValueHistoryResponseTypeDef:
return {
"propertyValues": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# GetPropertyValueHistoryResponseTypeDef definition
class GetPropertyValueHistoryResponseTypeDef(TypedDict):
propertyValues: List[PropertyValueHistoryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateEntityRequestRequestTypeDef#
# CreateEntityRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateEntityRequestRequestTypeDef
def get_value() -> CreateEntityRequestRequestTypeDef:
return {
"workspaceId": ...,
"entityName": ...,
}
# 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]],
UpdateEntityRequestRequestTypeDef#
# UpdateEntityRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateEntityRequestRequestTypeDef
def get_value() -> UpdateEntityRequestRequestTypeDef:
return {
"workspaceId": ...,
"entityId": ...,
}
# 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)
CreateComponentTypeRequestRequestTypeDef#
# CreateComponentTypeRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import CreateComponentTypeRequestRequestTypeDef
def get_value() -> CreateComponentTypeRequestRequestTypeDef:
return {
"workspaceId": ...,
"componentTypeId": ...,
}
# 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],
UpdateComponentTypeRequestRequestTypeDef#
# UpdateComponentTypeRequestRequestTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import UpdateComponentTypeRequestRequestTypeDef
def get_value() -> UpdateComponentTypeRequestRequestTypeDef:
return {
"workspaceId": ...,
"componentTypeId": ...,
}
# 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],
GetComponentTypeResponseTypeDef#
# GetComponentTypeResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetComponentTypeResponseTypeDef
def get_value() -> GetComponentTypeResponseTypeDef:
return {
"workspaceId": ...,
"isSingleton": ...,
"componentTypeId": ...,
"description": ...,
"propertyDefinitions": ...,
"extendsFrom": ...,
"functions": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"arn": ...,
"isAbstract": ...,
"isSchemaInitialized": ...,
"status": ...,
"propertyGroups": ...,
"syncSource": ...,
"componentTypeName": ...,
"ResponseMetadata": ...,
}
# 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)
- See PropertyDefinitionResponseTypeDef
- See FunctionResponseTypeDef
- See StatusTypeDef
- See PropertyGroupResponseTypeDef
- See ResponseMetadataTypeDef
ListComponentTypesResponseTypeDef#
# ListComponentTypesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListComponentTypesResponseTypeDef
def get_value() -> ListComponentTypesResponseTypeDef:
return {
"workspaceId": ...,
"componentTypeSummaries": ...,
"nextToken": ...,
"maxResults": ...,
"ResponseMetadata": ...,
}
# ListComponentTypesResponseTypeDef definition
class ListComponentTypesResponseTypeDef(TypedDict):
workspaceId: str,
componentTypeSummaries: List[ComponentTypeSummaryTypeDef], # (1)
nextToken: str,
maxResults: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEntitiesResponseTypeDef#
# ListEntitiesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListEntitiesResponseTypeDef
def get_value() -> ListEntitiesResponseTypeDef:
return {
"entitySummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListEntitiesResponseTypeDef definition
class ListEntitiesResponseTypeDef(TypedDict):
entitySummaries: List[EntitySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSyncJobsResponseTypeDef#
# ListSyncJobsResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListSyncJobsResponseTypeDef
def get_value() -> ListSyncJobsResponseTypeDef:
return {
"syncJobSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListSyncJobsResponseTypeDef definition
class ListSyncJobsResponseTypeDef(TypedDict):
syncJobSummaries: List[SyncJobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSyncResourcesResponseTypeDef#
# ListSyncResourcesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import ListSyncResourcesResponseTypeDef
def get_value() -> ListSyncResourcesResponseTypeDef:
return {
"syncResources": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListSyncResourcesResponseTypeDef definition
class ListSyncResourcesResponseTypeDef(TypedDict):
syncResources: List[SyncResourceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEntityResponseTypeDef#
# GetEntityResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import GetEntityResponseTypeDef
def get_value() -> GetEntityResponseTypeDef:
return {
"entityId": ...,
"entityName": ...,
"arn": ...,
"status": ...,
"workspaceId": ...,
"description": ...,
"components": ...,
"parentEntityId": ...,
"hasChildEntities": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"syncSource": ...,
"ResponseMetadata": ...,
}
# 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)
BatchPutPropertyErrorEntryTypeDef#
# BatchPutPropertyErrorEntryTypeDef 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)
BatchPutPropertyValuesResponseTypeDef#
# BatchPutPropertyValuesResponseTypeDef usage example
from mypy_boto3_iottwinmaker.type_defs import BatchPutPropertyValuesResponseTypeDef
def get_value() -> BatchPutPropertyValuesResponseTypeDef:
return {
"errorEntries": ...,
"ResponseMetadata": ...,
}
# BatchPutPropertyValuesResponseTypeDef definition
class BatchPutPropertyValuesResponseTypeDef(TypedDict):
errorEntries: List[BatchPutPropertyErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)