Skip to content

Iotthingsgraph Classes

AssociateEntityToThingRequest

thingName

  • Type:
  • Required: Yes

entityId

  • Type:
  • Required: Yes

namespaceVersion

  • Type: typing.Optional[int]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreateFlowTemplateRequest

definition

  • Type:
  • Required: Yes

compatibleNamespaceVersion

  • Type: typing.Optional[int]

CreateFlowTemplateResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSystemInstanceRequest

definition

  • Type:
  • Required: Yes

target

  • Type: typing.Literal['CLOUD', 'GREENGRASS']
  • Required: Yes

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.Tag]]

greengrassGroupName

  • Type: typing.Optional[str]

s3BucketName

  • Type: typing.Optional[str]

metricsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.MetricsConfiguration]

flowActionsRoleArn

  • Type: typing.Optional[str]

CreateSystemInstanceResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSystemTemplateRequest

definition

  • Type:
  • Required: Yes

compatibleNamespaceVersion

  • Type: typing.Optional[int]

CreateSystemTemplateResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DefinitionDocument

language

  • Type: typing.Literal['GRAPHQL']
  • Required: Yes

text

  • Type:
  • Required: Yes

DeleteFlowTemplateRequest

id

  • Type:
  • Required: Yes

DeleteNamespaceResponse

namespaceArn

  • Type:
  • Required: Yes

namespaceName

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteSystemInstanceRequest

id

  • Type: typing.Optional[str]

DeleteSystemTemplateRequest

id

  • Type:
  • Required: Yes

DependencyRevision

id

  • Type: typing.Optional[str]

revisionNumber

  • Type: typing.Optional[int]

DeploySystemInstanceRequest

id

  • Type: typing.Optional[str]

DeploySystemInstanceResponse

summary

  • Type:
  • Required: Yes

greengrassDeploymentId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeprecateFlowTemplateRequest

id

  • Type:
  • Required: Yes

DeprecateSystemTemplateRequest

id

  • Type:
  • Required: Yes

DescribeNamespaceRequest

namespaceName

  • Type: typing.Optional[str]

DescribeNamespaceResponse

namespaceArn

  • Type:
  • Required: Yes

namespaceName

  • Type:
  • Required: Yes

trackingNamespaceName

  • Type:
  • Required: Yes

trackingNamespaceVersion

  • Type:
  • Required: Yes

namespaceVersion

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DissociateEntityFromThingRequest

thingName

  • Type:
  • Required: Yes

entityType

  • Type: typing.Literal['ACTION', 'CAPABILITY', 'DEVICE', 'DEVICE_MODEL', 'ENUM', 'EVENT', 'MAPPING', 'PROPERTY', 'SERVICE', 'STATE']
  • Required: Yes

EntityDescription

id

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['ACTION', 'CAPABILITY', 'DEVICE', 'DEVICE_MODEL', 'ENUM', 'EVENT', 'MAPPING', 'PROPERTY', 'SERVICE', 'STATE']]

createdAt

  • Type: typing.Optional[datetime.datetime]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DefinitionDocument]

EntityFilter

name

  • Type: typing.Optional[typing.Literal['NAME', 'NAMESPACE', 'REFERENCED_ENTITY_ID', 'SEMANTIC_TYPE_PATH']]

value

  • Type: typing.Optional[typing.List[str]]

FlowExecutionMessage

messageId

  • Type: typing.Optional[str]

eventType

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGE_TASK_MESSAGE', 'ACTIVITY_FAILED', 'ACTIVITY_SCHEDULED', 'ACTIVITY_STARTED', 'ACTIVITY_SUCCEEDED', 'EXECUTION_ABORTED', 'EXECUTION_FAILED', 'EXECUTION_STARTED', 'EXECUTION_SUCCEEDED', 'SCHEDULE_NEXT_READY_STEPS_TASK', 'START_FLOW_EXECUTION_TASK', 'STEP_FAILED', 'STEP_STARTED', 'STEP_SUCCEEDED', 'THING_ACTION_TASK', 'THING_ACTION_TASK_FAILED', 'THING_ACTION_TASK_SUCCEEDED']]

