IoTThingsGraphClient

Index > IoTThingsGraph > IoTThingsGraphClient

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

IoTThingsGraphClient

Type annotations and code completion for boto3.client("iotthingsgraph"). boto3 documentation

# IoTThingsGraphClient usage example

from boto3.session import Session
from mypy_boto3_iotthingsgraph.client import IoTThingsGraphClient

def get_iotthingsgraph_client() -> IoTThingsGraphClient:
    return Session().client("iotthingsgraph")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iotthingsgraph").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("iotthingsgraph")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_iotthingsgraph.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_entity_to_thing

Associates a device with a concrete thing that is in the user's registry.

Type annotations and code completion for boto3.client("iotthingsgraph").associate_entity_to_thing method. boto3 documentation

# associate_entity_to_thing method definition

def associate_entity_to_thing(
    self,
    *,
    thingName: str,
    entityId: str,
    namespaceVersion: int = ...,
) -> Dict[str, Any]:
    ...

# associate_entity_to_thing method usage example with argument unpacking

kwargs: AssociateEntityToThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
    "entityId": ...,
}

parent.associate_entity_to_thing(**kwargs)

1. See AssociateEntityToThingRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iotthingsgraph").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iotthingsgraph").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_flow_template

Creates a workflow template.

Type annotations and code completion for boto3.client("iotthingsgraph").create_flow_template method. boto3 documentation

# create_flow_template method definition

def create_flow_template(
    self,
    *,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: int = ...,
) -> CreateFlowTemplateResponseTypeDef:  # (2)
    ...

1. See DefinitionDocumentTypeDef
2. See CreateFlowTemplateResponseTypeDef

# create_flow_template method usage example with argument unpacking

kwargs: CreateFlowTemplateRequestRequestTypeDef = {  # (1)
    "definition": ...,
}

parent.create_flow_template(**kwargs)

1. See CreateFlowTemplateRequestRequestTypeDef

create_system_instance

Creates a system instance.

Type annotations and code completion for boto3.client("iotthingsgraph").create_system_instance method. boto3 documentation

# create_system_instance method definition

def create_system_instance(
    self,
    *,
    definition: DefinitionDocumentTypeDef,  # (1)
    target: DeploymentTargetType,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
    greengrassGroupName: str = ...,
    s3BucketName: str = ...,
    metricsConfiguration: MetricsConfigurationTypeDef = ...,  # (4)
    flowActionsRoleArn: str = ...,
) -> CreateSystemInstanceResponseTypeDef:  # (5)
    ...

1. See DefinitionDocumentTypeDef
2. See DeploymentTargetType
3. See TagTypeDef
4. See MetricsConfigurationTypeDef
5. See CreateSystemInstanceResponseTypeDef

# create_system_instance method usage example with argument unpacking

kwargs: CreateSystemInstanceRequestRequestTypeDef = {  # (1)
    "definition": ...,
    "target": ...,
}

parent.create_system_instance(**kwargs)

1. See CreateSystemInstanceRequestRequestTypeDef

create_system_template

Creates a system.

Type annotations and code completion for boto3.client("iotthingsgraph").create_system_template method. boto3 documentation

# create_system_template method definition

def create_system_template(
    self,
    *,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: int = ...,
) -> CreateSystemTemplateResponseTypeDef:  # (2)
    ...

1. See DefinitionDocumentTypeDef
2. See CreateSystemTemplateResponseTypeDef

# create_system_template method usage example with argument unpacking

kwargs: CreateSystemTemplateRequestRequestTypeDef = {  # (1)
    "definition": ...,
}

parent.create_system_template(**kwargs)

1. See CreateSystemTemplateRequestRequestTypeDef

delete_flow_template

Deletes a workflow.

Type annotations and code completion for boto3.client("iotthingsgraph").delete_flow_template method. boto3 documentation

# delete_flow_template method definition

def delete_flow_template(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

# delete_flow_template method usage example with argument unpacking

kwargs: DeleteFlowTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_flow_template(**kwargs)

1. See DeleteFlowTemplateRequestRequestTypeDef

delete_namespace

Deletes the specified namespace.

Type annotations and code completion for boto3.client("iotthingsgraph").delete_namespace method. boto3 documentation

# delete_namespace method definition

def delete_namespace(
    self,
) -> DeleteNamespaceResponseTypeDef:  # (1)
    ...

1. See DeleteNamespaceResponseTypeDef

delete_system_instance

Deletes a system instance.

Type annotations and code completion for boto3.client("iotthingsgraph").delete_system_instance method. boto3 documentation

# delete_system_instance method definition

def delete_system_instance(
    self,
    *,
    id: str = ...,
) -> Dict[str, Any]:
    ...

# delete_system_instance method usage example with argument unpacking

kwargs: DeleteSystemInstanceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_system_instance(**kwargs)

1. See DeleteSystemInstanceRequestRequestTypeDef

delete_system_template

Deletes a system.

Type annotations and code completion for boto3.client("iotthingsgraph").delete_system_template method. boto3 documentation

# delete_system_template method definition

def delete_system_template(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

# delete_system_template method usage example with argument unpacking

kwargs: DeleteSystemTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_system_template(**kwargs)

1. See DeleteSystemTemplateRequestRequestTypeDef

deploy_system_instance

Greengrass and Cloud Deployments Deploys the system instance to the target specified in CreateSystemInstance.

Type annotations and code completion for boto3.client("iotthingsgraph").deploy_system_instance method. boto3 documentation

# deploy_system_instance method definition

def deploy_system_instance(
    self,
    *,
    id: str = ...,
) -> DeploySystemInstanceResponseTypeDef:  # (1)
    ...

1. See DeploySystemInstanceResponseTypeDef

# deploy_system_instance method usage example with argument unpacking

kwargs: DeploySystemInstanceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.deploy_system_instance(**kwargs)

1. See DeploySystemInstanceRequestRequestTypeDef

deprecate_flow_template

Deprecates the specified workflow.

Type annotations and code completion for boto3.client("iotthingsgraph").deprecate_flow_template method. boto3 documentation

# deprecate_flow_template method definition

def deprecate_flow_template(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

# deprecate_flow_template method usage example with argument unpacking

kwargs: DeprecateFlowTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.deprecate_flow_template(**kwargs)

1. See DeprecateFlowTemplateRequestRequestTypeDef

deprecate_system_template

Deprecates the specified system.

Type annotations and code completion for boto3.client("iotthingsgraph").deprecate_system_template method. boto3 documentation

# deprecate_system_template method definition

def deprecate_system_template(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

# deprecate_system_template method usage example with argument unpacking

kwargs: DeprecateSystemTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.deprecate_system_template(**kwargs)

1. See DeprecateSystemTemplateRequestRequestTypeDef

describe_namespace

Gets the latest version of the user's namespace and the public version that it is tracking.

Type annotations and code completion for boto3.client("iotthingsgraph").describe_namespace method. boto3 documentation

# describe_namespace method definition

def describe_namespace(
    self,
    *,
    namespaceName: str = ...,
) -> DescribeNamespaceResponseTypeDef:  # (1)
    ...

1. See DescribeNamespaceResponseTypeDef

# describe_namespace method usage example with argument unpacking

kwargs: DescribeNamespaceRequestRequestTypeDef = {  # (1)
    "namespaceName": ...,
}

parent.describe_namespace(**kwargs)

1. See DescribeNamespaceRequestRequestTypeDef

dissociate_entity_from_thing

Dissociates a device entity from a concrete thing.

Type annotations and code completion for boto3.client("iotthingsgraph").dissociate_entity_from_thing method. boto3 documentation

# dissociate_entity_from_thing method definition

def dissociate_entity_from_thing(
    self,
    *,
    thingName: str,
    entityType: EntityTypeType,  # (1)
) -> Dict[str, Any]:
    ...

1. See EntityTypeType

# dissociate_entity_from_thing method usage example with argument unpacking

kwargs: DissociateEntityFromThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
    "entityType": ...,
}

parent.dissociate_entity_from_thing(**kwargs)

1. See DissociateEntityFromThingRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("iotthingsgraph").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_entities

Gets definitions of the specified entities.

Type annotations and code completion for boto3.client("iotthingsgraph").get_entities method. boto3 documentation

# get_entities method definition

def get_entities(
    self,
    *,
    ids: Sequence[str],
    namespaceVersion: int = ...,
) -> GetEntitiesResponseTypeDef:  # (1)
    ...

1. See GetEntitiesResponseTypeDef

# get_entities method usage example with argument unpacking

kwargs: GetEntitiesRequestRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.get_entities(**kwargs)

1. See GetEntitiesRequestRequestTypeDef

get_flow_template

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

Type annotations and code completion for boto3.client("iotthingsgraph").get_flow_template method. boto3 documentation

# get_flow_template method definition

def get_flow_template(
    self,
    *,
    id: str,
    revisionNumber: int = ...,
) -> GetFlowTemplateResponseTypeDef:  # (1)
    ...

1. See GetFlowTemplateResponseTypeDef

# get_flow_template method usage example with argument unpacking

kwargs: GetFlowTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_flow_template(**kwargs)

1. See GetFlowTemplateRequestRequestTypeDef

get_flow_template_revisions

Gets revisions of the specified workflow.

Type annotations and code completion for boto3.client("iotthingsgraph").get_flow_template_revisions method. boto3 documentation

# get_flow_template_revisions method definition

def get_flow_template_revisions(
    self,
    *,
    id: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetFlowTemplateRevisionsResponseTypeDef:  # (1)
    ...

1. See GetFlowTemplateRevisionsResponseTypeDef

# get_flow_template_revisions method usage example with argument unpacking

kwargs: GetFlowTemplateRevisionsRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_flow_template_revisions(**kwargs)

1. See GetFlowTemplateRevisionsRequestRequestTypeDef

get_namespace_deletion_status

Gets the status of a namespace deletion task.

Type annotations and code completion for boto3.client("iotthingsgraph").get_namespace_deletion_status method. boto3 documentation

# get_namespace_deletion_status method definition

def get_namespace_deletion_status(
    self,
) -> GetNamespaceDeletionStatusResponseTypeDef:  # (1)
    ...

1. See GetNamespaceDeletionStatusResponseTypeDef

get_system_instance

Gets a system instance.

Type annotations and code completion for boto3.client("iotthingsgraph").get_system_instance method. boto3 documentation

# get_system_instance method definition

def get_system_instance(
    self,
    *,
    id: str,
) -> GetSystemInstanceResponseTypeDef:  # (1)
    ...

1. See GetSystemInstanceResponseTypeDef

# get_system_instance method usage example with argument unpacking

kwargs: GetSystemInstanceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_system_instance(**kwargs)

1. See GetSystemInstanceRequestRequestTypeDef

get_system_template

Gets a system.

Type annotations and code completion for boto3.client("iotthingsgraph").get_system_template method. boto3 documentation

# get_system_template method definition

def get_system_template(
    self,
    *,
    id: str,
    revisionNumber: int = ...,
) -> GetSystemTemplateResponseTypeDef:  # (1)
    ...

1. See GetSystemTemplateResponseTypeDef

# get_system_template method usage example with argument unpacking

kwargs: GetSystemTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_system_template(**kwargs)

1. See GetSystemTemplateRequestRequestTypeDef

get_system_template_revisions

Gets revisions made to the specified system template.

Type annotations and code completion for boto3.client("iotthingsgraph").get_system_template_revisions method. boto3 documentation

# get_system_template_revisions method definition

def get_system_template_revisions(
    self,
    *,
    id: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetSystemTemplateRevisionsResponseTypeDef:  # (1)
    ...

1. See GetSystemTemplateRevisionsResponseTypeDef

# get_system_template_revisions method usage example with argument unpacking

kwargs: GetSystemTemplateRevisionsRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_system_template_revisions(**kwargs)

1. See GetSystemTemplateRevisionsRequestRequestTypeDef

get_upload_status

Gets the status of the specified upload.

Type annotations and code completion for boto3.client("iotthingsgraph").get_upload_status method. boto3 documentation

# get_upload_status method definition

def get_upload_status(
    self,
    *,
    uploadId: str,
) -> GetUploadStatusResponseTypeDef:  # (1)
    ...

1. See GetUploadStatusResponseTypeDef

# get_upload_status method usage example with argument unpacking

kwargs: GetUploadStatusRequestRequestTypeDef = {  # (1)
    "uploadId": ...,
}

parent.get_upload_status(**kwargs)

1. See GetUploadStatusRequestRequestTypeDef

list_flow_execution_messages

Returns a list of objects that contain information about events in a flow execution.

Type annotations and code completion for boto3.client("iotthingsgraph").list_flow_execution_messages method. boto3 documentation

# list_flow_execution_messages method definition

def list_flow_execution_messages(
    self,
    *,
    flowExecutionId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFlowExecutionMessagesResponseTypeDef:  # (1)
    ...

1. See ListFlowExecutionMessagesResponseTypeDef

# list_flow_execution_messages method usage example with argument unpacking

kwargs: ListFlowExecutionMessagesRequestRequestTypeDef = {  # (1)
    "flowExecutionId": ...,
}

parent.list_flow_execution_messages(**kwargs)

1. See ListFlowExecutionMessagesRequestRequestTypeDef

list_tags_for_resource

Lists all tags on an AWS IoT Things Graph resource.

Type annotations and code completion for boto3.client("iotthingsgraph").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

search_entities

Searches for entities of the specified type.

Type annotations and code completion for boto3.client("iotthingsgraph").search_entities method. boto3 documentation

# search_entities method definition

def search_entities(
    self,
    *,
    entityTypes: Sequence[EntityTypeType],  # (1)
    filters: Sequence[EntityFilterTypeDef] = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
    namespaceVersion: int = ...,
) -> SearchEntitiesResponseTypeDef:  # (3)
    ...

1. See EntityTypeType
2. See EntityFilterTypeDef
3. See SearchEntitiesResponseTypeDef

# search_entities method usage example with argument unpacking

kwargs: SearchEntitiesRequestRequestTypeDef = {  # (1)
    "entityTypes": ...,
}

parent.search_entities(**kwargs)

1. See SearchEntitiesRequestRequestTypeDef

search_flow_executions

Searches for AWS IoT Things Graph workflow execution instances.

Type annotations and code completion for boto3.client("iotthingsgraph").search_flow_executions method. boto3 documentation

# search_flow_executions method definition

def search_flow_executions(
    self,
    *,
    systemInstanceId: str,
    flowExecutionId: str = ...,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchFlowExecutionsResponseTypeDef:  # (1)
    ...

1. See SearchFlowExecutionsResponseTypeDef

# search_flow_executions method usage example with argument unpacking

kwargs: SearchFlowExecutionsRequestRequestTypeDef = {  # (1)
    "systemInstanceId": ...,
}

parent.search_flow_executions(**kwargs)

1. See SearchFlowExecutionsRequestRequestTypeDef

search_flow_templates

Searches for summary information about workflows.

Type annotations and code completion for boto3.client("iotthingsgraph").search_flow_templates method. boto3 documentation

# search_flow_templates method definition

def search_flow_templates(
    self,
    *,
    filters: Sequence[FlowTemplateFilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchFlowTemplatesResponseTypeDef:  # (2)
    ...

1. See FlowTemplateFilterTypeDef
2. See SearchFlowTemplatesResponseTypeDef

# search_flow_templates method usage example with argument unpacking

kwargs: SearchFlowTemplatesRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.search_flow_templates(**kwargs)

1. See SearchFlowTemplatesRequestRequestTypeDef

search_system_instances

Searches for system instances in the user's account.

Type annotations and code completion for boto3.client("iotthingsgraph").search_system_instances method. boto3 documentation

# search_system_instances method definition

def search_system_instances(
    self,
    *,
    filters: Sequence[SystemInstanceFilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchSystemInstancesResponseTypeDef:  # (2)
    ...

1. See SystemInstanceFilterTypeDef
2. See SearchSystemInstancesResponseTypeDef

# search_system_instances method usage example with argument unpacking

kwargs: SearchSystemInstancesRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.search_system_instances(**kwargs)

1. See SearchSystemInstancesRequestRequestTypeDef

search_system_templates

Searches for summary information about systems in the user's account.

Type annotations and code completion for boto3.client("iotthingsgraph").search_system_templates method. boto3 documentation

# search_system_templates method definition

def search_system_templates(
    self,
    *,
    filters: Sequence[SystemTemplateFilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> SearchSystemTemplatesResponseTypeDef:  # (2)
    ...

1. See SystemTemplateFilterTypeDef
2. See SearchSystemTemplatesResponseTypeDef

# search_system_templates method usage example with argument unpacking

kwargs: SearchSystemTemplatesRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.search_system_templates(**kwargs)

1. See SearchSystemTemplatesRequestRequestTypeDef

search_things

Searches for things associated with the specified entity.

Type annotations and code completion for boto3.client("iotthingsgraph").search_things method. boto3 documentation

# search_things method definition

def search_things(
    self,
    *,
    entityId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    namespaceVersion: int = ...,
) -> SearchThingsResponseTypeDef:  # (1)
    ...

1. See SearchThingsResponseTypeDef

# search_things method usage example with argument unpacking

kwargs: SearchThingsRequestRequestTypeDef = {  # (1)
    "entityId": ...,
}

parent.search_things(**kwargs)

1. See SearchThingsRequestRequestTypeDef

tag_resource

Creates a tag for the specified resource.

Type annotations and code completion for boto3.client("iotthingsgraph").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

undeploy_system_instance

Removes a system instance from its target (Cloud or Greengrass).

Type annotations and code completion for boto3.client("iotthingsgraph").undeploy_system_instance method. boto3 documentation

# undeploy_system_instance method definition

def undeploy_system_instance(
    self,
    *,
    id: str = ...,
) -> UndeploySystemInstanceResponseTypeDef:  # (1)
    ...

1. See UndeploySystemInstanceResponseTypeDef

# undeploy_system_instance method usage example with argument unpacking

kwargs: UndeploySystemInstanceRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.undeploy_system_instance(**kwargs)

1. See UndeploySystemInstanceRequestRequestTypeDef

untag_resource

Removes a tag from the specified resource.

Type annotations and code completion for boto3.client("iotthingsgraph").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_flow_template

Updates the specified workflow.

Type annotations and code completion for boto3.client("iotthingsgraph").update_flow_template method. boto3 documentation

# update_flow_template method definition

def update_flow_template(
    self,
    *,
    id: str,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: int = ...,
) -> UpdateFlowTemplateResponseTypeDef:  # (2)
    ...

1. See DefinitionDocumentTypeDef
2. See UpdateFlowTemplateResponseTypeDef

# update_flow_template method usage example with argument unpacking

kwargs: UpdateFlowTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
    "definition": ...,
}

parent.update_flow_template(**kwargs)

1. See UpdateFlowTemplateRequestRequestTypeDef

update_system_template

Updates the specified system.

Type annotations and code completion for boto3.client("iotthingsgraph").update_system_template method. boto3 documentation

# update_system_template method definition

def update_system_template(
    self,
    *,
    id: str,
    definition: DefinitionDocumentTypeDef,  # (1)
    compatibleNamespaceVersion: int = ...,
) -> UpdateSystemTemplateResponseTypeDef:  # (2)
    ...

1. See DefinitionDocumentTypeDef
2. See UpdateSystemTemplateResponseTypeDef

# update_system_template method usage example with argument unpacking

kwargs: UpdateSystemTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
    "definition": ...,
}

parent.update_system_template(**kwargs)

1. See UpdateSystemTemplateRequestRequestTypeDef

upload_entity_definitions

Asynchronously uploads one or more entity definitions to the user's namespace.

Type annotations and code completion for boto3.client("iotthingsgraph").upload_entity_definitions method. boto3 documentation

# upload_entity_definitions method definition

def upload_entity_definitions(
    self,
    *,
    document: DefinitionDocumentTypeDef = ...,  # (1)
    syncWithPublicNamespace: bool = ...,
    deprecateExistingEntities: bool = ...,
) -> UploadEntityDefinitionsResponseTypeDef:  # (2)
    ...

1. See DefinitionDocumentTypeDef
2. See UploadEntityDefinitionsResponseTypeDef

# upload_entity_definitions method usage example with argument unpacking

kwargs: UploadEntityDefinitionsRequestRequestTypeDef = {  # (1)
    "document": ...,
}

parent.upload_entity_definitions(**kwargs)

1. See UploadEntityDefinitionsRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("iotthingsgraph").get_paginator method with overloads.

• client.get_paginator("get_flow_template_revisions") -> GetFlowTemplateRevisionsPaginator
• client.get_paginator("get_system_template_revisions") -> GetSystemTemplateRevisionsPaginator
• client.get_paginator("list_flow_execution_messages") -> ListFlowExecutionMessagesPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("search_entities") -> SearchEntitiesPaginator
• client.get_paginator("search_flow_executions") -> SearchFlowExecutionsPaginator
• client.get_paginator("search_flow_templates") -> SearchFlowTemplatesPaginator
• client.get_paginator("search_system_instances") -> SearchSystemInstancesPaginator
• client.get_paginator("search_system_templates") -> SearchSystemTemplatesPaginator
• client.get_paginator("search_things") -> SearchThingsPaginator