Skip to content

Type definitions#

Index > IoTThingsGraph > Type definitions

Auto-generated documentation for IoTThingsGraph type annotations stubs module mypy-boto3-iotthingsgraph.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AssociateEntityToThingRequestRequestTypeDef#

# AssociateEntityToThingRequestRequestTypeDef definition

class AssociateEntityToThingRequestRequestTypeDef(TypedDict):
    thingName: str,
    entityId: str,
    namespaceVersion: NotRequired[int],

DefinitionDocumentTypeDef#

# DefinitionDocumentTypeDef definition

class DefinitionDocumentTypeDef(TypedDict):
    language: DefinitionLanguageType,  # (1)
    text: str,
  1. See DefinitionLanguageType

FlowTemplateSummaryTypeDef#

# FlowTemplateSummaryTypeDef definition

class FlowTemplateSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    revisionNumber: NotRequired[int],
    createdAt: NotRequired[datetime],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

MetricsConfigurationTypeDef#

# MetricsConfigurationTypeDef definition

class MetricsConfigurationTypeDef(TypedDict):
    cloudMetricEnabled: NotRequired[bool],
    metricRuleRoleArn: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

SystemInstanceSummaryTypeDef#

# SystemInstanceSummaryTypeDef 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],
  1. See SystemInstanceDeploymentStatusType
  2. See DeploymentTargetType

SystemTemplateSummaryTypeDef#

# SystemTemplateSummaryTypeDef definition

class SystemTemplateSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    revisionNumber: NotRequired[int],
    createdAt: NotRequired[datetime],

DeleteFlowTemplateRequestRequestTypeDef#

# DeleteFlowTemplateRequestRequestTypeDef definition

class DeleteFlowTemplateRequestRequestTypeDef(TypedDict):
    id: str,

DeleteSystemInstanceRequestRequestTypeDef#

# DeleteSystemInstanceRequestRequestTypeDef definition

class DeleteSystemInstanceRequestRequestTypeDef(TypedDict):
    id: NotRequired[str],

DeleteSystemTemplateRequestRequestTypeDef#

# DeleteSystemTemplateRequestRequestTypeDef definition

class DeleteSystemTemplateRequestRequestTypeDef(TypedDict):
    id: str,

DependencyRevisionTypeDef#

# DependencyRevisionTypeDef definition

class DependencyRevisionTypeDef(TypedDict):
    id: NotRequired[str],
    revisionNumber: NotRequired[int],

DeploySystemInstanceRequestRequestTypeDef#

# DeploySystemInstanceRequestRequestTypeDef definition

class DeploySystemInstanceRequestRequestTypeDef(TypedDict):
    id: NotRequired[str],

DeprecateFlowTemplateRequestRequestTypeDef#

# DeprecateFlowTemplateRequestRequestTypeDef definition

class DeprecateFlowTemplateRequestRequestTypeDef(TypedDict):
    id: str,

DeprecateSystemTemplateRequestRequestTypeDef#

# DeprecateSystemTemplateRequestRequestTypeDef definition

class DeprecateSystemTemplateRequestRequestTypeDef(TypedDict):
    id: str,

DescribeNamespaceRequestRequestTypeDef#

# DescribeNamespaceRequestRequestTypeDef definition

class DescribeNamespaceRequestRequestTypeDef(TypedDict):
    namespaceName: NotRequired[str],

DissociateEntityFromThingRequestRequestTypeDef#

# DissociateEntityFromThingRequestRequestTypeDef definition

class DissociateEntityFromThingRequestRequestTypeDef(TypedDict):
    thingName: str,
    entityType: EntityTypeType,  # (1)
  1. See EntityTypeType

EntityFilterTypeDef#

# EntityFilterTypeDef definition

class EntityFilterTypeDef(TypedDict):
    name: NotRequired[EntityFilterNameType],  # (1)
    value: NotRequired[Sequence[str]],
  1. See EntityFilterNameType

FlowExecutionMessageTypeDef#

# FlowExecutionMessageTypeDef definition

class FlowExecutionMessageTypeDef(TypedDict):
    messageId: NotRequired[str],
    eventType: NotRequired[FlowExecutionEventTypeType],  # (1)
    timestamp: NotRequired[datetime],
    payload: NotRequired[str],
  1. See FlowExecutionEventTypeType

FlowExecutionSummaryTypeDef#

# FlowExecutionSummaryTypeDef definition

class FlowExecutionSummaryTypeDef(TypedDict):
    flowExecutionId: NotRequired[str],
    status: NotRequired[FlowExecutionStatusType],  # (1)
    systemInstanceId: NotRequired[str],
    flowTemplateId: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
  1. See FlowExecutionStatusType

FlowTemplateFilterTypeDef#

# FlowTemplateFilterTypeDef definition

class FlowTemplateFilterTypeDef(TypedDict):
    name: FlowTemplateFilterNameType,  # (1)
    value: Sequence[str],
  1. See FlowTemplateFilterNameType

GetEntitiesRequestRequestTypeDef#

# GetEntitiesRequestRequestTypeDef definition

class GetEntitiesRequestRequestTypeDef(TypedDict):
    ids: Sequence[str],
    namespaceVersion: NotRequired[int],

GetFlowTemplateRequestRequestTypeDef#

# GetFlowTemplateRequestRequestTypeDef definition

class GetFlowTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    revisionNumber: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetFlowTemplateRevisionsRequestRequestTypeDef#

# GetFlowTemplateRevisionsRequestRequestTypeDef definition

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

GetSystemInstanceRequestRequestTypeDef#

# GetSystemInstanceRequestRequestTypeDef definition

class GetSystemInstanceRequestRequestTypeDef(TypedDict):
    id: str,

GetSystemTemplateRequestRequestTypeDef#

# GetSystemTemplateRequestRequestTypeDef definition

class GetSystemTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    revisionNumber: NotRequired[int],

GetSystemTemplateRevisionsRequestRequestTypeDef#

# GetSystemTemplateRevisionsRequestRequestTypeDef definition

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

GetUploadStatusRequestRequestTypeDef#

# GetUploadStatusRequestRequestTypeDef definition

class GetUploadStatusRequestRequestTypeDef(TypedDict):
    uploadId: str,

ListFlowExecutionMessagesRequestRequestTypeDef#

# ListFlowExecutionMessagesRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

SystemInstanceFilterTypeDef#

# SystemInstanceFilterTypeDef definition

class SystemInstanceFilterTypeDef(TypedDict):
    name: NotRequired[SystemInstanceFilterNameType],  # (1)
    value: NotRequired[Sequence[str]],
  1. See SystemInstanceFilterNameType

SystemTemplateFilterTypeDef#

# SystemTemplateFilterTypeDef definition

class SystemTemplateFilterTypeDef(TypedDict):
    name: SystemTemplateFilterNameType,  # (1)
    value: Sequence[str],
  1. See SystemTemplateFilterNameType

SearchThingsRequestRequestTypeDef#

# SearchThingsRequestRequestTypeDef definition

class SearchThingsRequestRequestTypeDef(TypedDict):
    entityId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    namespaceVersion: NotRequired[int],

ThingTypeDef#

# ThingTypeDef definition

class ThingTypeDef(TypedDict):
    thingArn: NotRequired[str],
    thingName: NotRequired[str],

UndeploySystemInstanceRequestRequestTypeDef#

# UndeploySystemInstanceRequestRequestTypeDef definition

class UndeploySystemInstanceRequestRequestTypeDef(TypedDict):
    id: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

CreateFlowTemplateRequestRequestTypeDef#

# CreateFlowTemplateRequestRequestTypeDef definition

class CreateFlowTemplateRequestRequestTypeDef(TypedDict):
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: NotRequired[int],
  1. See DefinitionDocumentTypeDef

CreateSystemTemplateRequestRequestTypeDef#

# CreateSystemTemplateRequestRequestTypeDef definition

class CreateSystemTemplateRequestRequestTypeDef(TypedDict):
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: NotRequired[int],
  1. See DefinitionDocumentTypeDef

EntityDescriptionTypeDef#

# EntityDescriptionTypeDef definition

class EntityDescriptionTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    type: NotRequired[EntityTypeType],  # (1)
    createdAt: NotRequired[datetime],
    definition: NotRequired[DefinitionDocumentTypeDef],  # (2)
  1. See EntityTypeType
  2. See DefinitionDocumentTypeDef

UpdateFlowTemplateRequestRequestTypeDef#

# UpdateFlowTemplateRequestRequestTypeDef definition

class UpdateFlowTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: NotRequired[int],
  1. See DefinitionDocumentTypeDef

UpdateSystemTemplateRequestRequestTypeDef#

# UpdateSystemTemplateRequestRequestTypeDef definition

class UpdateSystemTemplateRequestRequestTypeDef(TypedDict):
    id: str,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: NotRequired[int],
  1. See DefinitionDocumentTypeDef

UploadEntityDefinitionsRequestRequestTypeDef#

# UploadEntityDefinitionsRequestRequestTypeDef definition

class UploadEntityDefinitionsRequestRequestTypeDef(TypedDict):
    document: NotRequired[DefinitionDocumentTypeDef],  # (1)
    syncWithPublicNamespace: NotRequired[bool],
    deprecateExistingEntities: NotRequired[bool],
  1. See DefinitionDocumentTypeDef

FlowTemplateDescriptionTypeDef#

# FlowTemplateDescriptionTypeDef definition

class FlowTemplateDescriptionTypeDef(TypedDict):
    summary: NotRequired[FlowTemplateSummaryTypeDef],  # (1)
    definition: NotRequired[DefinitionDocumentTypeDef],  # (2)
    validatedNamespaceVersion: NotRequired[int],
  1. See FlowTemplateSummaryTypeDef
  2. See DefinitionDocumentTypeDef

CreateFlowTemplateResponseTypeDef#

# CreateFlowTemplateResponseTypeDef definition

class CreateFlowTemplateResponseTypeDef(TypedDict):
    summary: FlowTemplateSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

DeleteNamespaceResponseTypeDef#

# DeleteNamespaceResponseTypeDef definition

class DeleteNamespaceResponseTypeDef(TypedDict):
    namespaceArn: str,
    namespaceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeNamespaceResponseTypeDef#

# DescribeNamespaceResponseTypeDef definition

class DescribeNamespaceResponseTypeDef(TypedDict):
    namespaceArn: str,
    namespaceName: str,
    trackingNamespaceName: str,
    trackingNamespaceVersion: int,
    namespaceVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetFlowTemplateRevisionsResponseTypeDef#

# GetFlowTemplateRevisionsResponseTypeDef definition

class GetFlowTemplateRevisionsResponseTypeDef(TypedDict):
    summaries: List[FlowTemplateSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetNamespaceDeletionStatusResponseTypeDef#

# GetNamespaceDeletionStatusResponseTypeDef definition

class GetNamespaceDeletionStatusResponseTypeDef(TypedDict):
    namespaceArn: str,
    namespaceName: str,
    status: NamespaceDeletionStatusType,  # (1)
    errorCode: NamespaceDeletionStatusErrorCodesType,  # (2)
    errorMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See NamespaceDeletionStatusType
  2. See NamespaceDeletionStatusErrorCodesType
  3. See ResponseMetadataTypeDef

GetUploadStatusResponseTypeDef#

# GetUploadStatusResponseTypeDef definition

class GetUploadStatusResponseTypeDef(TypedDict):
    uploadId: str,
    uploadStatus: UploadStatusType,  # (1)
    namespaceArn: str,
    namespaceName: str,
    namespaceVersion: int,
    failureReason: List[str],
    createdDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UploadStatusType
  2. See ResponseMetadataTypeDef

SearchFlowTemplatesResponseTypeDef#

# SearchFlowTemplatesResponseTypeDef definition

class SearchFlowTemplatesResponseTypeDef(TypedDict):
    summaries: List[FlowTemplateSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

UpdateFlowTemplateResponseTypeDef#

# UpdateFlowTemplateResponseTypeDef definition

class UpdateFlowTemplateResponseTypeDef(TypedDict):
    summary: FlowTemplateSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

UploadEntityDefinitionsResponseTypeDef#

# UploadEntityDefinitionsResponseTypeDef definition

class UploadEntityDefinitionsResponseTypeDef(TypedDict):
    uploadId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSystemInstanceRequestRequestTypeDef#

# CreateSystemInstanceRequestRequestTypeDef 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],
  1. See DefinitionDocumentTypeDef
  2. See DeploymentTargetType
  3. See TagTypeDef
  4. See MetricsConfigurationTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSystemInstanceResponseTypeDef#

# CreateSystemInstanceResponseTypeDef definition

class CreateSystemInstanceResponseTypeDef(TypedDict):
    summary: SystemInstanceSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

DeploySystemInstanceResponseTypeDef#

# DeploySystemInstanceResponseTypeDef definition

class DeploySystemInstanceResponseTypeDef(TypedDict):
    summary: SystemInstanceSummaryTypeDef,  # (1)
    greengrassDeploymentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchSystemInstancesResponseTypeDef#

# SearchSystemInstancesResponseTypeDef definition

class SearchSystemInstancesResponseTypeDef(TypedDict):
    summaries: List[SystemInstanceSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

UndeploySystemInstanceResponseTypeDef#

# UndeploySystemInstanceResponseTypeDef definition

class UndeploySystemInstanceResponseTypeDef(TypedDict):
    summary: SystemInstanceSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateSystemTemplateResponseTypeDef#

# CreateSystemTemplateResponseTypeDef definition

class CreateSystemTemplateResponseTypeDef(TypedDict):
    summary: SystemTemplateSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetSystemTemplateRevisionsResponseTypeDef#

# GetSystemTemplateRevisionsResponseTypeDef definition

class GetSystemTemplateRevisionsResponseTypeDef(TypedDict):
    summaries: List[SystemTemplateSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchSystemTemplatesResponseTypeDef#

# SearchSystemTemplatesResponseTypeDef definition

class SearchSystemTemplatesResponseTypeDef(TypedDict):
    summaries: List[SystemTemplateSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

SystemTemplateDescriptionTypeDef#

# SystemTemplateDescriptionTypeDef definition

class SystemTemplateDescriptionTypeDef(TypedDict):
    summary: NotRequired[SystemTemplateSummaryTypeDef],  # (1)
    definition: NotRequired[DefinitionDocumentTypeDef],  # (2)
    validatedNamespaceVersion: NotRequired[int],
  1. See SystemTemplateSummaryTypeDef
  2. See DefinitionDocumentTypeDef

UpdateSystemTemplateResponseTypeDef#

# UpdateSystemTemplateResponseTypeDef definition

class UpdateSystemTemplateResponseTypeDef(TypedDict):
    summary: SystemTemplateSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SystemTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

SystemInstanceDescriptionTypeDef#

# SystemInstanceDescriptionTypeDef 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],
  1. See SystemInstanceSummaryTypeDef
  2. See