timestamp

  • Type: typing.Optional[datetime.datetime]

payload

  • Type: typing.Optional[str]

FlowExecutionSummary

flowExecutionId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'RUNNING', 'SUCCEEDED']]

systemInstanceId

  • Type: typing.Optional[str]

flowTemplateId

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

FlowTemplateDescription

summary

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowTemplateSummary]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DefinitionDocument]

validatedNamespaceVersion

  • Type: typing.Optional[int]

FlowTemplateFilter

name

  • Type: typing.Literal['DEVICE_MODEL_ID']
  • Required: Yes

value

  • Type: typing.List[str]
  • Required: Yes

FlowTemplateSummary

id

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

revisionNumber

  • Type: typing.Optional[int]

createdAt

  • Type: typing.Optional[datetime.datetime]

GetEntitiesRequest

ids

  • Type: typing.List[str]
  • Required: Yes

namespaceVersion

  • Type: typing.Optional[int]

GetEntitiesResponse

descriptions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.EntityDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFlowTemplateRequest

id

  • Type:
  • Required: Yes

revisionNumber

  • Type: typing.Optional[int]

GetFlowTemplateResponse

description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFlowTemplateRevisionsRequest

id

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetFlowTemplateRevisionsRequestPaginate

id

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

GetFlowTemplateRevisionsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowTemplateSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetNamespaceDeletionStatusResponse

namespaceArn

  • Type:
  • Required: Yes

namespaceName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['FAILED', 'IN_PROGRESS', 'SUCCEEDED']
  • Required: Yes

errorCode

  • Type: typing.Literal['VALIDATION_FAILED']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSystemInstanceRequest

id

  • Type:
  • Required: Yes

GetSystemInstanceResponse

description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSystemTemplateRequest

id

  • Type:
  • Required: Yes

revisionNumber

  • Type: typing.Optional[int]

GetSystemTemplateResponse

description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSystemTemplateRevisionsRequest

id

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetSystemTemplateRevisionsRequestPaginate

id

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

GetSystemTemplateRevisionsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemTemplateSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetUploadStatusRequest

uploadId

  • Type:
  • Required: Yes

GetUploadStatusResponse

uploadId

  • Type:
  • Required: Yes

uploadStatus

  • Type: typing.Literal['FAILED', 'IN_PROGRESS', 'SUCCEEDED']
  • Required: Yes

namespaceArn

  • Type:
  • Required: Yes

namespaceName

  • Type:
  • Required: Yes

namespaceVersion

  • Type:
  • Required: Yes

failureReason

  • Type: typing.List[str]
  • Required: Yes

createdDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListFlowExecutionMessagesRequest

flowExecutionId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListFlowExecutionMessagesRequestPaginate

flowExecutionId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

ListFlowExecutionMessagesResponse

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowExecutionMessage]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequestPaginate

resourceArn

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

ListTagsForResourceResponse

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

MetricsConfiguration

cloudMetricEnabled

  • Type: typing.Optional[bool]

metricRuleRoleArn

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SearchEntitiesRequest

entityTypes

  • Type: typing.List[typing.Literal['ACTION', 'CAPABILITY', 'DEVICE', 'DEVICE_MODEL', 'ENUM', 'EVENT', 'MAPPING', 'PROPERTY', 'SERVICE', 'STATE']]
  • Required: Yes

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.EntityFilter]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

namespaceVersion

  • Type: typing.Optional[int]

SearchEntitiesRequestPaginate

entityTypes

  • Type: typing.List[typing.Literal['ACTION', 'CAPABILITY', 'DEVICE', 'DEVICE_MODEL', 'ENUM', 'EVENT', 'MAPPING', 'PROPERTY', 'SERVICE', 'STATE']]
  • Required: Yes

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.EntityFilter]]

