com.amazonaws.services.savingsplans

Interface AWSSavingsPlans

All Known Subinterfaces:

AWSSavingsPlansAsync

All Known Implementing Classes:

AbstractAWSSavingsPlans, AbstractAWSSavingsPlansAsync, AWSSavingsPlansAsyncClient, AWSSavingsPlansClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSavingsPlans

Interface for accessing AWSSavingsPlans.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSavingsPlans instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateSavingsPlanResult	createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest) Creates a Savings Plan.
DeleteQueuedSavingsPlanResult	deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest) Deletes the queued purchase for the specified Savings Plan.
DescribeSavingsPlanRatesResult	describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest) Describes the rates for the specified Savings Plan.
DescribeSavingsPlansResult	describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest) Describes the specified Savings Plans.
DescribeSavingsPlansOfferingRatesResult	describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest) Describes the offering rates for the specified Savings Plans.
DescribeSavingsPlansOfferingsResult	describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest) Describes the offerings for the specified Savings Plans.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
ReturnSavingsPlanResult	returnSavingsPlan(ReturnSavingsPlanRequest returnSavingsPlanRequest) Returns the specified Savings Plan.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createSavingsPlan

CreateSavingsPlanResult createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest)

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.

See Also:

AWS API Documentation

deleteQueuedSavingsPlan

DeleteQueuedSavingsPlanResult deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest)

Deletes the queued purchase for the specified Savings Plan.

Parameters:

deleteQueuedSavingsPlanRequest -

Returns:

Result of the DeleteQueuedSavingsPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeSavingsPlanRates

DescribeSavingsPlanRatesResult describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest)

Describes the rates for the specified Savings Plan.

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.

See Also:

AWS API Documentation

describeSavingsPlans

DescribeSavingsPlansResult describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest)

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.

See Also:

AWS API Documentation

describeSavingsPlansOfferingRates

DescribeSavingsPlansOfferingRatesResult describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest)

Describes the offering rates for the specified Savings Plans.

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.

See Also:

AWS API Documentation

describeSavingsPlansOfferings

DescribeSavingsPlansOfferingsResult describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest)

Describes the offerings for the specified Savings Plans.

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

See Also:

AWS API Documentation

returnSavingsPlan

ReturnSavingsPlanResult returnSavingsPlan(ReturnSavingsPlanRequest returnSavingsPlanRequest)

Returns the specified Savings Plan.

Parameters:

returnSavingsPlanRequest -

Returns:

Result of the ReturnSavingsPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.