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)
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)
...
# create_flow_template method usage example with argument unpacking
kwargs: CreateFlowTemplateRequestRequestTypeDef = { # (1)
"definition": ...,
}
parent.create_flow_template(**kwargs)
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 = ...,
) -&