Typed dictionaries
Index > IoTThingsGraph > Typed dictionaries
Auto-generated documentation for IoTThingsGraph type annotations stubs module mypy-boto3-iotthingsgraph.
AssociateEntityToThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import AssociateEntityToThingRequestRequestTypeDef
def get_value() -> AssociateEntityToThingRequestRequestTypeDef:
return {
"thingName": ...,
"entityId": ...,
}
Definition
class AssociateEntityToThingRequestRequestTypeDef(TypedDict):
thingName: str,
entityId: str,
namespaceVersion: NotRequired[int],
DefinitionDocumentTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DefinitionDocumentTypeDef
def get_value() -> DefinitionDocumentTypeDef:
return {
"language": ...,
"text": ...,
}
Definition
class DefinitionDocumentTypeDef(TypedDict):
language: DefinitionLanguageType, # (1)
text: str,
FlowTemplateSummaryTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import FlowTemplateSummaryTypeDef
def get_value() -> FlowTemplateSummaryTypeDef:
return {
"id": ...,
}
Definition
class FlowTemplateSummaryTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
revisionNumber: NotRequired[int],
createdAt: NotRequired[datetime],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.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,
MetricsConfigurationTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import MetricsConfigurationTypeDef
def get_value() -> MetricsConfigurationTypeDef:
return {
"cloudMetricEnabled": ...,
}
Definition
class MetricsConfigurationTypeDef(TypedDict):
cloudMetricEnabled: NotRequired[bool],
metricRuleRoleArn: NotRequired[str],
TagTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
"value": ...,
}
SystemInstanceSummaryTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemInstanceSummaryTypeDef
def get_value() -> SystemInstanceSummaryTypeDef:
return {
"id": ...,
}
Definition
class SystemInstanceSummaryTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
status: NotRequired[SystemInstanceDeploymentStatusType], # (1)
target: NotRequired[DeploymentTargetType], # (2)
greengrassGroupName: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
greengrassGroupId: NotRequired[str],
greengrassGroupVersionId: NotRequired[str],
SystemTemplateSummaryTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemTemplateSummaryTypeDef
def get_value() -> SystemTemplateSummaryTypeDef:
return {
"id": ...,
}
Definition
class SystemTemplateSummaryTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
revisionNumber: NotRequired[int],
createdAt: NotRequired[datetime],
DeleteFlowTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeleteFlowTemplateRequestRequestTypeDef
def get_value() -> DeleteFlowTemplateRequestRequestTypeDef:
return {
"id": ...,
}
DeleteSystemInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeleteSystemInstanceRequestRequestTypeDef
def get_value() -> DeleteSystemInstanceRequestRequestTypeDef:
return {
"id": ...,
}
DeleteSystemTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeleteSystemTemplateRequestRequestTypeDef
def get_value() -> DeleteSystemTemplateRequestRequestTypeDef:
return {
"id": ...,
}
DependencyRevisionTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DependencyRevisionTypeDef
def get_value() -> DependencyRevisionTypeDef:
return {
"id": ...,
}
Definition
class DependencyRevisionTypeDef(TypedDict):
id: NotRequired[str],
revisionNumber: NotRequired[int],
DeploySystemInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeploySystemInstanceRequestRequestTypeDef
def get_value() -> DeploySystemInstanceRequestRequestTypeDef:
return {
"id": ...,
}
DeprecateFlowTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeprecateFlowTemplateRequestRequestTypeDef
def get_value() -> DeprecateFlowTemplateRequestRequestTypeDef:
return {
"id": ...,
}
DeprecateSystemTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeprecateSystemTemplateRequestRequestTypeDef
def get_value() -> DeprecateSystemTemplateRequestRequestTypeDef:
return {
"id": ...,
}
DescribeNamespaceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DescribeNamespaceRequestRequestTypeDef
def get_value() -> DescribeNamespaceRequestRequestTypeDef:
return {
"namespaceName": ...,
}
DissociateEntityFromThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DissociateEntityFromThingRequestRequestTypeDef
def get_value() -> DissociateEntityFromThingRequestRequestTypeDef:
return {
"thingName": ...,
"entityType": ...,
}
Definition
class DissociateEntityFromThingRequestRequestTypeDef(TypedDict):
thingName: str,
entityType: EntityTypeType, # (1)
- See EntityTypeType
EntityFilterTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import EntityFilterTypeDef
def get_value() -> EntityFilterTypeDef:
return {
"name": ...,
}
Definition
class EntityFilterTypeDef(TypedDict):
name: NotRequired[EntityFilterNameType], # (1)
value: NotRequired[Sequence[str]],
FlowExecutionMessageTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import FlowExecutionMessageTypeDef
def get_value() -> FlowExecutionMessageTypeDef:
return {
"messageId": ...,
}
Definition
class FlowExecutionMessageTypeDef(TypedDict):
messageId: NotRequired[str],
eventType: NotRequired[FlowExecutionEventTypeType], # (1)
timestamp: NotRequired[datetime],
payload: NotRequired[str],
FlowExecutionSummaryTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import FlowExecutionSummaryTypeDef
def get_value() -> FlowExecutionSummaryTypeDef:
return {
"flowExecutionId": ...,
}
Definition
class FlowExecutionSummaryTypeDef(TypedDict):
flowExecutionId: NotRequired[str],
status: NotRequired[FlowExecutionStatusType], # (1)
systemInstanceId: NotRequired[str],
flowTemplateId: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
FlowTemplateFilterTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import FlowTemplateFilterTypeDef
def get_value() -> FlowTemplateFilterTypeDef:
return {
"name": ...,
"value": ...,
}
Definition
class FlowTemplateFilterTypeDef(TypedDict):
name: FlowTemplateFilterNameType, # (1)
value: Sequence[str],
GetEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetEntitiesRequestRequestTypeDef
def get_value() -> GetEntitiesRequestRequestTypeDef:
return {
"ids": ...,
}
Definition
class GetEntitiesRequestRequestTypeDef(TypedDict):
ids: Sequence[str],
namespaceVersion: NotRequired[int],
GetFlowTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetFlowTemplateRequestRequestTypeDef
def get_value() -> GetFlowTemplateRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class GetFlowTemplateRequestRequestTypeDef(TypedDict):
id: str,
revisionNumber: NotRequired[int],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetFlowTemplateRevisionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetFlowTemplateRevisionsRequestRequestTypeDef
def get_value() -> GetFlowTemplateRevisionsRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class GetFlowTemplateRevisionsRequestRequestTypeDef(TypedDict):
id: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetSystemInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemInstanceRequestRequestTypeDef
def get_value() -> GetSystemInstanceRequestRequestTypeDef:
return {
"id": ...,
}
GetSystemTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemTemplateRequestRequestTypeDef
def get_value() -> GetSystemTemplateRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class GetSystemTemplateRequestRequestTypeDef(TypedDict):
id: str,
revisionNumber: NotRequired[int],
GetSystemTemplateRevisionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemTemplateRevisionsRequestRequestTypeDef
def get_value() -> GetSystemTemplateRevisionsRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class GetSystemTemplateRevisionsRequestRequestTypeDef(TypedDict):
id: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetUploadStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetUploadStatusRequestRequestTypeDef
def get_value() -> GetUploadStatusRequestRequestTypeDef:
return {
"uploadId": ...,
}
ListFlowExecutionMessagesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListFlowExecutionMessagesRequestRequestTypeDef
def get_value() -> ListFlowExecutionMessagesRequestRequestTypeDef:
return {
"flowExecutionId": ...,
}
Definition
class ListFlowExecutionMessagesRequestRequestTypeDef(TypedDict):
flowExecutionId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchFlowExecutionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowExecutionsRequestRequestTypeDef
def get_value() -> SearchFlowExecutionsRequestRequestTypeDef:
return {
"systemInstanceId": ...,
}
Definition
class SearchFlowExecutionsRequestRequestTypeDef(TypedDict):
systemInstanceId: str,
flowExecutionId: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SystemInstanceFilterTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemInstanceFilterTypeDef
def get_value() -> SystemInstanceFilterTypeDef:
return {
"name": ...,
}
Definition
class SystemInstanceFilterTypeDef(TypedDict):
name: NotRequired[SystemInstanceFilterNameType], # (1)
value: NotRequired[Sequence[str]],
SystemTemplateFilterTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemTemplateFilterTypeDef
def get_value() -> SystemTemplateFilterTypeDef:
return {
"name": ...,
"value": ...,
}
Definition
class SystemTemplateFilterTypeDef(TypedDict):
name: SystemTemplateFilterNameType, # (1)
value: Sequence[str],
SearchThingsRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchThingsRequestRequestTypeDef
def get_value() -> SearchThingsRequestRequestTypeDef:
return {
"entityId": ...,
}
Definition
class SearchThingsRequestRequestTypeDef(TypedDict):
entityId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
namespaceVersion: NotRequired[int],
ThingTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ThingTypeDef
def get_value() -> ThingTypeDef:
return {
"thingArn": ...,
}
UndeploySystemInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UndeploySystemInstanceRequestRequestTypeDef
def get_value() -> UndeploySystemInstanceRequestRequestTypeDef:
return {
"id": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
CreateFlowTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateFlowTemplateRequestRequestTypeDef
def get_value() -> CreateFlowTemplateRequestRequestTypeDef:
return {
"definition": ...,
}
Definition
class CreateFlowTemplateRequestRequestTypeDef(TypedDict):
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: NotRequired[int],
CreateSystemTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateSystemTemplateRequestRequestTypeDef
def get_value() -> CreateSystemTemplateRequestRequestTypeDef:
return {
"definition": ...,
}
Definition
class CreateSystemTemplateRequestRequestTypeDef(TypedDict):
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: NotRequired[int],
EntityDescriptionTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import EntityDescriptionTypeDef
def get_value() -> EntityDescriptionTypeDef:
return {
"id": ...,
}
Definition
class EntityDescriptionTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
type: NotRequired[EntityTypeType], # (1)
createdAt: NotRequired[datetime],
definition: NotRequired[DefinitionDocumentTypeDef], # (2)
UpdateFlowTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UpdateFlowTemplateRequestRequestTypeDef
def get_value() -> UpdateFlowTemplateRequestRequestTypeDef:
return {
"id": ...,
"definition": ...,
}
Definition
class UpdateFlowTemplateRequestRequestTypeDef(TypedDict):
id: str,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: NotRequired[int],
UpdateSystemTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UpdateSystemTemplateRequestRequestTypeDef
def get_value() -> UpdateSystemTemplateRequestRequestTypeDef:
return {
"id": ...,
"definition": ...,
}
Definition
class UpdateSystemTemplateRequestRequestTypeDef(TypedDict):
id: str,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: NotRequired[int],
UploadEntityDefinitionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UploadEntityDefinitionsRequestRequestTypeDef
def get_value() -> UploadEntityDefinitionsRequestRequestTypeDef:
return {
"document": ...,
}
Definition
class UploadEntityDefinitionsRequestRequestTypeDef(TypedDict):
document: NotRequired[DefinitionDocumentTypeDef], # (1)
syncWithPublicNamespace: NotRequired[bool],
deprecateExistingEntities: NotRequired[bool],
FlowTemplateDescriptionTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import FlowTemplateDescriptionTypeDef
def get_value() -> FlowTemplateDescriptionTypeDef:
return {
"summary": ...,
}
Definition
class FlowTemplateDescriptionTypeDef(TypedDict):
summary: NotRequired[FlowTemplateSummaryTypeDef], # (1)
definition: NotRequired[DefinitionDocumentTypeDef], # (2)
validatedNamespaceVersion: NotRequired[int],
CreateFlowTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateFlowTemplateResponseTypeDef
def get_value() -> CreateFlowTemplateResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateFlowTemplateResponseTypeDef(TypedDict):
summary: FlowTemplateSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteNamespaceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeleteNamespaceResponseTypeDef
def get_value() -> DeleteNamespaceResponseTypeDef:
return {
"namespaceArn": ...,
"namespaceName": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteNamespaceResponseTypeDef(TypedDict):
namespaceArn: str,
namespaceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeNamespaceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DescribeNamespaceResponseTypeDef
def get_value() -> DescribeNamespaceResponseTypeDef:
return {
"namespaceArn": ...,
"namespaceName": ...,
"trackingNamespaceName": ...,
"trackingNamespaceVersion": ...,
"namespaceVersion": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeNamespaceResponseTypeDef(TypedDict):
namespaceArn: str,
namespaceName: str,
trackingNamespaceName: str,
trackingNamespaceVersion: int,
namespaceVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetFlowTemplateRevisionsResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetFlowTemplateRevisionsResponseTypeDef
def get_value() -> GetFlowTemplateRevisionsResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetFlowTemplateRevisionsResponseTypeDef(TypedDict):
summaries: List[FlowTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNamespaceDeletionStatusResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetNamespaceDeletionStatusResponseTypeDef
def get_value() -> GetNamespaceDeletionStatusResponseTypeDef:
return {
"namespaceArn": ...,
"namespaceName": ...,
"status": ...,
"errorCode": ...,
"errorMessage": ...,
"ResponseMetadata": ...,
}
Definition
class GetNamespaceDeletionStatusResponseTypeDef(TypedDict):
namespaceArn: str,
namespaceName: str,
status: NamespaceDeletionStatusType, # (1)
errorCode: NamespaceDeletionStatusErrorCodesType, # (2)
errorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See NamespaceDeletionStatusType
- See NamespaceDeletionStatusErrorCodesType
- See ResponseMetadataTypeDef
GetUploadStatusResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetUploadStatusResponseTypeDef
def get_value() -> GetUploadStatusResponseTypeDef:
return {
"uploadId": ...,
"uploadStatus": ...,
"namespaceArn": ...,
"namespaceName": ...,
"namespaceVersion": ...,
"failureReason": ...,
"createdDate": ...,
"ResponseMetadata": ...,
}
Definition
class GetUploadStatusResponseTypeDef(TypedDict):
uploadId: str,
uploadStatus: UploadStatusType, # (1)
namespaceArn: str,
namespaceName: str,
namespaceVersion: int,
failureReason: List[str],
createdDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchFlowTemplatesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowTemplatesResponseTypeDef
def get_value() -> SearchFlowTemplatesResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchFlowTemplatesResponseTypeDef(TypedDict):
summaries: List[FlowTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateFlowTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UpdateFlowTemplateResponseTypeDef
def get_value() -> UpdateFlowTemplateResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateFlowTemplateResponseTypeDef(TypedDict):
summary: FlowTemplateSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UploadEntityDefinitionsResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UploadEntityDefinitionsResponseTypeDef
def get_value() -> UploadEntityDefinitionsResponseTypeDef:
return {
"uploadId": ...,
"ResponseMetadata": ...,
}
Definition
class UploadEntityDefinitionsResponseTypeDef(TypedDict):
uploadId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSystemInstanceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateSystemInstanceRequestRequestTypeDef
def get_value() -> CreateSystemInstanceRequestRequestTypeDef:
return {
"definition": ...,
"target": ...,
}
Definition
class CreateSystemInstanceRequestRequestTypeDef(TypedDict):
definition: DefinitionDocumentTypeDef, # (1)
target: DeploymentTargetType, # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)
greengrassGroupName: NotRequired[str],
s3BucketName: NotRequired[str],
metricsConfiguration: NotRequired[MetricsConfigurationTypeDef], # (4)
flowActionsRoleArn: NotRequired[str],
- See DefinitionDocumentTypeDef
- See DeploymentTargetType
- See TagTypeDef
- See MetricsConfigurationTypeDef
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateSystemInstanceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateSystemInstanceResponseTypeDef
def get_value() -> CreateSystemInstanceResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSystemInstanceResponseTypeDef(TypedDict):
summary: SystemInstanceSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeploySystemInstanceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import DeploySystemInstanceResponseTypeDef
def get_value() -> DeploySystemInstanceResponseTypeDef:
return {
"summary": ...,
"greengrassDeploymentId": ...,
"ResponseMetadata": ...,
}
Definition
class DeploySystemInstanceResponseTypeDef(TypedDict):
summary: SystemInstanceSummaryTypeDef, # (1)
greengrassDeploymentId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchSystemInstancesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemInstancesResponseTypeDef
def get_value() -> SearchSystemInstancesResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchSystemInstancesResponseTypeDef(TypedDict):
summaries: List[SystemInstanceSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UndeploySystemInstanceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UndeploySystemInstanceResponseTypeDef
def get_value() -> UndeploySystemInstanceResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class UndeploySystemInstanceResponseTypeDef(TypedDict):
summary: SystemInstanceSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateSystemTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import CreateSystemTemplateResponseTypeDef
def get_value() -> CreateSystemTemplateResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSystemTemplateResponseTypeDef(TypedDict):
summary: SystemTemplateSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSystemTemplateRevisionsResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemTemplateRevisionsResponseTypeDef
def get_value() -> GetSystemTemplateRevisionsResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetSystemTemplateRevisionsResponseTypeDef(TypedDict):
summaries: List[SystemTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchSystemTemplatesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemTemplatesResponseTypeDef
def get_value() -> SearchSystemTemplatesResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchSystemTemplatesResponseTypeDef(TypedDict):
summaries: List[SystemTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SystemTemplateDescriptionTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemTemplateDescriptionTypeDef
def get_value() -> SystemTemplateDescriptionTypeDef:
return {
"summary": ...,
}
Definition
class SystemTemplateDescriptionTypeDef(TypedDict):
summary: NotRequired[SystemTemplateSummaryTypeDef], # (1)
definition: NotRequired[DefinitionDocumentTypeDef], # (2)
validatedNamespaceVersion: NotRequired[int],
UpdateSystemTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import UpdateSystemTemplateResponseTypeDef
def get_value() -> UpdateSystemTemplateResponseTypeDef:
return {
"summary": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateSystemTemplateResponseTypeDef(TypedDict):
summary: SystemTemplateSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SystemInstanceDescriptionTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SystemInstanceDescriptionTypeDef
def get_value() -> SystemInstanceDescriptionTypeDef:
return {
"summary": ...,
}
Definition
class SystemInstanceDescriptionTypeDef(TypedDict):
summary: NotRequired[SystemInstanceSummaryTypeDef], # (1)
definition: NotRequired[DefinitionDocumentTypeDef], # (2)
s3BucketName: NotRequired[str],
metricsConfiguration: NotRequired[MetricsConfigurationTypeDef], # (3)
validatedNamespaceVersion: NotRequired[int],
validatedDependencyRevisions: NotRequired[List[DependencyRevisionTypeDef]], # (4)
flowActionsRoleArn: NotRequired[str],
- See SystemInstanceSummaryTypeDef
- See DefinitionDocumentTypeDef
- See MetricsConfigurationTypeDef
- See DependencyRevisionTypeDef
SearchEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchEntitiesRequestRequestTypeDef
def get_value() -> SearchEntitiesRequestRequestTypeDef:
return {
"entityTypes": ...,
}
Definition
class SearchEntitiesRequestRequestTypeDef(TypedDict):
entityTypes: Sequence[EntityTypeType], # (1)
filters: NotRequired[Sequence[EntityFilterTypeDef]], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
namespaceVersion: NotRequired[int],
- See EntityTypeType
- See EntityFilterTypeDef
ListFlowExecutionMessagesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListFlowExecutionMessagesResponseTypeDef
def get_value() -> ListFlowExecutionMessagesResponseTypeDef:
return {
"messages": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListFlowExecutionMessagesResponseTypeDef(TypedDict):
messages: List[FlowExecutionMessageTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchFlowExecutionsResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowExecutionsResponseTypeDef
def get_value() -> SearchFlowExecutionsResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchFlowExecutionsResponseTypeDef(TypedDict):
summaries: List[FlowExecutionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchFlowTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowTemplatesRequestRequestTypeDef
def get_value() -> SearchFlowTemplatesRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchFlowTemplatesRequestRequestTypeDef(TypedDict):
filters: NotRequired[Sequence[FlowTemplateFilterTypeDef]], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetFlowTemplateRevisionsRequestGetFlowTemplateRevisionsPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetFlowTemplateRevisionsRequestGetFlowTemplateRevisionsPaginateTypeDef
def get_value() -> GetFlowTemplateRevisionsRequestGetFlowTemplateRevisionsPaginateTypeDef:
return {
"id": ...,
}
Definition
class GetFlowTemplateRevisionsRequestGetFlowTemplateRevisionsPaginateTypeDef(TypedDict):
id: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSystemTemplateRevisionsRequestGetSystemTemplateRevisionsPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemTemplateRevisionsRequestGetSystemTemplateRevisionsPaginateTypeDef
def get_value() -> GetSystemTemplateRevisionsRequestGetSystemTemplateRevisionsPaginateTypeDef:
return {
"id": ...,
}
Definition
class GetSystemTemplateRevisionsRequestGetSystemTemplateRevisionsPaginateTypeDef(TypedDict):
id: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFlowExecutionMessagesRequestListFlowExecutionMessagesPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListFlowExecutionMessagesRequestListFlowExecutionMessagesPaginateTypeDef
def get_value() -> ListFlowExecutionMessagesRequestListFlowExecutionMessagesPaginateTypeDef:
return {
"flowExecutionId": ...,
}
Definition
class ListFlowExecutionMessagesRequestListFlowExecutionMessagesPaginateTypeDef(TypedDict):
flowExecutionId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
SearchEntitiesRequestSearchEntitiesPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchEntitiesRequestSearchEntitiesPaginateTypeDef
def get_value() -> SearchEntitiesRequestSearchEntitiesPaginateTypeDef:
return {
"entityTypes": ...,
}
Definition
class SearchEntitiesRequestSearchEntitiesPaginateTypeDef(TypedDict):
entityTypes: Sequence[EntityTypeType], # (1)
filters: NotRequired[Sequence[EntityFilterTypeDef]], # (2)
namespaceVersion: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See EntityTypeType
- See EntityFilterTypeDef
- See PaginatorConfigTypeDef
SearchFlowExecutionsRequestSearchFlowExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowExecutionsRequestSearchFlowExecutionsPaginateTypeDef
def get_value() -> SearchFlowExecutionsRequestSearchFlowExecutionsPaginateTypeDef:
return {
"systemInstanceId": ...,
}
Definition
class SearchFlowExecutionsRequestSearchFlowExecutionsPaginateTypeDef(TypedDict):
systemInstanceId: str,
flowExecutionId: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
SearchFlowTemplatesRequestSearchFlowTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchFlowTemplatesRequestSearchFlowTemplatesPaginateTypeDef
def get_value() -> SearchFlowTemplatesRequestSearchFlowTemplatesPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchFlowTemplatesRequestSearchFlowTemplatesPaginateTypeDef(TypedDict):
filters: NotRequired[Sequence[FlowTemplateFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchThingsRequestSearchThingsPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchThingsRequestSearchThingsPaginateTypeDef
def get_value() -> SearchThingsRequestSearchThingsPaginateTypeDef:
return {
"entityId": ...,
}
Definition
class SearchThingsRequestSearchThingsPaginateTypeDef(TypedDict):
entityId: str,
namespaceVersion: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
SearchSystemInstancesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemInstancesRequestRequestTypeDef
def get_value() -> SearchSystemInstancesRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchSystemInstancesRequestRequestTypeDef(TypedDict):
filters: NotRequired[Sequence[SystemInstanceFilterTypeDef]], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SearchSystemInstancesRequestSearchSystemInstancesPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemInstancesRequestSearchSystemInstancesPaginateTypeDef
def get_value() -> SearchSystemInstancesRequestSearchSystemInstancesPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchSystemInstancesRequestSearchSystemInstancesPaginateTypeDef(TypedDict):
filters: NotRequired[Sequence[SystemInstanceFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchSystemTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemTemplatesRequestRequestTypeDef
def get_value() -> SearchSystemTemplatesRequestRequestTypeDef:
return {
"filters": ...,
}
Definition
class SearchSystemTemplatesRequestRequestTypeDef(TypedDict):
filters: NotRequired[Sequence[SystemTemplateFilterTypeDef]], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SearchSystemTemplatesRequestSearchSystemTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchSystemTemplatesRequestSearchSystemTemplatesPaginateTypeDef
def get_value() -> SearchSystemTemplatesRequestSearchSystemTemplatesPaginateTypeDef:
return {
"filters": ...,
}
Definition
class SearchSystemTemplatesRequestSearchSystemTemplatesPaginateTypeDef(TypedDict):
filters: NotRequired[Sequence[SystemTemplateFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchThingsResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchThingsResponseTypeDef
def get_value() -> SearchThingsResponseTypeDef:
return {
"things": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchThingsResponseTypeDef(TypedDict):
things: List[ThingTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ThingTypeDef
- See ResponseMetadataTypeDef
GetEntitiesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetEntitiesResponseTypeDef
def get_value() -> GetEntitiesResponseTypeDef:
return {
"descriptions": ...,
"ResponseMetadata": ...,
}
Definition
class GetEntitiesResponseTypeDef(TypedDict):
descriptions: List[EntityDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchEntitiesResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import SearchEntitiesResponseTypeDef
def get_value() -> SearchEntitiesResponseTypeDef:
return {
"descriptions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchEntitiesResponseTypeDef(TypedDict):
descriptions: List[EntityDescriptionTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFlowTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetFlowTemplateResponseTypeDef
def get_value() -> GetFlowTemplateResponseTypeDef:
return {
"description": ...,
"ResponseMetadata": ...,
}
Definition
class GetFlowTemplateResponseTypeDef(TypedDict):
description: FlowTemplateDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSystemTemplateResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemTemplateResponseTypeDef
def get_value() -> GetSystemTemplateResponseTypeDef:
return {
"description": ...,
"ResponseMetadata": ...,
}
Definition
class GetSystemTemplateResponseTypeDef(TypedDict):
description: SystemTemplateDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSystemInstanceResponseTypeDef
Usage Example
from mypy_boto3_iotthingsgraph.type_defs import GetSystemInstanceResponseTypeDef
def get_value() -> GetSystemInstanceResponseTypeDef:
return {
"description": ...,
"ResponseMetadata": ...,
}