@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
CreateSuiteDefinitionResult createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest)
Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
createSuiteDefinitionRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.DeleteSuiteDefinitionResult deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest)
Deletes a Device Advisor test suite.
Requires permission to access the DeleteSuiteDefinition action.
deleteSuiteDefinitionRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
Gets information about an Device Advisor endpoint.
getEndpointRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ResourceNotFoundException
- Sends a Resource Not Found exception.GetSuiteDefinitionResult getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest)
Gets information about a Device Advisor test suite.
Requires permission to access the GetSuiteDefinition action.
getSuiteDefinitionRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ResourceNotFoundException
- Sends a Resource Not Found exception.GetSuiteRunResult getSuiteRun(GetSuiteRunRequest getSuiteRunRequest)
Gets information about a Device Advisor test suite run.
Requires permission to access the GetSuiteRun action.
getSuiteRunRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ResourceNotFoundException
- Sends a Resource Not Found exception.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.
getSuiteRunReportRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ResourceNotFoundException
- Sends a Resource Not Found exception.ListSuiteDefinitionsResult listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)
Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
listSuiteDefinitionsRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.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.
listSuiteRunsRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags attached to an IoT Device Advisor resource.
Requires permission to access the ListTagsForResource action.
listTagsForResourceRequest
- InternalServerException
- Sends an Internal Failure exception.ValidationException
- Sends a validation exception.ResourceNotFoundException
- Sends a Resource Not Found exception.StartSuiteRunResult startSuiteRun(StartSuiteRunRequest startSuiteRunRequest)
Starts a Device Advisor test suite run.
Requires permission to access the StartSuiteRun action.
startSuiteRunRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.ConflictException
- Sends a Conflict Exception.StopSuiteRunResult stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest)
Stops a Device Advisor test suite run that is currently running.
Requires permission to access the StopSuiteRun action.
stopSuiteRunRequest
- ValidationException
- Sends a validation exception.ResourceNotFoundException
- Sends a Resource Not Found exception.InternalServerException
- Sends an Internal Failure exception.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds to and modifies existing tags of an IoT Device Advisor resource.
Requires permission to access the TagResource action.
tagResourceRequest
- InternalServerException
- Sends an Internal Failure exception.ValidationException
- Sends a validation exception.ResourceNotFoundException
- Sends a Resource Not Found exception.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an IoT Device Advisor resource.
Requires permission to access the UntagResource action.
untagResourceRequest
- InternalServerException
- Sends an Internal Failure exception.ValidationException
- Sends a validation exception.ResourceNotFoundException
- Sends a Resource Not Found exception.UpdateSuiteDefinitionResult updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest)
Updates a Device Advisor test suite.
Requires permission to access the UpdateSuiteDefinition action.
updateSuiteDefinitionRequest
- ValidationException
- Sends a validation exception.InternalServerException
- Sends an Internal Failure exception.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.