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
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.
client = boto3.client("iotthingsgraph")
try:
do_something(client)
except (
client.ClientError,
client.InternalFailureException,
client.InvalidRequestException,
client.LimitExceededException,
client.ResourceAlreadyExistsException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ThrottlingException,
) as e:
print(e)
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
def associate_entity_to_thing(
self,
*,
thingName: str,
entityId: str,
namespaceVersion: int = ...,
) -> Dict[str, Any]:
...
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotthingsgraph").close
method.
boto3 documentation
create_flow_template
Creates a workflow template.
Type annotations and code completion for boto3.client("iotthingsgraph").create_flow_template
method.
boto3 documentation
def create_flow_template(
self,
*,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: int = ...,
) -> CreateFlowTemplateResponseTypeDef: # (2)
...
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
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)
...
- See DefinitionDocumentTypeDef
- See DeploymentTargetType
- See TagTypeDef
- See MetricsConfigurationTypeDef
- See CreateSystemInstanceResponseTypeDef
kwargs: CreateSystemInstanceRequestRequestTypeDef = { # (1)
"definition": ...,
"target": ...,
}
parent.create_system_instance(**kwargs)
create_system_template
Creates a system.
Type annotations and code completion for boto3.client("iotthingsgraph").create_system_template
method.
boto3 documentation
def create_system_template(
self,
*,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: int = ...,
) -> CreateSystemTemplateResponseTypeDef: # (2)
...
kwargs: CreateSystemTemplateRequestRequestTypeDef = { # (1)
"definition": ...,
}
parent.create_system_template(**kwargs)
delete_flow_template
Deletes a workflow.
Type annotations and code completion for boto3.client("iotthingsgraph").delete_flow_template
method.
boto3 documentation
kwargs: DeleteFlowTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_flow_template(**kwargs)
delete_namespace
Deletes the specified namespace.
Type annotations and code completion for boto3.client("iotthingsgraph").delete_namespace
method.
boto3 documentation
delete_system_instance
Deletes a system instance.
Type annotations and code completion for boto3.client("iotthingsgraph").delete_system_instance
method.
boto3 documentation
kwargs: DeleteSystemInstanceRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_system_instance(**kwargs)
delete_system_template
Deletes a system.
Type annotations and code completion for boto3.client("iotthingsgraph").delete_system_template
method.
boto3 documentation
kwargs: DeleteSystemTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_system_template(**kwargs)
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
def deploy_system_instance(
self,
*,
id: str = ...,
) -> DeploySystemInstanceResponseTypeDef: # (1)
...
kwargs: DeploySystemInstanceRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.deploy_system_instance(**kwargs)
deprecate_flow_template
Deprecates the specified workflow.
Type annotations and code completion for boto3.client("iotthingsgraph").deprecate_flow_template
method.
boto3 documentation
kwargs: DeprecateFlowTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.deprecate_flow_template(**kwargs)
deprecate_system_template
Deprecates the specified system.
Type annotations and code completion for boto3.client("iotthingsgraph").deprecate_system_template
method.
boto3 documentation
kwargs: DeprecateSystemTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.deprecate_system_template(**kwargs)
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
def describe_namespace(
self,
*,
namespaceName: str = ...,
) -> DescribeNamespaceResponseTypeDef: # (1)
...
kwargs: DescribeNamespaceRequestRequestTypeDef = { # (1)
"namespaceName": ...,
}
parent.describe_namespace(**kwargs)
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
def dissociate_entity_from_thing(
self,
*,
thingName: str,
entityType: EntityTypeType, # (1)
) -> Dict[str, Any]:
...
- See EntityTypeType
kwargs: DissociateEntityFromThingRequestRequestTypeDef = { # (1)
"thingName": ...,
"entityType": ...,
}
parent.dissociate_entity_from_thing(**kwargs)
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
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
def get_entities(
self,
*,
ids: Sequence[str],
namespaceVersion: int = ...,
) -> GetEntitiesResponseTypeDef: # (1)
...
kwargs: GetEntitiesRequestRequestTypeDef = { # (1)
"ids": ...,
}
parent.get_entities(**kwargs)
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
def get_flow_template(
self,
*,
id: str,
revisionNumber: int = ...,
) -> GetFlowTemplateResponseTypeDef: # (1)
...
kwargs: GetFlowTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_flow_template(**kwargs)
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
def get_flow_template_revisions(
self,
*,
id: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetFlowTemplateRevisionsResponseTypeDef: # (1)
...
kwargs: GetFlowTemplateRevisionsRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_flow_template_revisions(**kwargs)
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
def get_namespace_deletion_status(
self,
) -> GetNamespaceDeletionStatusResponseTypeDef: # (1)
...
get_system_instance
Gets a system instance.
Type annotations and code completion for boto3.client("iotthingsgraph").get_system_instance
method.
boto3 documentation
def get_system_instance(
self,
*,
id: str,
) -> GetSystemInstanceResponseTypeDef: # (1)
...
kwargs: GetSystemInstanceRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_system_instance(**kwargs)
get_system_template
Gets a system.
Type annotations and code completion for boto3.client("iotthingsgraph").get_system_template
method.
boto3 documentation
def get_system_template(
self,
*,
id: str,
revisionNumber: int = ...,
) -> GetSystemTemplateResponseTypeDef: # (1)
...
kwargs: GetSystemTemplateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_system_template(**kwargs)
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
def get_system_template_revisions(
self,
*,
id: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetSystemTemplateRevisionsResponseTypeDef: # (1)
...
kwargs: GetSystemTemplateRevisionsRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_system_template_revisions(**kwargs)
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
def get_upload_status(
self,
*,
uploadId: str,
) -> GetUploadStatusResponseTypeDef: # (1)
...
kwargs: GetUploadStatusRequestRequestTypeDef = { # (1)
"uploadId": ...,
}
parent.get_upload_status(**kwargs)
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
def list_flow_execution_messages(
self,
*,
flowExecutionId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListFlowExecutionMessagesResponseTypeDef: # (1)
...
kwargs: ListFlowExecutionMessagesRequestRequestTypeDef = { # (1)
"flowExecutionId": ...,
}
parent.list_flow_execution_messages(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
search_entities
Searches for entities of the specified type.
Type annotations and code completion for boto3.client("iotthingsgraph").search_entities
method.
boto3 documentation
def search_entities(
self,
*,
entityTypes: Sequence[EntityTypeType], # (1)
filters: Sequence[EntityFilterTypeDef] = ..., # (2)
nextToken: str = ...,
maxResults: int = ...,
namespaceVersion: int = ...,
) -> SearchEntitiesResponseTypeDef: # (3)
...
kwargs: SearchEntitiesRequestRequestTypeDef = { # (1)
"entityTypes": ...,
}
parent.search_entities(**kwargs)
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
def search_flow_executions(
self,
*,
systemInstanceId: str,
flowExecutionId: str = ...,
startTime: Union[datetime, str] = ...,
endTime: Union[datetime, str] = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> SearchFlowExecutionsResponseTypeDef: # (1)
...
kwargs: SearchFlowExecutionsRequestRequestTypeDef = { # (1)
"systemInstanceId": ...,
}
parent.search_flow_executions(**kwargs)
search_flow_templates
Searches for summary information about workflows.
Type annotations and code completion for boto3.client("iotthingsgraph").search_flow_templates
method.
boto3 documentation
def search_flow_templates(
self,
*,
filters: Sequence[FlowTemplateFilterTypeDef] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> SearchFlowTemplatesResponseTypeDef: # (2)
...
kwargs: SearchFlowTemplatesRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.search_flow_templates(**kwargs)
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
def search_system_instances(
self,
*,
filters: Sequence[SystemInstanceFilterTypeDef] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> SearchSystemInstancesResponseTypeDef: # (2)
...
kwargs: SearchSystemInstancesRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.search_system_instances(**kwargs)
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
def search_system_templates(
self,
*,
filters: Sequence[SystemTemplateFilterTypeDef] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> SearchSystemTemplatesResponseTypeDef: # (2)
...
kwargs: SearchSystemTemplatesRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.search_system_templates(**kwargs)
search_things
Searches for things associated with the specified entity.
Type annotations and code completion for boto3.client("iotthingsgraph").search_things
method.
boto3 documentation
def search_things(
self,
*,
entityId: str,
nextToken: str = ...,
maxResults: int = ...,
namespaceVersion: int = ...,
) -> SearchThingsResponseTypeDef: # (1)
...
kwargs: SearchThingsRequestRequestTypeDef = { # (1)
"entityId": ...,
}
parent.search_things(**kwargs)
tag_resource
Creates a tag for the specified resource.
Type annotations and code completion for boto3.client("iotthingsgraph").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
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
def undeploy_system_instance(
self,
*,
id: str = ...,
) -> UndeploySystemInstanceResponseTypeDef: # (1)
...
kwargs: UndeploySystemInstanceRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.undeploy_system_instance(**kwargs)
untag_resource
Removes a tag from the specified resource.
Type annotations and code completion for boto3.client("iotthingsgraph").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_flow_template
Updates the specified workflow.
Type annotations and code completion for boto3.client("iotthingsgraph").update_flow_template
method.
boto3 documentation
def update_flow_template(
self,
*,
id: str,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: int = ...,
) -> UpdateFlowTemplateResponseTypeDef: # (2)
...
kwargs: UpdateFlowTemplateRequestRequestTypeDef = { # (1)
"id": ...,
"definition": ...,
}
parent.update_flow_template(**kwargs)
update_system_template
Updates the specified system.
Type annotations and code completion for boto3.client("iotthingsgraph").update_system_template
method.
boto3 documentation
def update_system_template(
self,
*,
id: str,
definition: DefinitionDocumentTypeDef, # (1)
compatibleNamespaceVersion: int = ...,
) -> UpdateSystemTemplateResponseTypeDef: # (2)
...
kwargs: UpdateSystemTemplateRequestRequestTypeDef = { # (1)
"id": ...,
"definition": ...,
}
parent.update_system_template(**kwargs)
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
def upload_entity_definitions(
self,
*,
document: DefinitionDocumentTypeDef = ..., # (1)
syncWithPublicNamespace: bool = ...,
deprecateExistingEntities: bool = ...,
) -> UploadEntityDefinitionsResponseTypeDef: # (2)
...
kwargs: UploadEntityDefinitionsRequestRequestTypeDef = { # (1)
"document": ...,
}
parent.upload_entity_definitions(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("iotthingsgraph").get_paginator
method with overloads.
client.get_paginator("get_flow_template_revisions")
-> GetFlowTemplateRevisionsPaginatorclient.get_paginator("get_system_template_revisions")
-> GetSystemTemplateRevisionsPaginatorclient.get_paginator("list_flow_execution_messages")
-> ListFlowExecutionMessagesPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("search_entities")
-> SearchEntitiesPaginatorclient.get_paginator("search_flow_executions")
-> SearchFlowExecutionsPaginatorclient.get_paginator("search_flow_templates")
-> SearchFlowTemplatesPaginatorclient.get_paginator("search_system_instances")
-> SearchSystemInstancesPaginatorclient.get_paginator("search_system_templates")
-> SearchSystemTemplatesPaginatorclient.get_paginator("search_things")
-> SearchThingsPaginator