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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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