Typed dictionaries
Index > IoTTwinMaker > Typed dictionaries
Auto-generated documentation for IoTTwinMaker type annotations stubs module types-aiobotocore-iottwinmaker.
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
PropertyDefinitionRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyDefinitionRequestTypeDef
def get_value() -> PropertyDefinitionRequestTypeDef:
return {
"configuration": ...,
}
Definition
class PropertyDefinitionRequestTypeDef(TypedDict):
configuration: NotRequired[Mapping[str, str]],
dataType: NotRequired[DataTypeTypeDef], # (1)
defaultValue: NotRequired[DataValueTypeDef], # (2)
isExternalId: NotRequired[bool],
isRequiredInEntity: NotRequired[bool],
isStoredExternally: NotRequired[bool],
isTimeSeries: NotRequired[bool],
- See DataTypeTypeDef
- See DataValueTypeDef
CreateSceneRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateSceneRequestRequestTypeDef
def get_value() -> CreateSceneRequestRequestTypeDef:
return {
"contentLocation": ...,
"sceneId": ...,
"workspaceId": ...,
}
Definition
class CreateSceneRequestRequestTypeDef(TypedDict):
contentLocation: str,
sceneId: str,
workspaceId: str,
capabilities: NotRequired[Sequence[str]],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateWorkspaceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateWorkspaceRequestRequestTypeDef
def get_value() -> CreateWorkspaceRequestRequestTypeDef:
return {
"role": ...,
"s3Location": ...,
"workspaceId": ...,
}
Definition
class CreateWorkspaceRequestRequestTypeDef(TypedDict):
role: str,
s3Location: str,
workspaceId: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
LambdaFunctionTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import LambdaFunctionTypeDef
def get_value() -> LambdaFunctionTypeDef:
return {
"arn": ...,
}
RelationshipTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import RelationshipTypeDef
def get_value() -> RelationshipTypeDef:
return {
"relationshipType": ...,
}
Definition
class RelationshipTypeDef(TypedDict):
relationshipType: NotRequired[str],
targetComponentTypeId: NotRequired[str],
RelationshipValueTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import RelationshipValueTypeDef
def get_value() -> RelationshipValueTypeDef:
return {
"targetComponentName": ...,
}
Definition
class RelationshipValueTypeDef(TypedDict):
targetComponentName: NotRequired[str],
targetEntityId: NotRequired[str],
DeleteComponentTypeRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteComponentTypeRequestRequestTypeDef
def get_value() -> DeleteComponentTypeRequestRequestTypeDef:
return {
"componentTypeId": ...,
"workspaceId": ...,
}
Definition
class DeleteComponentTypeRequestRequestTypeDef(TypedDict):
componentTypeId: str,
workspaceId: str,
DeleteEntityRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteEntityRequestRequestTypeDef
def get_value() -> DeleteEntityRequestRequestTypeDef:
return {
"entityId": ...,
"workspaceId": ...,
}
Definition
class DeleteEntityRequestRequestTypeDef(TypedDict):
entityId: str,
workspaceId: str,
isRecursive: NotRequired[bool],
DeleteSceneRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteSceneRequestRequestTypeDef
def get_value() -> DeleteSceneRequestRequestTypeDef:
return {
"sceneId": ...,
"workspaceId": ...,
}
DeleteWorkspaceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteWorkspaceRequestRequestTypeDef
def get_value() -> DeleteWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
EntityPropertyReferenceTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import EntityPropertyReferenceTypeDef
def get_value() -> EntityPropertyReferenceTypeDef:
return {
"propertyName": ...,
}
Definition
class EntityPropertyReferenceTypeDef(TypedDict):
propertyName: str,
componentName: NotRequired[str],
entityId: NotRequired[str],
externalIdProperty: NotRequired[Mapping[str, str]],
ErrorDetailsTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ErrorDetailsTypeDef
def get_value() -> ErrorDetailsTypeDef:
return {
"code": ...,
}
Definition
class ErrorDetailsTypeDef(TypedDict):
code: NotRequired[ErrorCodeType], # (1)
message: NotRequired[str],
- See ErrorCodeType
GetComponentTypeRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetComponentTypeRequestRequestTypeDef
def get_value() -> GetComponentTypeRequestRequestTypeDef:
return {
"componentTypeId": ...,
"workspaceId": ...,
}
Definition
class GetComponentTypeRequestRequestTypeDef(TypedDict):
componentTypeId: str,
workspaceId: str,
PropertyDefinitionResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyDefinitionResponseTypeDef
def get_value() -> PropertyDefinitionResponseTypeDef:
return {
"dataType": ...,
"isExternalId": ...,
"isFinal": ...,
"isImported": ...,
"isInherited": ...,
"isRequiredInEntity": ...,
"isStoredExternally": ...,
"isTimeSeries": ...,
}
Definition
class PropertyDefinitionResponseTypeDef(TypedDict):
dataType: DataTypeTypeDef, # (1)
isExternalId: bool,
isFinal: bool,
isImported: bool,
isInherited: bool,
isRequiredInEntity: bool,
isStoredExternally: bool,
isTimeSeries: bool,
configuration: NotRequired[Dict[str, str]],
defaultValue: NotRequired[DataValueTypeDef], # (2)
- See DataTypeTypeDef
- See DataValueTypeDef
GetEntityRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetEntityRequestRequestTypeDef
def get_value() -> GetEntityRequestRequestTypeDef:
return {
"entityId": ...,
"workspaceId": ...,
}
InterpolationParametersTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import InterpolationParametersTypeDef
def get_value() -> InterpolationParametersTypeDef:
return {
"interpolationType": ...,
}
Definition
class InterpolationParametersTypeDef(TypedDict):
interpolationType: NotRequired[InterpolationTypeType], # (1)
intervalInSeconds: NotRequired[int],
PropertyFilterTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyFilterTypeDef
def get_value() -> PropertyFilterTypeDef:
return {
"operator": ...,
}
Definition
class PropertyFilterTypeDef(TypedDict):
operator: NotRequired[str],
propertyName: NotRequired[str],
value: NotRequired[DataValueTypeDef], # (1)
- See DataValueTypeDef
GetPropertyValueRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetPropertyValueRequestRequestTypeDef
def get_value() -> GetPropertyValueRequestRequestTypeDef:
return {
"selectedProperties": ...,
"workspaceId": ...,
}
Definition
class GetPropertyValueRequestRequestTypeDef(TypedDict):
selectedProperties: Sequence[str],
workspaceId: str,
componentName: NotRequired[str],
componentTypeId: NotRequired[str],
entityId: NotRequired[str],
GetSceneRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetSceneRequestRequestTypeDef
def get_value() -> GetSceneRequestRequestTypeDef:
return {
"sceneId": ...,
"workspaceId": ...,
}
GetWorkspaceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetWorkspaceRequestRequestTypeDef
def get_value() -> GetWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
ListComponentTypesFilterTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListComponentTypesFilterTypeDef
def get_value() -> ListComponentTypesFilterTypeDef:
return {
"extendsFrom": ...,
}
Definition
class ListComponentTypesFilterTypeDef(TypedDict):
extendsFrom: NotRequired[str],
isAbstract: NotRequired[bool],
namespace: NotRequired[str],
ListEntitiesFilterTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListEntitiesFilterTypeDef
def get_value() -> ListEntitiesFilterTypeDef:
return {
"componentTypeId": ...,
}
Definition
class ListEntitiesFilterTypeDef(TypedDict):
componentTypeId: NotRequired[str],
externalId: NotRequired[str],
parentEntityId: NotRequired[str],
ListScenesRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListScenesRequestRequestTypeDef
def get_value() -> ListScenesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
Definition
class ListScenesRequestRequestTypeDef(TypedDict):
workspaceId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SceneSummaryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import SceneSummaryTypeDef
def get_value() -> SceneSummaryTypeDef:
return {
"arn": ...,
"contentLocation": ...,
"creationDateTime": ...,
"sceneId": ...,
"updateDateTime": ...,
}
Definition
class SceneSummaryTypeDef(TypedDict):
arn: str,
contentLocation: str,
creationDateTime: datetime,
sceneId: str,
updateDateTime: datetime,
description: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListWorkspacesRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListWorkspacesRequestRequestTypeDef
def get_value() -> ListWorkspacesRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListWorkspacesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
WorkspaceSummaryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import WorkspaceSummaryTypeDef
def get_value() -> WorkspaceSummaryTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"updateDateTime": ...,
"workspaceId": ...,
}
Definition
class WorkspaceSummaryTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
updateDateTime: datetime,
workspaceId: str,
description: NotRequired[str],
ParentEntityUpdateRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ParentEntityUpdateRequestTypeDef
def get_value() -> ParentEntityUpdateRequestTypeDef:
return {
"updateType": ...,
}
Definition
class ParentEntityUpdateRequestTypeDef(TypedDict):
updateType: ParentEntityUpdateTypeType, # (1)
parentEntityId: NotRequired[str],
PropertyValueTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyValueTypeDef
def get_value() -> PropertyValueTypeDef:
return {
"value": ...,
}
Definition
class PropertyValueTypeDef(TypedDict):
value: DataValueTypeDef, # (1)
time: NotRequired[str],
timestamp: NotRequired[Union[datetime, str]],
- See DataValueTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceARN": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateSceneRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateSceneRequestRequestTypeDef
def get_value() -> UpdateSceneRequestRequestTypeDef:
return {
"sceneId": ...,
"workspaceId": ...,
}
Definition
class UpdateSceneRequestRequestTypeDef(TypedDict):
sceneId: str,
workspaceId: str,
capabilities: NotRequired[Sequence[str]],
contentLocation: NotRequired[str],
description: NotRequired[str],
UpdateWorkspaceRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateWorkspaceRequestRequestTypeDef
def get_value() -> UpdateWorkspaceRequestRequestTypeDef:
return {
"workspaceId": ...,
}
Definition
class UpdateWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
description: NotRequired[str],
role: NotRequired[str],
CreateComponentTypeResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateComponentTypeResponseTypeDef
def get_value() -> CreateComponentTypeResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"state": ...,
"ResponseMetadata": ...,
}
Definition
class CreateComponentTypeResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
CreateEntityResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateEntityResponseTypeDef
def get_value() -> CreateEntityResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"entityId": ...,
"state": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEntityResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
entityId: str,
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
CreateSceneResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateSceneResponseTypeDef
def get_value() -> CreateSceneResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSceneResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWorkspaceResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateWorkspaceResponseTypeDef
def get_value() -> CreateWorkspaceResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWorkspaceResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteComponentTypeResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteComponentTypeResponseTypeDef
def get_value() -> DeleteComponentTypeResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteComponentTypeResponseTypeDef(TypedDict):
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
DeleteEntityResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DeleteEntityResponseTypeDef
def get_value() -> DeleteEntityResponseTypeDef:
return {
"state": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteEntityResponseTypeDef(TypedDict):
state: StateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
GetSceneResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetSceneResponseTypeDef
def get_value() -> GetSceneResponseTypeDef:
return {
"arn": ...,
"capabilities": ...,
"contentLocation": ...,
"creationDateTime": ...,
"description": ...,
"sceneId": ...,
"updateDateTime": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class GetSceneResponseTypeDef(TypedDict):
arn: str,
capabilities: List[str],
contentLocation: str,
creationDateTime: datetime,
description: str,
sceneId: str,
updateDateTime: datetime,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetWorkspaceResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetWorkspaceResponseTypeDef
def get_value() -> GetWorkspaceResponseTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"description": ...,
"role": ...,
"s3Location": ...,
"updateDateTime": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class GetWorkspaceResponseTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
description: str,
role: str,
s3Location: str,
updateDateTime: datetime,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"nextToken": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
nextToken: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateComponentTypeResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateComponentTypeResponseTypeDef
def get_value() -> UpdateComponentTypeResponseTypeDef:
return {
"arn": ...,
"componentTypeId": ...,
"state": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateComponentTypeResponseTypeDef(TypedDict):
arn: str,
componentTypeId: str,
state: StateType, # (1)
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
UpdateEntityResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateEntityResponseTypeDef
def get_value() -> UpdateEntityResponseTypeDef:
return {
"state": ...,
"updateDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateEntityResponseTypeDef(TypedDict):
state: StateType, # (1)
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StateType
- See ResponseMetadataTypeDef
UpdateSceneResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateSceneResponseTypeDef
def get_value() -> UpdateSceneResponseTypeDef:
return {
"updateDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateSceneResponseTypeDef(TypedDict):
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateWorkspaceResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateWorkspaceResponseTypeDef
def get_value() -> UpdateWorkspaceResponseTypeDef:
return {
"updateDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateWorkspaceResponseTypeDef(TypedDict):
updateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PropertyRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyRequestTypeDef
def get_value() -> PropertyRequestTypeDef:
return {
"definition": ...,
}
Definition
class PropertyRequestTypeDef(TypedDict):
definition: NotRequired[PropertyDefinitionRequestTypeDef], # (1)
updateType: NotRequired[PropertyUpdateTypeType], # (2)
value: NotRequired[DataValueTypeDef], # (3)
DataConnectorTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DataConnectorTypeDef
def get_value() -> DataConnectorTypeDef:
return {
"isNative": ...,
}
Definition
class DataConnectorTypeDef(TypedDict):
isNative: NotRequired[bool],
lambda: NotRequired[LambdaFunctionTypeDef], # (1)
DataTypeTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DataTypeTypeDef
def get_value() -> DataTypeTypeDef:
return {
"type": ...,
}
Definition
class DataTypeTypeDef(TypedDict):
type: TypeType, # (4)
allowedValues: NotRequired[Sequence[DataValueTypeDef]], # (1)
nestedType: NotRequired[DataTypeTypeDef], # (2)
relationship: NotRequired[RelationshipTypeDef], # (3)
unitOfMeasure: NotRequired[str],
- See DataValueTypeDef
- See DataTypeTypeDef
- See RelationshipTypeDef
- See TypeType
DataValueTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import DataValueTypeDef
def get_value() -> DataValueTypeDef:
return {
"booleanValue": ...,
}
Definition
class DataValueTypeDef(TypedDict):
booleanValue: NotRequired[bool],
doubleValue: NotRequired[float],
expression: NotRequired[str],
integerValue: NotRequired[int],
listValue: NotRequired[Sequence[DataValueTypeDef]], # (1)
longValue: NotRequired[int],
mapValue: NotRequired[Mapping[str, DataValueTypeDef]], # (2)
relationshipValue: NotRequired[RelationshipValueTypeDef], # (3)
stringValue: NotRequired[str],
- See DataValueTypeDef
- See DataValueTypeDef
- See RelationshipValueTypeDef
PropertyLatestValueTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyLatestValueTypeDef
def get_value() -> PropertyLatestValueTypeDef:
return {
"propertyReference": ...,
}
Definition
class PropertyLatestValueTypeDef(TypedDict):
propertyReference: EntityPropertyReferenceTypeDef, # (1)
propertyValue: NotRequired[DataValueTypeDef], # (2)
StatusTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import StatusTypeDef
def get_value() -> StatusTypeDef:
return {
"error": ...,
}
Definition
class StatusTypeDef(TypedDict):
error: NotRequired[ErrorDetailsTypeDef], # (1)
state: NotRequired[StateType], # (2)
- See ErrorDetailsTypeDef
- See StateType
PropertyResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyResponseTypeDef
def get_value() -> PropertyResponseTypeDef:
return {
"definition": ...,
}
Definition
class PropertyResponseTypeDef(TypedDict):
definition: NotRequired[PropertyDefinitionResponseTypeDef], # (1)
value: NotRequired[DataValueTypeDef], # (2)
GetPropertyValueHistoryRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetPropertyValueHistoryRequestRequestTypeDef
def get_value() -> GetPropertyValueHistoryRequestRequestTypeDef:
return {
"selectedProperties": ...,
"workspaceId": ...,
}
Definition
class GetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
selectedProperties: Sequence[str],
workspaceId: str,
componentName: NotRequired[str],
componentTypeId: NotRequired[str],
endDateTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[str],
entityId: NotRequired[str],
interpolation: NotRequired[InterpolationParametersTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
orderByTime: NotRequired[OrderByTimeType], # (2)
propertyFilters: NotRequired[Sequence[PropertyFilterTypeDef]], # (3)
startDateTime: NotRequired[Union[datetime, str]],
startTime: NotRequired[str],
ListComponentTypesRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListComponentTypesRequestRequestTypeDef
def get_value() -> ListComponentTypesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
Definition
class ListComponentTypesRequestRequestTypeDef(TypedDict):
workspaceId: str,
filters: NotRequired[Sequence[ListComponentTypesFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListEntitiesRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListEntitiesRequestRequestTypeDef
def get_value() -> ListEntitiesRequestRequestTypeDef:
return {
"workspaceId": ...,
}
Definition
class ListEntitiesRequestRequestTypeDef(TypedDict):
workspaceId: str,
filters: NotRequired[Sequence[ListEntitiesFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListScenesResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListScenesResponseTypeDef
def get_value() -> ListScenesResponseTypeDef:
return {
"nextToken": ...,
"sceneSummaries": ...,
"ResponseMetadata": ...,
}
Definition
class ListScenesResponseTypeDef(TypedDict):
nextToken: str,
sceneSummaries: List[SceneSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWorkspacesResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListWorkspacesResponseTypeDef
def get_value() -> ListWorkspacesResponseTypeDef:
return {
"nextToken": ...,
"workspaceSummaries": ...,
"ResponseMetadata": ...,
}
Definition
class ListWorkspacesResponseTypeDef(TypedDict):
nextToken: str,
workspaceSummaries: List[WorkspaceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PropertyValueEntryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyValueEntryTypeDef
def get_value() -> PropertyValueEntryTypeDef:
return {
"entityPropertyReference": ...,
}
Definition
class PropertyValueEntryTypeDef(TypedDict):
entityPropertyReference: EntityPropertyReferenceTypeDef, # (1)
propertyValues: NotRequired[Sequence[PropertyValueTypeDef]], # (2)
PropertyValueHistoryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import PropertyValueHistoryTypeDef
def get_value() -> PropertyValueHistoryTypeDef:
return {
"entityPropertyReference": ...,
}
Definition
class PropertyValueHistoryTypeDef(TypedDict):
entityPropertyReference: EntityPropertyReferenceTypeDef, # (1)
values: NotRequired[List[PropertyValueTypeDef]], # (2)
ComponentRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ComponentRequestTypeDef
def get_value() -> ComponentRequestTypeDef:
return {
"componentTypeId": ...,
}
Definition
class ComponentRequestTypeDef(TypedDict):
componentTypeId: NotRequired[str],
description: NotRequired[str],
properties: NotRequired[Mapping[str, PropertyRequestTypeDef]], # (1)
ComponentUpdateRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ComponentUpdateRequestTypeDef
def get_value() -> ComponentUpdateRequestTypeDef:
return {
"componentTypeId": ...,
}
Definition
class ComponentUpdateRequestTypeDef(TypedDict):
componentTypeId: NotRequired[str],
description: NotRequired[str],
propertyUpdates: NotRequired[Mapping[str, PropertyRequestTypeDef]], # (1)
updateType: NotRequired[ComponentUpdateTypeType], # (2)
FunctionRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import FunctionRequestTypeDef
def get_value() -> FunctionRequestTypeDef:
return {
"implementedBy": ...,
}
Definition
class FunctionRequestTypeDef(TypedDict):
implementedBy: NotRequired[DataConnectorTypeDef], # (1)
requiredProperties: NotRequired[Sequence[str]],
scope: NotRequired[ScopeType], # (2)
- See DataConnectorTypeDef
- See ScopeType
FunctionResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import FunctionResponseTypeDef
def get_value() -> FunctionResponseTypeDef:
return {
"implementedBy": ...,
}
Definition
class FunctionResponseTypeDef(TypedDict):
implementedBy: NotRequired[DataConnectorTypeDef], # (1)
isInherited: NotRequired[bool],
requiredProperties: NotRequired[List[str]],
scope: NotRequired[ScopeType], # (2)
- See DataConnectorTypeDef
- See ScopeType
GetPropertyValueResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetPropertyValueResponseTypeDef
def get_value() -> GetPropertyValueResponseTypeDef:
return {
"propertyValues": ...,
"ResponseMetadata": ...,
}
Definition
class GetPropertyValueResponseTypeDef(TypedDict):
propertyValues: Dict[str, PropertyLatestValueTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ComponentTypeSummaryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ComponentTypeSummaryTypeDef
def get_value() -> ComponentTypeSummaryTypeDef:
return {
"arn": ...,
"componentTypeId": ...,
"creationDateTime": ...,
"updateDateTime": ...,
}
Definition
class ComponentTypeSummaryTypeDef(TypedDict):
arn: str,
componentTypeId: str,
creationDateTime: datetime,
updateDateTime: datetime,
description: NotRequired[str],
status: NotRequired[StatusTypeDef], # (1)
- See StatusTypeDef
EntitySummaryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import EntitySummaryTypeDef
def get_value() -> EntitySummaryTypeDef:
return {
"arn": ...,
"creationDateTime": ...,
"entityId": ...,
"entityName": ...,
"status": ...,
"updateDateTime": ...,
}
Definition
class EntitySummaryTypeDef(TypedDict):
arn: str,
creationDateTime: datetime,
entityId: str,
entityName: str,
status: StatusTypeDef, # (1)
updateDateTime: datetime,
description: NotRequired[str],
hasChildEntities: NotRequired[bool],
parentEntityId: NotRequired[str],
- See StatusTypeDef
ComponentResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ComponentResponseTypeDef
def get_value() -> ComponentResponseTypeDef:
return {
"componentName": ...,
}
Definition
class ComponentResponseTypeDef(TypedDict):
componentName: NotRequired[str],
componentTypeId: NotRequired[str],
definedIn: NotRequired[str],
description: NotRequired[str],
properties: NotRequired[Dict[str, PropertyResponseTypeDef]], # (1)
status: NotRequired[StatusTypeDef], # (2)
- See PropertyResponseTypeDef
- See StatusTypeDef
BatchPutPropertyErrorTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import BatchPutPropertyErrorTypeDef
def get_value() -> BatchPutPropertyErrorTypeDef:
return {
"entry": ...,
"errorCode": ...,
"errorMessage": ...,
}
Definition
class BatchPutPropertyErrorTypeDef(TypedDict):
entry: PropertyValueEntryTypeDef, # (1)
errorCode: str,
errorMessage: str,
BatchPutPropertyValuesRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import BatchPutPropertyValuesRequestRequestTypeDef
def get_value() -> BatchPutPropertyValuesRequestRequestTypeDef:
return {
"entries": ...,
"workspaceId": ...,
}
Definition
class BatchPutPropertyValuesRequestRequestTypeDef(TypedDict):
entries: Sequence[PropertyValueEntryTypeDef], # (1)
workspaceId: str,
GetPropertyValueHistoryResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetPropertyValueHistoryResponseTypeDef
def get_value() -> GetPropertyValueHistoryResponseTypeDef:
return {
"nextToken": ...,
"propertyValues": ...,
"ResponseMetadata": ...,
}
Definition
class GetPropertyValueHistoryResponseTypeDef(TypedDict):
nextToken: str,
propertyValues: List[PropertyValueHistoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateEntityRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateEntityRequestRequestTypeDef
def get_value() -> CreateEntityRequestRequestTypeDef:
return {
"entityName": ...,
"workspaceId": ...,
}
Definition
class CreateEntityRequestRequestTypeDef(TypedDict):
entityName: str,
workspaceId: str,
components: NotRequired[Mapping[str, ComponentRequestTypeDef]], # (1)
description: NotRequired[str],
entityId: NotRequired[str],
parentEntityId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
UpdateEntityRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateEntityRequestRequestTypeDef
def get_value() -> UpdateEntityRequestRequestTypeDef:
return {
"entityId": ...,
"workspaceId": ...,
}
Definition
class UpdateEntityRequestRequestTypeDef(TypedDict):
entityId: str,
workspaceId: str,
componentUpdates: NotRequired[Mapping[str, ComponentUpdateRequestTypeDef]], # (1)
description: NotRequired[str],
entityName: NotRequired[str],
parentEntityUpdate: NotRequired[ParentEntityUpdateRequestTypeDef], # (2)
CreateComponentTypeRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import CreateComponentTypeRequestRequestTypeDef
def get_value() -> CreateComponentTypeRequestRequestTypeDef:
return {
"componentTypeId": ...,
"workspaceId": ...,
}
Definition
class CreateComponentTypeRequestRequestTypeDef(TypedDict):
componentTypeId: str,
workspaceId: str,
description: NotRequired[str],
extendsFrom: NotRequired[Sequence[str]],
functions: NotRequired[Mapping[str, FunctionRequestTypeDef]], # (1)
isSingleton: NotRequired[bool],
propertyDefinitions: NotRequired[Mapping[str, PropertyDefinitionRequestTypeDef]], # (2)
tags: NotRequired[Mapping[str, str]],
UpdateComponentTypeRequestRequestTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import UpdateComponentTypeRequestRequestTypeDef
def get_value() -> UpdateComponentTypeRequestRequestTypeDef:
return {
"componentTypeId": ...,
"workspaceId": ...,
}
Definition
class UpdateComponentTypeRequestRequestTypeDef(TypedDict):
componentTypeId: str,
workspaceId: str,
description: NotRequired[str],
extendsFrom: NotRequired[Sequence[str]],
functions: NotRequired[Mapping[str, FunctionRequestTypeDef]], # (1)
isSingleton: NotRequired[bool],
propertyDefinitions: NotRequired[Mapping[str, PropertyDefinitionRequestTypeDef]], # (2)
GetComponentTypeResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetComponentTypeResponseTypeDef
def get_value() -> GetComponentTypeResponseTypeDef:
return {
"arn": ...,
"componentTypeId": ...,
"creationDateTime": ...,
"description": ...,
"extendsFrom": ...,
"functions": ...,
"isAbstract": ...,
"isSchemaInitialized": ...,
"isSingleton": ...,
"propertyDefinitions": ...,
"status": ...,
"updateDateTime": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class GetComponentTypeResponseTypeDef(TypedDict):
arn: str,
componentTypeId: str,
creationDateTime: datetime,
description: str,
extendsFrom: List[str],
functions: Dict[str, FunctionResponseTypeDef], # (1)
isAbstract: bool,
isSchemaInitialized: bool,
isSingleton: bool,
propertyDefinitions: Dict[str, PropertyDefinitionResponseTypeDef], # (2)
status: StatusTypeDef, # (3)
updateDateTime: datetime,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See FunctionResponseTypeDef
- See PropertyDefinitionResponseTypeDef
- See StatusTypeDef
- See ResponseMetadataTypeDef
ListComponentTypesResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListComponentTypesResponseTypeDef
def get_value() -> ListComponentTypesResponseTypeDef:
return {
"componentTypeSummaries": ...,
"maxResults": ...,
"nextToken": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class ListComponentTypesResponseTypeDef(TypedDict):
componentTypeSummaries: List[ComponentTypeSummaryTypeDef], # (1)
maxResults: int,
nextToken: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEntitiesResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import ListEntitiesResponseTypeDef
def get_value() -> ListEntitiesResponseTypeDef:
return {
"entitySummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListEntitiesResponseTypeDef(TypedDict):
entitySummaries: List[EntitySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEntityResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import GetEntityResponseTypeDef
def get_value() -> GetEntityResponseTypeDef:
return {
"arn": ...,
"components": ...,
"creationDateTime": ...,
"description": ...,
"entityId": ...,
"entityName": ...,
"hasChildEntities": ...,
"parentEntityId": ...,
"status": ...,
"updateDateTime": ...,
"workspaceId": ...,
"ResponseMetadata": ...,
}
Definition
class GetEntityResponseTypeDef(TypedDict):
arn: str,
components: Dict[str, ComponentResponseTypeDef], # (1)
creationDateTime: datetime,
description: str,
entityId: str,
entityName: str,
hasChildEntities: bool,
parentEntityId: str,
status: StatusTypeDef, # (2)
updateDateTime: datetime,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchPutPropertyErrorEntryTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import BatchPutPropertyErrorEntryTypeDef
def get_value() -> BatchPutPropertyErrorEntryTypeDef:
return {
"errors": ...,
}
Definition
class BatchPutPropertyErrorEntryTypeDef(TypedDict):
errors: List[BatchPutPropertyErrorTypeDef], # (1)
BatchPutPropertyValuesResponseTypeDef
Usage Example
from types_aiobotocore_iottwinmaker.type_defs import BatchPutPropertyValuesResponseTypeDef
def get_value() -> BatchPutPropertyValuesResponseTypeDef:
return {
"errorEntries": ...,
"ResponseMetadata": ...,
}