software.amazon.awssdk.services.iotdeviceadvisor.IotDeviceAdvisorClient Maven / Gradle / Ivy
Show all versions of iotdeviceadvisor Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iotdeviceadvisor;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ConflictException;
import software.amazon.awssdk.services.iotdeviceadvisor.model.CreateSuiteDefinitionRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.CreateSuiteDefinitionResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.DeleteSuiteDefinitionRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.DeleteSuiteDefinitionResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetEndpointRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetEndpointResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteDefinitionRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteDefinitionResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunReportRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunReportResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.InternalServerException;
import software.amazon.awssdk.services.iotdeviceadvisor.model.IotDeviceAdvisorException;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ResourceNotFoundException;
import software.amazon.awssdk.services.iotdeviceadvisor.model.StartSuiteRunRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.StartSuiteRunResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.StopSuiteRunRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.StopSuiteRunResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.TagResourceRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.TagResourceResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.UntagResourceRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.UntagResourceResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.UpdateSuiteDefinitionRequest;
import software.amazon.awssdk.services.iotdeviceadvisor.model.UpdateSuiteDefinitionResponse;
import software.amazon.awssdk.services.iotdeviceadvisor.model.ValidationException;
import software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable;
import software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable;
/**
* Service client for accessing AWSIoTDeviceAdvisor. This can be created using the static {@link #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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface IotDeviceAdvisorClient extends AwsClient {
String SERVICE_NAME = "iotdeviceadvisor";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "api.iotdeviceadvisor";
/**
*
* Creates a Device Advisor test suite.
*
*
* Requires permission to access the CreateSuiteDefinition action.
*
*
* @param createSuiteDefinitionRequest
* @return Result of the CreateSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.CreateSuiteDefinition
* @see AWS API Documentation
*/
default CreateSuiteDefinitionResponse createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Device Advisor test suite.
*
*
* Requires permission to access the CreateSuiteDefinition action.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSuiteDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link CreateSuiteDefinitionRequest#builder()}
*
*
* @param createSuiteDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.CreateSuiteDefinitionRequest.Builder} to
* create a request.
* @return Result of the CreateSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.CreateSuiteDefinition
* @see AWS API Documentation
*/
default CreateSuiteDefinitionResponse createSuiteDefinition(
Consumer createSuiteDefinitionRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return createSuiteDefinition(CreateSuiteDefinitionRequest.builder().applyMutation(createSuiteDefinitionRequest).build());
}
/**
*
* Deletes a Device Advisor test suite.
*
*
* Requires permission to access the DeleteSuiteDefinition action.
*
*
* @param deleteSuiteDefinitionRequest
* @return Result of the DeleteSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.DeleteSuiteDefinition
* @see AWS API Documentation
*/
default DeleteSuiteDefinitionResponse deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Device Advisor test suite.
*
*
* Requires permission to access the DeleteSuiteDefinition action.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSuiteDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSuiteDefinitionRequest#builder()}
*
*
* @param deleteSuiteDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.DeleteSuiteDefinitionRequest.Builder} to
* create a request.
* @return Result of the DeleteSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.DeleteSuiteDefinition
* @see AWS API Documentation
*/
default DeleteSuiteDefinitionResponse deleteSuiteDefinition(
Consumer deleteSuiteDefinitionRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return deleteSuiteDefinition(DeleteSuiteDefinitionRequest.builder().applyMutation(deleteSuiteDefinitionRequest).build());
}
/**
*
* Gets information about an Device Advisor endpoint.
*
*
* @param getEndpointRequest
* @return Result of the GetEndpoint operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetEndpoint
* @see AWS
* API Documentation
*/
default GetEndpointResponse getEndpoint(GetEndpointRequest getEndpointRequest) throws ValidationException,
InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an Device Advisor endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link GetEndpointRequest.Builder} avoiding the need to
* create one manually via {@link GetEndpointRequest#builder()}
*
*
* @param getEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.GetEndpointRequest.Builder} to create a
* request.
* @return Result of the GetEndpoint operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetEndpoint
* @see AWS
* API Documentation
*/
default GetEndpointResponse getEndpoint(Consumer getEndpointRequest) throws ValidationException,
InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return getEndpoint(GetEndpointRequest.builder().applyMutation(getEndpointRequest).build());
}
/**
*
* Gets information about a Device Advisor test suite.
*
*
* Requires permission to access the GetSuiteDefinition action.
*
*
* @param getSuiteDefinitionRequest
* @return Result of the GetSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteDefinition
* @see AWS API Documentation
*/
default GetSuiteDefinitionResponse getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest)
throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSuiteDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link GetSuiteDefinitionRequest#builder()}
*
*
* @param getSuiteDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteDefinitionRequest.Builder} to create
* a request.
* @return Result of the GetSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteDefinition
* @see AWS API Documentation
*/
default GetSuiteDefinitionResponse getSuiteDefinition(Consumer getSuiteDefinitionRequest)
throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
return getSuiteDefinition(GetSuiteDefinitionRequest.builder().applyMutation(getSuiteDefinitionRequest).build());
}
/**
*
* Gets information about a Device Advisor test suite run.
*
*
* Requires permission to access the GetSuiteRun action.
*
*
* @param getSuiteRunRequest
* @return Result of the GetSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteRun
* @see AWS
* API Documentation
*/
default GetSuiteRunResponse getSuiteRun(GetSuiteRunRequest getSuiteRunRequest) throws ValidationException,
InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSuiteRunRequest.Builder} avoiding the need to
* create one manually via {@link GetSuiteRunRequest#builder()}
*
*
* @param getSuiteRunRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunRequest.Builder} to create a
* request.
* @return Result of the GetSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteRun
* @see AWS
* API Documentation
*/
default GetSuiteRunResponse getSuiteRun(Consumer getSuiteRunRequest) throws ValidationException,
InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return getSuiteRun(GetSuiteRunRequest.builder().applyMutation(getSuiteRunRequest).build());
}
/**
*
* Gets a report download link for a successful Device Advisor qualifying test suite run.
*
*
* Requires permission to access the GetSuiteRunReport action.
*
*
* @param getSuiteRunReportRequest
* @return Result of the GetSuiteRunReport operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteRunReport
* @see AWS API Documentation
*/
default GetSuiteRunReportResponse getSuiteRunReport(GetSuiteRunReportRequest getSuiteRunReportRequest)
throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSuiteRunReportRequest.Builder} avoiding the need
* to create one manually via {@link GetSuiteRunReportRequest#builder()}
*
*
* @param getSuiteRunReportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunReportRequest.Builder} to create
* a request.
* @return Result of the GetSuiteRunReport operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.GetSuiteRunReport
* @see AWS API Documentation
*/
default GetSuiteRunReportResponse getSuiteRunReport(Consumer getSuiteRunReportRequest)
throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
return getSuiteRunReport(GetSuiteRunReportRequest.builder().applyMutation(getSuiteRunReportRequest).build());
}
/**
*
* Lists the Device Advisor test suites you have created.
*
*
* Requires permission to access the ListSuiteDefinitions action.
*
*
* @param listSuiteDefinitionsRequest
* @return Result of the ListSuiteDefinitions operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteDefinitions
* @see AWS API Documentation
*/
default ListSuiteDefinitionsResponse listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListSuiteDefinitionsRequest.Builder} avoiding the
* need to create one manually via {@link ListSuiteDefinitionsRequest#builder()}
*
*
* @param listSuiteDefinitionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest.Builder} to
* create a request.
* @return Result of the ListSuiteDefinitions operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteDefinitions
* @see AWS API Documentation
*/
default ListSuiteDefinitionsResponse listSuiteDefinitions(
Consumer listSuiteDefinitionsRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return listSuiteDefinitions(ListSuiteDefinitionsRequest.builder().applyMutation(listSuiteDefinitionsRequest).build());
}
/**
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)}
* operation.
*
*
* @param listSuiteDefinitionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteDefinitions
* @see AWS API Documentation
*/
default ListSuiteDefinitionsIterable listSuiteDefinitionsPaginator(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return new ListSuiteDefinitionsIterable(this, listSuiteDefinitionsRequest);
}
/**
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsIterable responses = client.listSuiteDefinitionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListSuiteDefinitionsRequest.Builder} avoiding the
* need to create one manually via {@link ListSuiteDefinitionsRequest#builder()}
*
*
* @param listSuiteDefinitionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteDefinitions
* @see AWS API Documentation
*/
default ListSuiteDefinitionsIterable listSuiteDefinitionsPaginator(
Consumer listSuiteDefinitionsRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return listSuiteDefinitionsPaginator(ListSuiteDefinitionsRequest.builder().applyMutation(listSuiteDefinitionsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listSuiteRunsRequest
* @return Result of the ListSuiteRuns operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteRuns
* @see AWS API Documentation
*/
default ListSuiteRunsResponse listSuiteRuns(ListSuiteRunsRequest listSuiteRunsRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListSuiteRunsRequest.Builder} avoiding the need to
* create one manually via {@link ListSuiteRunsRequest#builder()}
*
*
* @param listSuiteRunsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest.Builder} to create a
* request.
* @return Result of the ListSuiteRuns operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteRuns
* @see AWS API Documentation
*/
default ListSuiteRunsResponse listSuiteRuns(Consumer listSuiteRunsRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return listSuiteRuns(ListSuiteRunsRequest.builder().applyMutation(listSuiteRunsRequest).build());
}
/**
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)}
* operation.
*
*
* @param listSuiteRunsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteRuns
* @see AWS API Documentation
*/
default ListSuiteRunsIterable listSuiteRunsPaginator(ListSuiteRunsRequest listSuiteRunsRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return new ListSuiteRunsIterable(this, listSuiteRunsRequest);
}
/**
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsIterable responses = client.listSuiteRunsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListSuiteRunsRequest.Builder} avoiding the need to
* create one manually via {@link ListSuiteRunsRequest#builder()}
*
*
* @param listSuiteRunsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListSuiteRuns
* @see AWS API Documentation
*/
default ListSuiteRunsIterable listSuiteRunsPaginator(Consumer listSuiteRunsRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return listSuiteRunsPaginator(ListSuiteRunsRequest.builder().applyMutation(listSuiteRunsRequest).build());
}
/**
*
* Lists the tags attached to an IoT Device Advisor resource.
*
*
* Requires permission to access the ListTagsForResource action.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.ListTagsForResourceRequest.Builder} to
* create a request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws InternalServerException,
ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Starts a Device Advisor test suite run.
*
*
* Requires permission to access the StartSuiteRun action.
*
*
* @param startSuiteRunRequest
* @return Result of the StartSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ConflictException
* Sends a Conflict Exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.StartSuiteRun
* @see AWS API Documentation
*/
default StartSuiteRunResponse startSuiteRun(StartSuiteRunRequest startSuiteRunRequest) throws ValidationException,
InternalServerException, ConflictException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a Device Advisor test suite run.
*
*
* Requires permission to access the StartSuiteRun action.
*
*
*
* This is a convenience which creates an instance of the {@link StartSuiteRunRequest.Builder} avoiding the need to
* create one manually via {@link StartSuiteRunRequest#builder()}
*
*
* @param startSuiteRunRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.StartSuiteRunRequest.Builder} to create a
* request.
* @return Result of the StartSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ConflictException
* Sends a Conflict Exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.StartSuiteRun
* @see AWS API Documentation
*/
default StartSuiteRunResponse startSuiteRun(Consumer startSuiteRunRequest)
throws ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
return startSuiteRun(StartSuiteRunRequest.builder().applyMutation(startSuiteRunRequest).build());
}
/**
*
* Stops a Device Advisor test suite run that is currently running.
*
*
* Requires permission to access the StopSuiteRun action.
*
*
* @param stopSuiteRunRequest
* @return Result of the StopSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.StopSuiteRun
* @see AWS
* API Documentation
*/
default StopSuiteRunResponse stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest) throws ValidationException,
ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopSuiteRunRequest.Builder} avoiding the need to
* create one manually via {@link StopSuiteRunRequest#builder()}
*
*
* @param stopSuiteRunRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.StopSuiteRunRequest.Builder} to create a
* request.
* @return Result of the StopSuiteRun operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.StopSuiteRun
* @see AWS
* API Documentation
*/
default StopSuiteRunResponse stopSuiteRun(Consumer stopSuiteRunRequest)
throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
return stopSuiteRun(StopSuiteRunRequest.builder().applyMutation(stopSuiteRunRequest).build());
}
/**
*
* Adds to and modifies existing tags of an IoT Device Advisor resource.
*
*
* Requires permission to access the TagResource action.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.TagResource
* @see AWS
* API Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException,
ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.TagResourceRequest.Builder} to create a
* request.
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.TagResource
* @see AWS
* API Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes tags from an IoT Device Advisor resource.
*
*
* Requires permission to access the UntagResource action.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.UntagResource
* @see AWS API Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException,
ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.UntagResourceRequest.Builder} to create a
* request.
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws ValidationException
* Sends a validation exception.
* @throws ResourceNotFoundException
* Sends a Resource Not Found exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.UntagResource
* @see AWS API Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException,
SdkClientException, IotDeviceAdvisorException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates a Device Advisor test suite.
*
*
* Requires permission to access the UpdateSuiteDefinition action.
*
*
* @param updateSuiteDefinitionRequest
* @return Result of the UpdateSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.UpdateSuiteDefinition
* @see AWS API Documentation
*/
default UpdateSuiteDefinitionResponse updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest)
throws ValidationException, InternalServerException, AwsServiceException, SdkClientException,
IotDeviceAdvisorException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a Device Advisor test suite.
*
*
* Requires permission to access the UpdateSuiteDefinition action.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateSuiteDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link UpdateSuiteDefinitionRequest#builder()}
*
*
* @param updateSuiteDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.iotdeviceadvisor.model.UpdateSuiteDefinitionRequest.Builder} to
* create a request.
* @return Result of the UpdateSuiteDefinition operation returned by the service.
* @throws ValidationException
* Sends a validation exception.
* @throws InternalServerException
* Sends an Internal Failure exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IotDeviceAdvisorException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IotDeviceAdvisorClient.UpdateSuiteDefinition
* @see AWS API Documentation
*/
default UpdateSuiteDefinitionResponse updateSuiteDefinition(
Consumer updateSuiteDefinitionRequest) throws ValidationException,
InternalServerException, AwsServiceException, SdkClientException, IotDeviceAdvisorException {
return updateSuiteDefinition(UpdateSuiteDefinitionRequest.builder().applyMutation(updateSuiteDefinitionRequest).build());
}
/**
* Create a {@link IotDeviceAdvisorClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static IotDeviceAdvisorClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link IotDeviceAdvisorClient}.
*/
static IotDeviceAdvisorClientBuilder builder() {
return new DefaultIotDeviceAdvisorClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default IotDeviceAdvisorServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}