Interface IotDeviceAdvisorClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aIotDeviceAdvisorClient
.static IotDeviceAdvisorClient
create()
Create aIotDeviceAdvisorClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateSuiteDefinitionResponse
createSuiteDefinition
(Consumer<CreateSuiteDefinitionRequest.Builder> createSuiteDefinitionRequest) Creates a Device Advisor test suite.default CreateSuiteDefinitionResponse
createSuiteDefinition
(CreateSuiteDefinitionRequest createSuiteDefinitionRequest) Creates a Device Advisor test suite.default DeleteSuiteDefinitionResponse
deleteSuiteDefinition
(Consumer<DeleteSuiteDefinitionRequest.Builder> deleteSuiteDefinitionRequest) Deletes a Device Advisor test suite.default DeleteSuiteDefinitionResponse
deleteSuiteDefinition
(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest) Deletes a Device Advisor test suite.default GetEndpointResponse
getEndpoint
(Consumer<GetEndpointRequest.Builder> getEndpointRequest) Gets information about an Device Advisor endpoint.default GetEndpointResponse
getEndpoint
(GetEndpointRequest getEndpointRequest) Gets information about an Device Advisor endpoint.default GetSuiteDefinitionResponse
getSuiteDefinition
(Consumer<GetSuiteDefinitionRequest.Builder> getSuiteDefinitionRequest) Gets information about a Device Advisor test suite.default GetSuiteDefinitionResponse
getSuiteDefinition
(GetSuiteDefinitionRequest getSuiteDefinitionRequest) Gets information about a Device Advisor test suite.default GetSuiteRunResponse
getSuiteRun
(Consumer<GetSuiteRunRequest.Builder> getSuiteRunRequest) Gets information about a Device Advisor test suite run.default GetSuiteRunResponse
getSuiteRun
(GetSuiteRunRequest getSuiteRunRequest) Gets information about a Device Advisor test suite run.default GetSuiteRunReportResponse
getSuiteRunReport
(Consumer<GetSuiteRunReportRequest.Builder> getSuiteRunReportRequest) Gets a report download link for a successful Device Advisor qualifying test suite run.default GetSuiteRunReportResponse
getSuiteRunReport
(GetSuiteRunReportRequest getSuiteRunReportRequest) Gets a report download link for a successful Device Advisor qualifying test suite run.default ListSuiteDefinitionsResponse
listSuiteDefinitions
(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest) Lists the Device Advisor test suites you have created.default ListSuiteDefinitionsResponse
listSuiteDefinitions
(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest) Lists the Device Advisor test suites you have created.default ListSuiteDefinitionsIterable
listSuiteDefinitionsPaginator
(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest) This is a variant oflistSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation.default ListSuiteDefinitionsIterable
listSuiteDefinitionsPaginator
(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest) This is a variant oflistSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation.default ListSuiteRunsResponse
listSuiteRuns
(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest) Lists runs of the specified Device Advisor test suite.default ListSuiteRunsResponse
listSuiteRuns
(ListSuiteRunsRequest listSuiteRunsRequest) Lists runs of the specified Device Advisor test suite.default ListSuiteRunsIterable
listSuiteRunsPaginator
(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest) This is a variant oflistSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation.default ListSuiteRunsIterable
listSuiteRunsPaginator
(ListSuiteRunsRequest listSuiteRunsRequest) This is a variant oflistSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags attached to an IoT Device Advisor resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags attached to an IoT Device Advisor resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartSuiteRunResponse
startSuiteRun
(Consumer<StartSuiteRunRequest.Builder> startSuiteRunRequest) Starts a Device Advisor test suite run.default StartSuiteRunResponse
startSuiteRun
(StartSuiteRunRequest startSuiteRunRequest) Starts a Device Advisor test suite run.default StopSuiteRunResponse
stopSuiteRun
(Consumer<StopSuiteRunRequest.Builder> stopSuiteRunRequest) Stops a Device Advisor test suite run that is currently running.default StopSuiteRunResponse
stopSuiteRun
(StopSuiteRunRequest stopSuiteRunRequest) Stops a Device Advisor test suite run that is currently running.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to and modifies existing tags of an IoT Device Advisor resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds to and modifies existing tags of an IoT Device Advisor resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an IoT Device Advisor resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an IoT Device Advisor resource.default UpdateSuiteDefinitionResponse
updateSuiteDefinition
(Consumer<UpdateSuiteDefinitionRequest.Builder> updateSuiteDefinitionRequest) Updates a Device Advisor test suite.default UpdateSuiteDefinitionResponse
updateSuiteDefinition
(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest) Updates a Device Advisor test suite.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createSuiteDefinition
default CreateSuiteDefinitionResponse createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
createSuiteDefinition
default CreateSuiteDefinitionResponse createSuiteDefinition(Consumer<CreateSuiteDefinitionRequest.Builder> createSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
This is a convenience which creates an instance of the
CreateSuiteDefinitionRequest.Builder
avoiding the need to create one manually viaCreateSuiteDefinitionRequest.builder()
- Parameters:
createSuiteDefinitionRequest
- AConsumer
that will call methods onCreateSuiteDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateSuiteDefinition operation returned by the service.
- See Also:
-
deleteSuiteDefinition
default DeleteSuiteDefinitionResponse deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
deleteSuiteDefinition
default DeleteSuiteDefinitionResponse deleteSuiteDefinition(Consumer<DeleteSuiteDefinitionRequest.Builder> deleteSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Deletes a Device Advisor test suite.
Requires permission to access the DeleteSuiteDefinition action.
This is a convenience which creates an instance of the
DeleteSuiteDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteSuiteDefinitionRequest.builder()
- Parameters:
deleteSuiteDefinitionRequest
- AConsumer
that will call methods onDeleteSuiteDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteSuiteDefinition operation returned by the service.
- See Also:
-
getEndpoint
default GetEndpointResponse getEndpoint(GetEndpointRequest getEndpointRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Gets information about an Device Advisor endpoint.
- Parameters:
getEndpointRequest
-- Returns:
- Result of the GetEndpoint operation returned by the service.
- See Also:
-
getEndpoint
default GetEndpointResponse getEndpoint(Consumer<GetEndpointRequest.Builder> getEndpointRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Gets information about an Device Advisor endpoint.
This is a convenience which creates an instance of the
GetEndpointRequest.Builder
avoiding the need to create one manually viaGetEndpointRequest.builder()
- Parameters:
getEndpointRequest
- AConsumer
that will call methods onGetEndpointRequest.Builder
to create a request.- Returns:
- Result of the GetEndpoint operation returned by the service.
- See Also:
-
getSuiteDefinition
default GetSuiteDefinitionResponse getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
getSuiteDefinition
default GetSuiteDefinitionResponse getSuiteDefinition(Consumer<GetSuiteDefinitionRequest.Builder> getSuiteDefinitionRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Gets information about a Device Advisor test suite.
Requires permission to access the GetSuiteDefinition action.
This is a convenience which creates an instance of the
GetSuiteDefinitionRequest.Builder
avoiding the need to create one manually viaGetSuiteDefinitionRequest.builder()
- Parameters:
getSuiteDefinitionRequest
- AConsumer
that will call methods onGetSuiteDefinitionRequest.Builder
to create a request.- Returns:
- Result of the GetSuiteDefinition operation returned by the service.
- See Also:
-
getSuiteRun
default GetSuiteRunResponse getSuiteRun(GetSuiteRunRequest getSuiteRunRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
getSuiteRun
default GetSuiteRunResponse getSuiteRun(Consumer<GetSuiteRunRequest.Builder> getSuiteRunRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Gets information about a Device Advisor test suite run.
Requires permission to access the GetSuiteRun action.
This is a convenience which creates an instance of the
GetSuiteRunRequest.Builder
avoiding the need to create one manually viaGetSuiteRunRequest.builder()
- Parameters:
getSuiteRunRequest
- AConsumer
that will call methods onGetSuiteRunRequest.Builder
to create a request.- Returns:
- Result of the GetSuiteRun operation returned by the service.
- See Also:
-
getSuiteRunReport
default GetSuiteRunReportResponse getSuiteRunReport(GetSuiteRunReportRequest getSuiteRunReportRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
getSuiteRunReport
default GetSuiteRunReportResponse getSuiteRunReport(Consumer<GetSuiteRunReportRequest.Builder> getSuiteRunReportRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Gets a report download link for a successful Device Advisor qualifying test suite run.
Requires permission to access the GetSuiteRunReport action.
This is a convenience which creates an instance of the
GetSuiteRunReportRequest.Builder
avoiding the need to create one manually viaGetSuiteRunReportRequest.builder()
- Parameters:
getSuiteRunReportRequest
- AConsumer
that will call methods onGetSuiteRunReportRequest.Builder
to create a request.- Returns:
- Result of the GetSuiteRunReport operation returned by the service.
- See Also:
-
listSuiteDefinitions
default ListSuiteDefinitionsResponse listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
listSuiteDefinitions
default ListSuiteDefinitionsResponse listSuiteDefinitions(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
This is a convenience which creates an instance of the
ListSuiteDefinitionsRequest.Builder
avoiding the need to create one manually viaListSuiteDefinitionsRequest.builder()
- Parameters:
listSuiteDefinitionsRequest
- AConsumer
that will call methods onListSuiteDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListSuiteDefinitions operation returned by the service.
- See Also:
-
listSuiteDefinitionsPaginator
default ListSuiteDefinitionsIterable listSuiteDefinitionsPaginator(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException This is a variant of
listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client .listSuiteDefinitionsPaginator(request); for (software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation.- Parameters:
listSuiteDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSuiteDefinitionsPaginator
default ListSuiteDefinitionsIterable listSuiteDefinitionsPaginator(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException This is a variant of
listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client .listSuiteDefinitionsPaginator(request); for (software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
ListSuiteDefinitionsRequest.Builder
avoiding the need to create one manually viaListSuiteDefinitionsRequest.builder()
- Parameters:
listSuiteDefinitionsRequest
- AConsumer
that will call methods onListSuiteDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSuiteRuns
default ListSuiteRunsResponse listSuiteRuns(ListSuiteRunsRequest listSuiteRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
listSuiteRuns
default ListSuiteRunsResponse listSuiteRuns(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
This is a convenience which creates an instance of the
ListSuiteRunsRequest.Builder
avoiding the need to create one manually viaListSuiteRunsRequest.builder()
- Parameters:
listSuiteRunsRequest
- AConsumer
that will call methods onListSuiteRunsRequest.Builder
to create a request.- Returns:
- Result of the ListSuiteRuns operation returned by the service.
- See Also:
-
listSuiteRunsPaginator
default ListSuiteRunsIterable listSuiteRunsPaginator(ListSuiteRunsRequest listSuiteRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException This is a variant of
listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client .listSuiteRunsPaginator(request); for (software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation.- Parameters:
listSuiteRunsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSuiteRunsPaginator
default ListSuiteRunsIterable listSuiteRunsPaginator(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException This is a variant of
listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client .listSuiteRunsPaginator(request); for (software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)
operation.
This is a convenience which creates an instance of the
ListSuiteRunsRequest.Builder
avoiding the need to create one manually viaListSuiteRunsRequest.builder()
- Parameters:
listSuiteRunsRequest
- AConsumer
that will call methods onListSuiteRunsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Lists the tags attached to an IoT Device Advisor resource.
Requires permission to access the ListTagsForResource action.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startSuiteRun
default StartSuiteRunResponse startSuiteRun(StartSuiteRunRequest startSuiteRunRequest) throws ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
startSuiteRun
default StartSuiteRunResponse startSuiteRun(Consumer<StartSuiteRunRequest.Builder> startSuiteRunRequest) throws ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Starts a Device Advisor test suite run.
Requires permission to access the StartSuiteRun action.
This is a convenience which creates an instance of the
StartSuiteRunRequest.Builder
avoiding the need to create one manually viaStartSuiteRunRequest.builder()
- Parameters:
startSuiteRunRequest
- AConsumer
that will call methods onStartSuiteRunRequest.Builder
to create a request.- Returns:
- Result of the StartSuiteRun operation returned by the service.
- See Also:
-
stopSuiteRun
default StopSuiteRunResponse stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
stopSuiteRun
default StopSuiteRunResponse stopSuiteRun(Consumer<StopSuiteRunRequest.Builder> stopSuiteRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Stops a Device Advisor test suite run that is currently running.
Requires permission to access the StopSuiteRun action.
This is a convenience which creates an instance of the
StopSuiteRunRequest.Builder
avoiding the need to create one manually viaStopSuiteRunRequest.builder()
- Parameters:
stopSuiteRunRequest
- AConsumer
that will call methods onStopSuiteRunRequest.Builder
to create a request.- Returns:
- Result of the StopSuiteRun operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Adds to and modifies existing tags of an IoT Device Advisor resource.
Requires permission to access the TagResource action.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Removes tags from an IoT Device Advisor resource.
Requires permission to access the UntagResource action.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateSuiteDefinition
default UpdateSuiteDefinitionResponse updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException 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.
- See Also:
-
updateSuiteDefinition
default UpdateSuiteDefinitionResponse updateSuiteDefinition(Consumer<UpdateSuiteDefinitionRequest.Builder> updateSuiteDefinitionRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException Updates a Device Advisor test suite.
Requires permission to access the UpdateSuiteDefinition action.
This is a convenience which creates an instance of the
UpdateSuiteDefinitionRequest.Builder
avoiding the need to create one manually viaUpdateSuiteDefinitionRequest.builder()
- Parameters:
updateSuiteDefinitionRequest
- AConsumer
that will call methods onUpdateSuiteDefinitionRequest.Builder
to create a request.- Returns:
- Result of the UpdateSuiteDefinition operation returned by the service.
- See Also:
-
create
Create aIotDeviceAdvisorClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotDeviceAdvisorClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-