com.amazonaws.services.savingsplans

Class AWSSavingsPlansClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.savingsplans.AWSSavingsPlansClient

All Implemented Interfaces:

AWSSavingsPlans

Direct Known Subclasses:

AWSSavingsPlansAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSavingsPlansClient
extends AmazonWebServiceClient
implements AWSSavingsPlans

Client for accessing AWSSavingsPlans. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.savingsplans.AWSSavingsPlans

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSavingsPlansClientBuilder	builder()
CreateSavingsPlanResult	createSavingsPlan(CreateSavingsPlanRequest request) Creates a Savings Plan.
DeleteQueuedSavingsPlanResult	deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest request) Deletes the queued purchase for the specified Savings Plan.
DescribeSavingsPlanRatesResult	describeSavingsPlanRates(DescribeSavingsPlanRatesRequest request) Describes the rates for the specified Savings Plan.
DescribeSavingsPlansResult	describeSavingsPlans(DescribeSavingsPlansRequest request) Describes the specified Savings Plans.
DescribeSavingsPlansOfferingRatesResult	describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest request) Describes the offering rates for the specified Savings Plans.
DescribeSavingsPlansOfferingsResult	describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest request) 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 request) Lists the tags for the specified resource.
ReturnSavingsPlanResult	returnSavingsPlan(ReturnSavingsPlanRequest request) Returns the specified Savings Plan.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSSavingsPlansClientBuilder builder()

createSavingsPlan

public CreateSavingsPlanResult createSavingsPlan(CreateSavingsPlanRequest request)

Creates a Savings Plan.

Specified by:

createSavingsPlan in interface AWSSavingsPlans

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

public DeleteQueuedSavingsPlanResult deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest request)

Deletes the queued purchase for the specified Savings Plan.

Specified by:

deleteQueuedSavingsPlan in interface AWSSavingsPlans

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

public DescribeSavingsPlanRatesResult describeSavingsPlanRates(DescribeSavingsPlanRatesRequest request)

Describes the rates for the specified Savings Plan.

Specified by:

describeSavingsPlanRates in interface AWSSavingsPlans

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

public DescribeSavingsPlansResult describeSavingsPlans(DescribeSavingsPlansRequest request)

Describes the specified Savings Plans.

Specified by:

describeSavingsPlans in interface AWSSavingsPlans

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

public DescribeSavingsPlansOfferingRatesResult describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest request)

Describes the offering rates for the specified Savings Plans.

Specified by:

describeSavingsPlansOfferingRates in interface AWSSavingsPlans

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

public DescribeSavingsPlansOfferingsResult describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest request)

Describes the offerings for the specified Savings Plans.

Specified by:

describeSavingsPlansOfferings in interface AWSSavingsPlans

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSSavingsPlans

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

public ReturnSavingsPlanResult returnSavingsPlan(ReturnSavingsPlanRequest request)

Returns the specified Savings Plan.

Specified by:

returnSavingsPlan in interface AWSSavingsPlans

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

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified resource.

Specified by:

tagResource in interface AWSSavingsPlans

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AWSSavingsPlans

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSavingsPlans

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSavingsPlans

Overrides:

shutdown in class AmazonWebServiceClient