Package software.amazon.awssdk.services.savingsplans

Interface SavingsplansClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SavingsplansClient
extends AwsClient

Service client for accessing AWSSavingsPlans. This can be created using the static builder() method.

Savings Plans are a pricing model that offer significant savings on Amazon Web Services usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage per hour, in the specified currency, for a term of one or three years, and receive a lower price for that usage. For more information, see the Amazon Web Services Savings Plans User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 rates for the specified Savings Plan.
default DescribeSavingsPlanRatesResponse	describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest)	Describes the rates for the specified Savings Plan.
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 offering rates for the specified Savings Plans.
default DescribeSavingsPlansOfferingRatesResponse	describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest)	Describes the offering rates for the specified Savings Plans.
default DescribeSavingsPlansOfferingsResponse	describeSavingsPlansOfferings(Consumer<DescribeSavingsPlansOfferingsRequest.Builder> describeSavingsPlansOfferingsRequest)	Describes the offerings for the specified Savings Plans.
default DescribeSavingsPlansOfferingsResponse	describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest)	Describes the offerings for the specified Savings Plans.
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.
default ReturnSavingsPlanResponse	returnSavingsPlan(Consumer<ReturnSavingsPlanRequest.Builder> returnSavingsPlanRequest)	Returns the specified Savings Plan.
default ReturnSavingsPlanResponse	returnSavingsPlan(ReturnSavingsPlanRequest returnSavingsPlanRequest)	Returns the specified Savings Plan.
default SavingsplansServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createSavingsPlan

default CreateSavingsPlanResponse createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SavingsplansException

Creates a Savings Plan.

Parameters:

createSavingsPlanRequest -

Returns:

Result of the CreateSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

createSavingsPlan

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()

Parameters:

createSavingsPlanRequest - A Consumer that will call methods on CreateSavingsPlanRequest.Builder to create a request.

Returns:

Result of the CreateSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

deleteQueuedSavingsPlan

default DeleteQueuedSavingsPlanResponse deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest)
                                                         throws ValidationException,
ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SavingsplansException

Deletes the queued purchase for the specified Savings Plan.

Parameters:

deleteQueuedSavingsPlanRequest -

Returns:

Result of the DeleteQueuedSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

deleteQueuedSavingsPlan

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()

Parameters:

deleteQueuedSavingsPlanRequest - A Consumer that will call methods on DeleteQueuedSavingsPlanRequest.Builder to create a request.

Returns:

Result of the DeleteQueuedSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlanRates

default DescribeSavingsPlanRatesResponse describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest)
                                                           throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the rates for the specified Savings Plan.

Parameters:

describeSavingsPlanRatesRequest -

Returns:

Result of the DescribeSavingsPlanRates operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlanRates

default DescribeSavingsPlanRatesResponse describeSavingsPlanRates(Consumer<DescribeSavingsPlanRatesRequest.Builder> describeSavingsPlanRatesRequest)
                                                           throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the rates for the specified Savings Plan.

This is a convenience which creates an instance of the DescribeSavingsPlanRatesRequest.Builder avoiding the need to create one manually via DescribeSavingsPlanRatesRequest.builder()

Parameters:

describeSavingsPlanRatesRequest - A Consumer that will call methods on DescribeSavingsPlanRatesRequest.Builder to create a request.

Returns:

Result of the DescribeSavingsPlanRates operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlans

default DescribeSavingsPlansResponse describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest)
                                                   throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the specified Savings Plans.

Parameters:

describeSavingsPlansRequest -

Returns:

Result of the DescribeSavingsPlans operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlans

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()

Parameters:

describeSavingsPlansRequest - A Consumer that will call methods on DescribeSavingsPlansRequest.Builder to create a request.

Returns:

Result of the DescribeSavingsPlans operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlansOfferingRates

default DescribeSavingsPlansOfferingRatesResponse describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest)
                                                                             throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the offering rates for the specified Savings Plans.

Parameters:

describeSavingsPlansOfferingRatesRequest -

Returns:

Result of the DescribeSavingsPlansOfferingRates operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlansOfferingRates

default DescribeSavingsPlansOfferingRatesResponse describeSavingsPlansOfferingRates(Consumer<DescribeSavingsPlansOfferingRatesRequest.Builder> describeSavingsPlansOfferingRatesRequest)
                                                                             throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the offering rates for the specified Savings Plans.

This is a convenience which creates an instance of the DescribeSavingsPlansOfferingRatesRequest.Builder avoiding the need to create one manually via DescribeSavingsPlansOfferingRatesRequest.builder()

Parameters:

describeSavingsPlansOfferingRatesRequest - A Consumer that will call methods on DescribeSavingsPlansOfferingRatesRequest.Builder to create a request.

Returns:

Result of the DescribeSavingsPlansOfferingRates operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlansOfferings

default DescribeSavingsPlansOfferingsResponse describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest)
                                                                     throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the offerings for the specified Savings Plans.

Parameters:

describeSavingsPlansOfferingsRequest -

Returns:

Result of the DescribeSavingsPlansOfferings operation returned by the service.

See Also:

• AWS API Documentation

describeSavingsPlansOfferings

default DescribeSavingsPlansOfferingsResponse describeSavingsPlansOfferings(Consumer<DescribeSavingsPlansOfferingsRequest.Builder> describeSavingsPlansOfferingsRequest)
                                                                     throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Describes the offerings for the specified Savings Plans.

This is a convenience which creates an instance of the DescribeSavingsPlansOfferingsRequest.Builder avoiding the need to create one manually via DescribeSavingsPlansOfferingsRequest.builder()

Parameters:

describeSavingsPlansOfferingsRequest - A Consumer that will call methods on DescribeSavingsPlansOfferingsRequest.Builder to create a request.

Returns:

Result of the DescribeSavingsPlansOfferings operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

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()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

returnSavingsPlan

default ReturnSavingsPlanResponse returnSavingsPlan(ReturnSavingsPlanRequest returnSavingsPlanRequest)
                                             throws ValidationException,
ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SavingsplansException

Returns the specified Savings Plan.

Parameters:

returnSavingsPlanRequest -

Returns:

Result of the ReturnSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

returnSavingsPlan

default ReturnSavingsPlanResponse returnSavingsPlan(Consumer<ReturnSavingsPlanRequest.Builder> returnSavingsPlanRequest)
                                             throws ValidationException,
ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SavingsplansException

Returns the specified Savings Plan.

This is a convenience which creates an instance of the ReturnSavingsPlanRequest.Builder avoiding the need to create one manually via ReturnSavingsPlanRequest.builder()

Parameters:

returnSavingsPlanRequest - A Consumer that will call methods on ReturnSavingsPlanRequest.Builder to create a request.

Returns:

Result of the ReturnSavingsPlan operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ServiceQuotaExceededException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Adds the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

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()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SavingsplansException

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

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()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static SavingsplansClient create()

Create a SavingsplansClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SavingsplansClientBuilder builder()

Create a builder that can be used to configure and create a SavingsplansClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SavingsplansServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration