com.amazonaws.services.savingsplans.AWSSavingsPlans Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-savingsplans Show documentation
The AWS Java SDK for AWS Savings Plans module holds the client classes that are used for communicating with AWS Savings Plans Service
There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.savingsplans;

import javax.annotation.Generated;

import com.amazonaws.*;
import com.amazonaws.regions.*;

import com.amazonaws.services.savingsplans.model.*;

/**
 * Interface for accessing AWSSavingsPlans.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.savingsplans.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.
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSavingsPlans {

    /**
     * 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 RegionUtils#getRegionsForService(String)
     */
    String ENDPOINT_PREFIX = "savingsplans";

    /**
     * 
     * Creates a Savings Plan.
     * 
     * 
     * @param createSavingsPlanRequest
     * @return Result of the CreateSavingsPlan operation returned by the service.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @throws ServiceQuotaExceededException
     *         A service quota has been exceeded.
     * @sample AWSSavingsPlans.CreateSavingsPlan
     * @see AWS
     *      API Documentation
     */
    CreateSavingsPlanResult createSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest);

    /**
     * 
     * Deletes the queued purchase for the specified Savings Plan.
     * 
     * 
     * @param deleteQueuedSavingsPlanRequest
     * @return Result of the DeleteQueuedSavingsPlan operation returned by the service.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @throws ServiceQuotaExceededException
     *         A service quota has been exceeded.
     * @sample AWSSavingsPlans.DeleteQueuedSavingsPlan
     * @see AWS API Documentation
     */
    DeleteQueuedSavingsPlanResult deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest);

    /**
     * 
     * Describes the rates for the specified Savings Plan.
     * 
     * 
     * @param describeSavingsPlanRatesRequest
     * @return Result of the DescribeSavingsPlanRates operation returned by the service.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @sample AWSSavingsPlans.DescribeSavingsPlanRates
     * @see AWS API Documentation
     */
    DescribeSavingsPlanRatesResult describeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest);

    /**
     * 
     * Describes the specified Savings Plans.
     * 
     * 
     * @param describeSavingsPlansRequest
     * @return Result of the DescribeSavingsPlans operation returned by the service.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @sample AWSSavingsPlans.DescribeSavingsPlans
     * @see AWS API Documentation
     */
    DescribeSavingsPlansResult describeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest);

    /**
     * 
     * Describes the offering rates for the specified Savings Plans.
     * 
     * 
     * @param describeSavingsPlansOfferingRatesRequest
     * @return Result of the DescribeSavingsPlansOfferingRates operation returned by the service.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @sample AWSSavingsPlans.DescribeSavingsPlansOfferingRates
     * @see AWS API Documentation
     */
    DescribeSavingsPlansOfferingRatesResult describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest);

    /**
     * 
     * Describes the offerings for the specified Savings Plans.
     * 
     * 
     * @param describeSavingsPlansOfferingsRequest
     * @return Result of the DescribeSavingsPlansOfferings operation returned by the service.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @sample AWSSavingsPlans.DescribeSavingsPlansOfferings
     * @see AWS API Documentation
     */
    DescribeSavingsPlansOfferingsResult describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest);

    /**
     * 
     * Lists the tags for the specified resource.
     * 
     * 
     * @param listTagsForResourceRequest
     * @return Result of the ListTagsForResource operation returned by the service.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @sample AWSSavingsPlans.ListTagsForResource
     * @see AWS API Documentation
     */
    ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);

    /**
     * 
     * Returns the specified Savings Plan.
     * 
     * 
     * @param returnSavingsPlanRequest
     * @return Result of the ReturnSavingsPlan operation returned by the service.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @throws ServiceQuotaExceededException
     *         A service quota has been exceeded.
     * @sample AWSSavingsPlans.ReturnSavingsPlan
     * @see AWS
     *      API Documentation
     */
    ReturnSavingsPlanResult returnSavingsPlan(ReturnSavingsPlanRequest returnSavingsPlanRequest);

    /**
     * 
     * Adds the specified tags to the specified resource.
     * 
     * 
     * @param tagResourceRequest
     * @return Result of the TagResource operation returned by the service.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws ServiceQuotaExceededException
     *         A service quota has been exceeded.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @sample AWSSavingsPlans.TagResource
     * @see AWS API
     *      Documentation
     */
    TagResourceResult tagResource(TagResourceRequest tagResourceRequest);

    /**
     * 
     * Removes the specified tags from the specified resource.
     * 
     * 
     * @param untagResourceRequest
     * @return Result of the UntagResource operation returned by the service.
     * @throws ResourceNotFoundException
     *         The specified resource was not found.
     * @throws ValidationException
     *         One of the input parameters is not valid.
     * @throws InternalServerException
     *         An unexpected error occurred.
     * @sample AWSSavingsPlans.UntagResource
     * @see AWS API
     *      Documentation
     */
    UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);

    /**
     * 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.
     */
    void shutdown();

    /**
     * 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.
     *
     * @param request
     *        The originally executed request.
     *
     * @return The response metadata for the specified request, or null if none is available.
     */
    ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);

}