com.amazonaws.services.iotdeviceadvisor

Interface AWSIoTDeviceAdvisor

All Known Subinterfaces:

AWSIoTDeviceAdvisorAsync

All Known Implementing Classes:

AbstractAWSIoTDeviceAdvisor, AbstractAWSIoTDeviceAdvisorAsync, AWSIoTDeviceAdvisorAsyncClient, AWSIoTDeviceAdvisorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTDeviceAdvisor

Interface for accessing AWSIoTDeviceAdvisor.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTDeviceAdvisor instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateSuiteDefinitionResult	createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest) Creates a Device Advisor test suite.
DeleteSuiteDefinitionResult	deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest) Deletes a Device Advisor test suite.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetEndpointResult	getEndpoint(GetEndpointRequest getEndpointRequest) Gets information about an Device Advisor endpoint.
GetSuiteDefinitionResult	getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest) Gets information about a Device Advisor test suite.
GetSuiteRunResult	getSuiteRun(GetSuiteRunRequest getSuiteRunRequest) Gets information about a Device Advisor test suite run.
GetSuiteRunReportResult	getSuiteRunReport(GetSuiteRunReportRequest getSuiteRunReportRequest) Gets a report download link for a successful Device Advisor qualifying test suite run.
ListSuiteDefinitionsResult	listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest) Lists the Device Advisor test suites you have created.
ListSuiteRunsResult	listSuiteRuns(ListSuiteRunsRequest listSuiteRunsRequest) Lists runs of the specified Device Advisor test suite.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to an IoT Device Advisor resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartSuiteRunResult	startSuiteRun(StartSuiteRunRequest startSuiteRunRequest) Starts a Device Advisor test suite run.
StopSuiteRunResult	stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest) Stops a Device Advisor test suite run that is currently running.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds to and modifies existing tags of an IoT Device Advisor resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an IoT Device Advisor resource.
UpdateSuiteDefinitionResult	updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest) Updates a Device Advisor test suite.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createSuiteDefinition

CreateSuiteDefinitionResult createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest)

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

Parameters:

createSuiteDefinitionRequest -

Returns:

Result of the CreateSuiteDefinition operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

deleteSuiteDefinition

DeleteSuiteDefinitionResult deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest)

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition action.

Parameters:

deleteSuiteDefinitionRequest -

Returns:

Result of the DeleteSuiteDefinition operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

getEndpoint

GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)

Gets information about an Device Advisor endpoint.

Parameters:

getEndpointRequest -

Returns:

Result of the GetEndpoint operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

getSuiteDefinition

GetSuiteDefinitionResult getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest)

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

Parameters:

getSuiteDefinitionRequest -

Returns:

Result of the GetSuiteDefinition operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

getSuiteRun

GetSuiteRunResult getSuiteRun(GetSuiteRunRequest getSuiteRunRequest)

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

Parameters:

getSuiteRunRequest -

Returns:

Result of the GetSuiteRun operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

getSuiteRunReport

GetSuiteRunReportResult getSuiteRunReport(GetSuiteRunReportRequest getSuiteRunReportRequest)

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

Requires permission to access the GetSuiteRunReport action.

Parameters:

getSuiteRunReportRequest -

Returns:

Result of the GetSuiteRunReport operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

listSuiteDefinitions

ListSuiteDefinitionsResult listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

Parameters:

listSuiteDefinitionsRequest -

Returns:

Result of the ListSuiteDefinitions operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

listSuiteRuns

ListSuiteRunsResult listSuiteRuns(ListSuiteRunsRequest listSuiteRunsRequest)

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.

Parameters:

listSuiteRunsRequest -

Returns:

Result of the ListSuiteRuns operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource action.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - Sends an Internal Failure exception.

ValidationException - Sends a validation exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

startSuiteRun

StartSuiteRunResult startSuiteRun(StartSuiteRunRequest startSuiteRunRequest)

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

Parameters:

startSuiteRunRequest -

Returns:

Result of the StartSuiteRun operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

ConflictException - Sends a Conflict Exception.

See Also:

AWS API Documentation

stopSuiteRun

StopSuiteRunResult stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest)

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

Requires permission to access the StopSuiteRun action.

Parameters:

stopSuiteRunRequest -

Returns:

Result of the StopSuiteRun operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Requires permission to access the TagResource action.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - Sends an Internal Failure exception.

ValidationException - Sends a validation exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource action.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - Sends an Internal Failure exception.

ValidationException - Sends a validation exception.

ResourceNotFoundException - Sends a Resource Not Found exception.

See Also:

AWS API Documentation

updateSuiteDefinition

UpdateSuiteDefinitionResult updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest)

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

Parameters:

updateSuiteDefinitionRequest -

Returns:

Result of the UpdateSuiteDefinition operation returned by the service.

Throws:

ValidationException - Sends a validation exception.

InternalServerException - Sends an Internal Failure exception.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.