Skip to content

IoTDeviceAdvisorClient

Index > IoTDeviceAdvisor > IoTDeviceAdvisorClient

Auto-generated documentation for IoTDeviceAdvisor type annotations stubs module mypy-boto3-iotdeviceadvisor.

IoTDeviceAdvisorClient

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

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("iotdeviceadvisor")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_iotdeviceadvisor.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

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

create_suite_definition

Creates a Device Advisor test suite.

Type annotations and code completion for boto3.client("iotdeviceadvisor").create_suite_definition method. boto3 documentation

Method definition
def create_suite_definition(
    self,
    *,
    suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateSuiteDefinitionResponseTypeDef:  # (2)
    ...
  1. See SuiteDefinitionConfigurationTypeDef
  2. See CreateSuiteDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateSuiteDefinitionRequestRequestTypeDef = {  # (1)
    "suiteDefinitionConfiguration": ...,
}

parent.create_suite_definition(**kwargs)
  1. See CreateSuiteDefinitionRequestRequestTypeDef

delete_suite_definition

Deletes a Device Advisor test suite.

Type annotations and code completion for boto3.client("iotdeviceadvisor").delete_suite_definition method. boto3 documentation

Method definition
def delete_suite_definition(
    self,
    *,
    suiteDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSuiteDefinitionRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
}

parent.delete_suite_definition(**kwargs)
  1. See DeleteSuiteDefinitionRequestRequestTypeDef

generate_presigned_url

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

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

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

get_endpoint

Gets information about an Device Advisor endpoint.

Type annotations and code completion for boto3.client("iotdeviceadvisor").get_endpoint method. boto3 documentation

Method definition
def get_endpoint(
    self,
    *,
    thingArn: str = ...,
    certificateArn: str = ...,
) -> GetEndpointResponseTypeDef:  # (1)
    ...
  1. See GetEndpointResponseTypeDef
Usage example with kwargs
kwargs: GetEndpointRequestRequestTypeDef = {  # (1)
    "thingArn": ...,
}

parent.get_endpoint(**kwargs)
  1. See GetEndpointRequestRequestTypeDef

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

Method definition
def get_suite_definition(
    self,
    *,
    suiteDefinitionId: str,
    suiteDefinitionVersion: str = ...,
) -> GetSuiteDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetSuiteDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetSuiteDefinitionRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
}

parent.get_suite_definition(**kwargs)
  1. See GetSuiteDefinitionRequestRequestTypeDef

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

Method definition
def get_suite_run(
    self,
    *,
    suiteDefinitionId: str,
    suiteRunId: str,
) -> GetSuiteRunResponseTypeDef:  # (1)
    ...
  1. See GetSuiteRunResponseTypeDef
Usage example with kwargs
kwargs: GetSuiteRunRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
    "suiteRunId": ...,
}

parent.get_suite_run(**kwargs)
  1. See GetSuiteRunRequestRequestTypeDef

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

Method definition
def get_suite_run_report(
    self,
    *,
    suiteDefinitionId: str,
    suiteRunId: str,
) -> GetSuiteRunReportResponseTypeDef:  # (1)
    ...
  1. See GetSuiteRunReportResponseTypeDef
Usage example with kwargs
kwargs: GetSuiteRunReportRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
    "suiteRunId": ...,
}

parent.get_suite_run_report(**kwargs)
  1. See GetSuiteRunReportRequestRequestTypeDef

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

Method definition
def list_suite_definitions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSuiteDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListSuiteDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListSuiteDefinitionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_suite_definitions(**kwargs)
  1. See ListSuiteDefinitionsRequestRequestTypeDef

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

Method definition
def list_suite_runs(
    self,
    *,
    suiteDefinitionId: str = ...,
    suiteDefinitionVersion: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSuiteRunsResponseTypeDef:  # (1)
    ...
  1. See ListSuiteRunsResponseTypeDef
Usage example with kwargs
kwargs: ListSuiteRunsRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
}

parent.list_suite_runs(**kwargs)
  1. See ListSuiteRunsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def start_suite_run(
    self,
    *,
    suiteDefinitionId: str,
    suiteDefinitionVersion: str = ...,
    suiteRunConfiguration: SuiteRunConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> StartSuiteRunResponseTypeDef:  # (2)
    ...
  1. See SuiteRunConfigurationTypeDef
  2. See StartSuiteRunResponseTypeDef
Usage example with kwargs
kwargs: StartSuiteRunRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
}

parent.start_suite_run(**kwargs)
  1. See StartSuiteRunRequestRequestTypeDef

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

Method definition
def stop_suite_run(
    self,
    *,
    suiteDefinitionId: str,
    suiteRunId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StopSuiteRunRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
    "suiteRunId": ...,
}

parent.stop_suite_run(**kwargs)
  1. See StopSuiteRunRequestRequestTypeDef

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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from an IoT Device Advisor resource.

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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_suite_definition

Updates a Device Advisor test suite.

Type annotations and code completion for boto3.client("iotdeviceadvisor").update_suite_definition method. boto3 documentation

Method definition
def update_suite_definition(
    self,
    *,
    suiteDefinitionId: str,
    suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef = ...,  # (1)
) -> UpdateSuiteDefinitionResponseTypeDef:  # (2)
    ...
  1. See SuiteDefinitionConfigurationTypeDef
  2. See UpdateSuiteDefinitionResponseTypeDef
Usage example with kwargs
kwargs: UpdateSuiteDefinitionRequestRequestTypeDef = {  # (1)
    "suiteDefinitionId": ...,
}

parent.update_suite_definition(**kwargs)
  1. See UpdateSuiteDefinitionRequestRequestTypeDef