IotDeviceAdvisorClient

Suggest an Edit

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.

Installation

NPM
npm install @aws-sdk/client-iotdeviceadvisor
Yarn
yarn add @aws-sdk/client-iotdeviceadvisor
pnpm
pnpm add @aws-sdk/client-iotdeviceadvisor

IotDeviceAdvisorClient Operations

Command
Summary
CreateSuiteDefinitionCommand

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition  action.

DeleteSuiteDefinitionCommand

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition  action.

GetEndpointCommand

Gets information about an Device Advisor endpoint.

GetSuiteDefinitionCommand

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition  action.

GetSuiteRunCommand

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun  action.

GetSuiteRunReportCommand

Gets a report download link for a successful Device Advisor qualifying test suite run.

Requires permission to access the GetSuiteRunReport  action.

ListSuiteDefinitionsCommand

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions  action.

ListSuiteRunsCommand

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

Requires permission to access the ListSuiteRuns  action.

ListTagsForResourceCommand

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource  action.

StartSuiteRunCommand

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun  action.

StopSuiteRunCommand

Stops a Device Advisor test suite run that is currently running.

Requires permission to access the StopSuiteRun  action.

TagResourceCommand

Adds to and modifies existing tags of an IoT Device Advisor resource.

Requires permission to access the TagResource  action.

UntagResourceCommand

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource  action.

UpdateSuiteDefinitionCommand

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition  action.

IotDeviceAdvisorClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: IotDeviceAdvisorClientConfig