IoTDeviceAdvisorClient#
Index > IoTDeviceAdvisor > IoTDeviceAdvisorClient
Auto-generated documentation for IoTDeviceAdvisor type annotations stubs module types-boto3-iotdeviceadvisor.
IoTDeviceAdvisorClient#
Type annotations and code completion for boto3.client("iotdeviceadvisor")
.
boto3 documentation
# IoTDeviceAdvisorClient usage example
from boto3.session import Session
from types_boto3_iotdeviceadvisor.client import IoTDeviceAdvisorClient
def get_iotdeviceadvisor_client() -> IoTDeviceAdvisorClient:
return Session().client("iotdeviceadvisor")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iotdeviceadvisor").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("iotdeviceadvisor")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_boto3_iotdeviceadvisor.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("iotdeviceadvisor").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("iotdeviceadvisor").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:
...
create_suite_definition#
Creates a Device Advisor test suite.
Type annotations and code completion for boto3.client("iotdeviceadvisor").create_suite_definition
method.
boto3 documentation
# create_suite_definition method definition
def create_suite_definition(
self,
*,
suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef, # (1)
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreateSuiteDefinitionResponseTypeDef: # (2)
...
# create_suite_definition method usage example with argument unpacking
kwargs: CreateSuiteDefinitionRequestRequestTypeDef = { # (1)
"suiteDefinitionConfiguration": ...,
}
parent.create_suite_definition(**kwargs)
delete_suite_definition#
Deletes a Device Advisor test suite.
Type annotations and code completion for boto3.client("iotdeviceadvisor").delete_suite_definition
method.
boto3 documentation
# delete_suite_definition method definition
def delete_suite_definition(
self,
*,
suiteDefinitionId: str,
) -> dict[str, Any]:
...
# delete_suite_definition method usage example with argument unpacking
kwargs: DeleteSuiteDefinitionRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
}
parent.delete_suite_definition(**kwargs)
get_endpoint#
Gets information about an Device Advisor endpoint.
Type annotations and code completion for boto3.client("iotdeviceadvisor").get_endpoint
method.
boto3 documentation
# get_endpoint method definition
def get_endpoint(
self,
*,
thingArn: str = ...,
certificateArn: str = ...,
deviceRoleArn: str = ...,
authenticationMethod: AuthenticationMethodType = ..., # (1)
) -> GetEndpointResponseTypeDef: # (2)
...
# get_endpoint method usage example with argument unpacking
kwargs: GetEndpointRequestRequestTypeDef = { # (1)
"thingArn": ...,
}
parent.get_endpoint(**kwargs)
get_suite_definition#
Gets information about a Device Advisor test suite.
Type annotations and code completion for boto3.client("iotdeviceadvisor").get_suite_definition
method.
boto3 documentation
# get_suite_definition method definition
def get_suite_definition(
self,
*,
suiteDefinitionId: str,
suiteDefinitionVersion: str = ...,
) -> GetSuiteDefinitionResponseTypeDef: # (1)
...
# get_suite_definition method usage example with argument unpacking
kwargs: GetSuiteDefinitionRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
}
parent.get_suite_definition(**kwargs)
get_suite_run#
Gets information about a Device Advisor test suite run.
Type annotations and code completion for boto3.client("iotdeviceadvisor").get_suite_run
method.
boto3 documentation
# get_suite_run method definition
def get_suite_run(
self,
*,
suiteDefinitionId: str,
suiteRunId: str,
) -> GetSuiteRunResponseTypeDef: # (1)
...
# get_suite_run method usage example with argument unpacking
kwargs: GetSuiteRunRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
"suiteRunId": ...,
}
parent.get_suite_run(**kwargs)
get_suite_run_report#
Gets a report download link for a successful Device Advisor qualifying test suite run.
Type annotations and code completion for boto3.client("iotdeviceadvisor").get_suite_run_report
method.
boto3 documentation
# get_suite_run_report method definition
def get_suite_run_report(
self,
*,
suiteDefinitionId: str,
suiteRunId: str,
) -> GetSuiteRunReportResponseTypeDef: # (1)
...
# get_suite_run_report method usage example with argument unpacking
kwargs: GetSuiteRunReportRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
"suiteRunId": ...,
}
parent.get_suite_run_report(**kwargs)
list_suite_definitions#
Lists the Device Advisor test suites you have created.
Type annotations and code completion for boto3.client("iotdeviceadvisor").list_suite_definitions
method.
boto3 documentation
# list_suite_definitions method definition
def list_suite_definitions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSuiteDefinitionsResponseTypeDef: # (1)
...
# list_suite_definitions method usage example with argument unpacking
kwargs: ListSuiteDefinitionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_suite_definitions(**kwargs)
list_suite_runs#
Lists runs of the specified Device Advisor test suite.
Type annotations and code completion for boto3.client("iotdeviceadvisor").list_suite_runs
method.
boto3 documentation
# list_suite_runs method definition
def list_suite_runs(
self,
*,
suiteDefinitionId: str = ...,
suiteDefinitionVersion: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSuiteRunsResponseTypeDef: # (1)
...
# list_suite_runs method usage example with argument unpacking
kwargs: ListSuiteRunsRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
}
parent.list_suite_runs(**kwargs)
list_tags_for_resource#
Lists the tags attached to an IoT Device Advisor resource.
Type annotations and code completion for boto3.client("iotdeviceadvisor").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_suite_run#
Starts a Device Advisor test suite run.
Type annotations and code completion for boto3.client("iotdeviceadvisor").start_suite_run
method.
boto3 documentation
# start_suite_run method definition
def start_suite_run(
self,
*,
suiteDefinitionId: str,
suiteRunConfiguration: SuiteRunConfigurationTypeDef, # (1)
suiteDefinitionVersion: str = ...,
tags: Mapping[str, str] = ...,
) -> StartSuiteRunResponseTypeDef: # (2)
...
# start_suite_run method usage example with argument unpacking
kwargs: StartSuiteRunRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
"suiteRunConfiguration": ...,
}
parent.start_suite_run(**kwargs)
stop_suite_run#
Stops a Device Advisor test suite run that is currently running.
Type annotations and code completion for boto3.client("iotdeviceadvisor").stop_suite_run
method.
boto3 documentation
# stop_suite_run method definition
def stop_suite_run(
self,
*,
suiteDefinitionId: str,
suiteRunId: str,
) -> dict[str, Any]:
...
# stop_suite_run method usage example with argument unpacking
kwargs: StopSuiteRunRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
"suiteRunId": ...,
}
parent.stop_suite_run(**kwargs)
tag_resource#
Adds to and modifies existing tags of an IoT Device Advisor resource.
Type annotations and code completion for boto3.client("iotdeviceadvisor").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from an IoT Device Advisor resource.
Type annotations and code completion for boto3.client("iotdeviceadvisor").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)
update_suite_definition#
Updates a Device Advisor test suite.
Type annotations and code completion for boto3.client("iotdeviceadvisor").update_suite_definition
method.
boto3 documentation
# update_suite_definition method definition
def update_suite_definition(
self,
*,
suiteDefinitionId: str,
suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef, # (1)
) -> UpdateSuiteDefinitionResponseTypeDef: # (2)
...
# update_suite_definition method usage example with argument unpacking
kwargs: UpdateSuiteDefinitionRequestRequestTypeDef = { # (1)
"suiteDefinitionId": ...,
"suiteDefinitionConfiguration": ...,
}
parent.update_suite_definition(**kwargs)