@Generated(value="software.amazon.awssdk:codegen") public interface SavingsplansClient extends SdkClient
builder()
method.
Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For more information, see the AWS Savings Plans User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SavingsplansClientBuilder |
builder()
Create a builder that can be used to configure and create a
SavingsplansClient . |
static SavingsplansClient |
create()
Create a
SavingsplansClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateSavingsPlanResponse |
createSavingsPlan(Consumer<CreateSavingsPlanRequest.Builder> createSavingsPlanRequest)
Creates a Savings Plan.
|
default CreateSavingsPlanResponse |
createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest)
Creates a Savings Plan.
|
default DeleteQueuedSavingsPlanResponse |
deleteQueuedSavingsPlan(Consumer<DeleteQueuedSavingsPlanRequest.Builder> deleteQueuedSavingsPlanRequest)
Deletes the queued purchase for the specified Savings Plan.
|
default DeleteQueuedSavingsPlanResponse |
deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest)
Deletes the queued purchase for the specified Savings Plan.
|
default DescribeSavingsPlanRatesResponse |
describeSavingsPlanRates(Consumer<DescribeSavingsPlanRatesRequest.Builder> describeSavingsPlanRatesRequest)
Describes the specified Savings Plans rates.
|
default DescribeSavingsPlanRatesResponse |
describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest)
Describes the specified Savings Plans rates.
|
default DescribeSavingsPlansResponse |
describeSavingsPlans(Consumer<DescribeSavingsPlansRequest.Builder> describeSavingsPlansRequest)
Describes the specified Savings Plans.
|
default DescribeSavingsPlansResponse |
describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest)
Describes the specified Savings Plans.
|
default DescribeSavingsPlansOfferingRatesResponse |
describeSavingsPlansOfferingRates(Consumer<DescribeSavingsPlansOfferingRatesRequest.Builder> describeSavingsPlansOfferingRatesRequest)
Describes the specified Savings Plans offering rates.
|
default DescribeSavingsPlansOfferingRatesResponse |
describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest)
Describes the specified Savings Plans offering rates.
|
default DescribeSavingsPlansOfferingsResponse |
describeSavingsPlansOfferings(Consumer<DescribeSavingsPlansOfferingsRequest.Builder> describeSavingsPlansOfferingsRequest)
Describes the specified Savings Plans offerings.
|
default DescribeSavingsPlansOfferingsResponse |
describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest)
Describes the specified Savings Plans offerings.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for the specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tags to the specified resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static SavingsplansClient create()
SavingsplansClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SavingsplansClientBuilder builder()
SavingsplansClient
.default CreateSavingsPlanResponse createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SavingsplansException
Creates a Savings Plan.
createSavingsPlanRequest
- ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.ServiceQuotaExceededException
- A service quota has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSavingsPlanResponse createSavingsPlan(Consumer<CreateSavingsPlanRequest.Builder> createSavingsPlanRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SavingsplansException
Creates a Savings Plan.
This is a convenience which creates an instance of the CreateSavingsPlanRequest.Builder
avoiding the need
to create one manually via CreateSavingsPlanRequest.builder()
createSavingsPlanRequest
- A Consumer
that will call methods on CreateSavingsPlanRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.ServiceQuotaExceededException
- A service quota has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteQueuedSavingsPlanResponse deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SavingsplansException
Deletes the queued purchase for the specified Savings Plan.
deleteQueuedSavingsPlanRequest
- ValidationException
- One of the input parameters is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServerException
- An unexpected error occurred.ServiceQuotaExceededException
- A service quota has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteQueuedSavingsPlanResponse deleteQueuedSavingsPlan(Consumer<DeleteQueuedSavingsPlanRequest.Builder> deleteQueuedSavingsPlanRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, SavingsplansException
Deletes the queued purchase for the specified Savings Plan.
This is a convenience which creates an instance of the DeleteQueuedSavingsPlanRequest.Builder
avoiding
the need to create one manually via DeleteQueuedSavingsPlanRequest.builder()
deleteQueuedSavingsPlanRequest
- A Consumer
that will call methods on DeleteQueuedSavingsPlanRequest.Builder
to create a
request.ValidationException
- One of the input parameters is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServerException
- An unexpected error occurred.ServiceQuotaExceededException
- A service quota has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlanRatesResponse describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans rates.
describeSavingsPlanRatesRequest
- ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlanRatesResponse describeSavingsPlanRates(Consumer<DescribeSavingsPlanRatesRequest.Builder> describeSavingsPlanRatesRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans rates.
This is a convenience which creates an instance of the DescribeSavingsPlanRatesRequest.Builder
avoiding
the need to create one manually via DescribeSavingsPlanRatesRequest.builder()
describeSavingsPlanRatesRequest
- A Consumer
that will call methods on DescribeSavingsPlanRatesRequest.Builder
to create a
request.ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansResponse describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans.
describeSavingsPlansRequest
- InternalServerException
- An unexpected error occurred.ValidationException
- One of the input parameters is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansResponse describeSavingsPlans(Consumer<DescribeSavingsPlansRequest.Builder> describeSavingsPlansRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans.
This is a convenience which creates an instance of the DescribeSavingsPlansRequest.Builder
avoiding the
need to create one manually via DescribeSavingsPlansRequest.builder()
describeSavingsPlansRequest
- A Consumer
that will call methods on DescribeSavingsPlansRequest.Builder
to create a
request.InternalServerException
- An unexpected error occurred.ValidationException
- One of the input parameters is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansOfferingRatesResponse describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans offering rates.
describeSavingsPlansOfferingRatesRequest
- ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansOfferingRatesResponse describeSavingsPlansOfferingRates(Consumer<DescribeSavingsPlansOfferingRatesRequest.Builder> describeSavingsPlansOfferingRatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans offering rates.
This is a convenience which creates an instance of the DescribeSavingsPlansOfferingRatesRequest.Builder
avoiding the need to create one manually via DescribeSavingsPlansOfferingRatesRequest.builder()
describeSavingsPlansOfferingRatesRequest
- A Consumer
that will call methods on DescribeSavingsPlansOfferingRatesRequest.Builder
to
create a request.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansOfferingsResponse describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans offerings.
describeSavingsPlansOfferingsRequest
- ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSavingsPlansOfferingsResponse describeSavingsPlansOfferings(Consumer<DescribeSavingsPlansOfferingsRequest.Builder> describeSavingsPlansOfferingsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Describes the specified Savings Plans offerings.
This is a convenience which creates an instance of the DescribeSavingsPlansOfferingsRequest.Builder
avoiding the need to create one manually via DescribeSavingsPlansOfferingsRequest.builder()
describeSavingsPlansOfferingsRequest
- A Consumer
that will call methods on DescribeSavingsPlansOfferingsRequest.Builder
to
create a request.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Lists the tags for the specified resource.
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Lists the tags for the specified resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Adds the specified tags to the specified resource.
tagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.ServiceQuotaExceededException
- A service quota has been exceeded.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Adds the specified tags to the specified resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource was not found.ServiceQuotaExceededException
- A service quota has been exceeded.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Removes the specified tags from the specified resource.
untagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SavingsplansException
Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource was not found.ValidationException
- One of the input parameters is not valid.InternalServerException
- An unexpected error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SavingsplansException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()