namespaceVersion

  • Type: typing.Optional[int]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchEntitiesResponse

descriptions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.EntityDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchFlowExecutionsRequest

systemInstanceId

  • Type:
  • Required: Yes

flowExecutionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

SearchFlowExecutionsRequestPaginate

systemInstanceId

  • Type:
  • Required: Yes

flowExecutionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchFlowExecutionsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowExecutionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchFlowTemplatesRequest

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowTemplateFilter]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

SearchFlowTemplatesRequestPaginate

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowTemplateFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchFlowTemplatesResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.FlowTemplateSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchSystemInstancesRequest

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemInstanceFilter]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

SearchSystemInstancesRequestPaginate

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemInstanceFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchSystemInstancesResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemInstanceSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchSystemTemplatesRequest

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemTemplateFilter]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

SearchSystemTemplatesRequestPaginate

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemTemplateFilter]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchSystemTemplatesResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemTemplateSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchThingsRequest

entityId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

namespaceVersion

  • Type: typing.Optional[int]

SearchThingsRequestPaginate

entityId

  • Type:
  • Required: Yes

namespaceVersion

  • Type: typing.Optional[int]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.PaginatorConfig]

SearchThingsResponse

things

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.Thing]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SystemInstanceDescription

summary

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemInstanceSummary]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DefinitionDocument]

s3BucketName

  • Type: typing.Optional[str]

metricsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.MetricsConfiguration]

validatedNamespaceVersion

  • Type: typing.Optional[int]

validatedDependencyRevisions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DependencyRevision]]

flowActionsRoleArn

  • Type: typing.Optional[str]

SystemInstanceFilter

name

  • Type: typing.Optional[typing.Literal['GREENGRASS_GROUP_NAME', 'STATUS', 'SYSTEM_TEMPLATE_ID']]

value

  • Type: typing.Optional[typing.List[str]]

SystemInstanceSummary

id

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['BOOTSTRAP', 'DELETED_IN_TARGET', 'DEPLOYED_IN_TARGET', 'DEPLOY_IN_PROGRESS', 'FAILED', 'NOT_DEPLOYED', 'PENDING_DELETE', 'UNDEPLOY_IN_PROGRESS']]

target

  • Type: typing.Optional[typing.Literal['CLOUD', 'GREENGRASS']]

greengrassGroupName

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

greengrassGroupId

  • Type: typing.Optional[str]

greengrassGroupVersionId

  • Type: typing.Optional[str]

SystemTemplateDescription

summary

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.SystemTemplateSummary]

definition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DefinitionDocument]

validatedNamespaceVersion

  • Type: typing.Optional[int]

SystemTemplateFilter

name

  • Type: typing.Literal['FLOW_TEMPLATE_ID']
  • Required: Yes

value

  • Type: typing.List[str]
  • Required: Yes

SystemTemplateSummary

id

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

revisionNumber

  • Type: typing.Optional[int]

createdAt

  • Type: typing.Optional[datetime.datetime]

Tag

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.Tag]
  • Required: Yes

Thing

thingArn

  • Type: typing.Optional[str]

thingName

  • Type: typing.Optional[str]

UndeploySystemInstanceRequest

id

  • Type: typing.Optional[str]

UndeploySystemInstanceResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateFlowTemplateRequest

id

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

compatibleNamespaceVersion

  • Type: typing.Optional[int]

UpdateFlowTemplateResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateSystemTemplateRequest

id

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

compatibleNamespaceVersion

  • Type: typing.Optional[int]

UpdateSystemTemplateResponse

summary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UploadEntityDefinitionsRequest

document

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotthingsgraph.iotthingsgraph_classes.DefinitionDocument]

syncWithPublicNamespace

  • Type: typing.Optional[bool]

deprecateExistingEntities

  • Type: typing.Optional[bool]

UploadEntityDefinitionsResponse

uploadId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes