software.amazon.awssdk.services.savingsplans

Interface SavingsplansClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface SavingsplansClient
extends SdkClient

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 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

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 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.

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

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.

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.

Throws:

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

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.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlanRates

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

Describes the specified Savings Plans rates.

Parameters:

describeSavingsPlanRatesRequest -

Returns:

Result of the DescribeSavingsPlanRates operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlanRates

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlansOfferingRates

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

Describes the specified Savings Plans offering rates.

Parameters:

describeSavingsPlansOfferingRatesRequest -

Returns:

Result of the DescribeSavingsPlansOfferingRates operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlansOfferingRates

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

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.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlansOfferings

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

Describes the specified Savings Plans offerings.

Parameters:

describeSavingsPlansOfferingsRequest -

Returns:

Result of the DescribeSavingsPlansOfferings operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeSavingsPlansOfferings

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

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.

Throws:

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

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()