Skip to content

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.