iotdeviceadvisor/aws.sdk.kotlin.services.iotdeviceadvisor/IotDeviceAdvisorClient

IotDeviceAdvisorClient

interface IotDeviceAdvisorClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: IotDeviceAdvisorClient.Config

IotDeviceAdvisorClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createSuiteDefinition(input: CreateSuiteDefinitionRequest): CreateSuiteDefinitionResponse

Creates a Device Advisor test suite.

Link copied to clipboard
abstract suspend fun deleteSuiteDefinition(input: DeleteSuiteDefinitionRequest): DeleteSuiteDefinitionResponse

Deletes a Device Advisor test suite.

Link copied to clipboard
abstract suspend fun getEndpoint(input: GetEndpointRequest = GetEndpointRequest { }): GetEndpointResponse

Gets information about an Device Advisor endpoint.

Link copied to clipboard
abstract suspend fun getSuiteDefinition(input: GetSuiteDefinitionRequest): GetSuiteDefinitionResponse

Gets information about a Device Advisor test suite.

Link copied to clipboard
abstract suspend fun getSuiteRun(input: GetSuiteRunRequest): GetSuiteRunResponse

Gets information about a Device Advisor test suite run.

Link copied to clipboard
abstract suspend fun getSuiteRunReport(input: GetSuiteRunReportRequest): GetSuiteRunReportResponse

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

Link copied to clipboard
abstract suspend fun listSuiteDefinitions(input: ListSuiteDefinitionsRequest = ListSuiteDefinitionsRequest { }): ListSuiteDefinitionsResponse

Lists the Device Advisor test suites you have created.

Link copied to clipboard
abstract suspend fun listSuiteRuns(input: ListSuiteRunsRequest = ListSuiteRunsRequest { }): ListSuiteRunsResponse

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.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags attached to an IoT Device Advisor resource.

Link copied to clipboard
abstract suspend fun startSuiteRun(input: StartSuiteRunRequest): StartSuiteRunResponse

Starts a Device Advisor test suite run.

Link copied to clipboard
abstract suspend fun stopSuiteRun(input: StopSuiteRunRequest): StopSuiteRunResponse

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from an IoT Device Advisor resource.

Link copied to clipboard
abstract suspend fun updateSuiteDefinition(input: UpdateSuiteDefinitionRequest): UpdateSuiteDefinitionResponse

Updates a Device Advisor test suite.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.createSuiteDefinition(crossinline block: CreateSuiteDefinitionRequest.Builder.() -> Unit): CreateSuiteDefinitionResponse

Creates a Device Advisor test suite.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.deleteSuiteDefinition(crossinline block: DeleteSuiteDefinitionRequest.Builder.() -> Unit): DeleteSuiteDefinitionResponse

Deletes a Device Advisor test suite.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.getEndpoint(crossinline block: GetEndpointRequest.Builder.() -> Unit): GetEndpointResponse

Gets information about an Device Advisor endpoint.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.getSuiteDefinition(crossinline block: GetSuiteDefinitionRequest.Builder.() -> Unit): GetSuiteDefinitionResponse

Gets information about a Device Advisor test suite.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.getSuiteRun(crossinline block: GetSuiteRunRequest.Builder.() -> Unit): GetSuiteRunResponse

Gets information about a Device Advisor test suite run.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.getSuiteRunReport(crossinline block: GetSuiteRunReportRequest.Builder.() -> Unit): GetSuiteRunReportResponse

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

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.listSuiteDefinitions(crossinline block: ListSuiteDefinitionsRequest.Builder.() -> Unit): ListSuiteDefinitionsResponse

Lists the Device Advisor test suites you have created.

Link copied to clipboard
Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.listSuiteRuns(crossinline block: ListSuiteRunsRequest.Builder.() -> Unit): ListSuiteRunsResponse

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.

Link copied to clipboard
Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags attached to an IoT Device Advisor resource.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.startSuiteRun(crossinline block: StartSuiteRunRequest.Builder.() -> Unit): StartSuiteRunResponse

Starts a Device Advisor test suite run.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.stopSuiteRun(crossinline block: StopSuiteRunRequest.Builder.() -> Unit): StopSuiteRunResponse

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

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from an IoT Device Advisor resource.

Link copied to clipboard
inline suspend fun IotDeviceAdvisorClient.updateSuiteDefinition(crossinline block: UpdateSuiteDefinitionRequest.Builder.() -> Unit): UpdateSuiteDefinitionResponse

Updates a Device Advisor test suite.

Link copied to clipboard
fun IotDeviceAdvisorClient.withConfig(block: IotDeviceAdvisorClient.Config.Builder.() -> Unit): IotDeviceAdvisorClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.