com.amazonaws.services.pricing

Interface AWSPricing

All Known Subinterfaces:

AWSPricingAsync

All Known Implementing Classes:

AbstractAWSPricing, AbstractAWSPricingAsync, AWSPricingAsyncClient, AWSPricingClient

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

Interface for accessing AWS Pricing.

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

The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:

• Build cost control and scenario planning tools

• Reconcile billing data

• Forecast future spend for budgeting purposes

• Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.

For more information, see Using the Amazon Web Services Price List API in the Billing 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
DescribeServicesResult	describeServices(DescribeServicesRequest describeServicesRequest) Returns the metadata for one service or a list of the metadata for all services.
GetAttributeValuesResult	getAttributeValues(GetAttributeValuesRequest getAttributeValuesRequest) Returns a list of attribute values.
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.
GetPriceListFileUrlResult	getPriceListFileUrl(GetPriceListFileUrlRequest getPriceListFileUrlRequest) This feature is in preview release and is subject to change.
GetProductsResult	getProducts(GetProductsRequest getProductsRequest) Returns a list of all products that match the filter criteria.
ListPriceListsResult	listPriceLists(ListPriceListsRequest listPriceListsRequest) This feature is in preview release and is subject to change.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

describeServices

DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)

Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

Parameters:

describeServicesRequest -

Returns:

Result of the DescribeServices operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.

NotFoundException - The requested resource can't be found.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ThrottlingException - You've made too many requests exceeding service quotas.

ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.

See Also:

AWS API Documentation

getAttributeValues

GetAttributeValuesResult getAttributeValues(GetAttributeValuesRequest getAttributeValuesRequest)

Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide.

Parameters:

getAttributeValuesRequest -

Returns:

Result of the GetAttributeValues operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.

NotFoundException - The requested resource can't be found.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ThrottlingException - You've made too many requests exceeding service quotas.

ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.

See Also:

AWS API Documentation

getPriceListFileUrl

GetPriceListFileUrlResult getPriceListFileUrl(GetPriceListFileUrlRequest getPriceListFileUrlRequest)

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.

Parameters:

getPriceListFileUrlRequest -

Returns:

Result of the GetPriceListFileUrl operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

NotFoundException - The requested resource can't be found.

AccessDeniedException - General authentication failure. The request wasn't signed correctly.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ThrottlingException - You've made too many requests exceeding service quotas.

ResourceNotFoundException - The requested resource can't be found.

See Also:

AWS API Documentation

getProducts

GetProductsResult getProducts(GetProductsRequest getProductsRequest)

Returns a list of all products that match the filter criteria.

Parameters:

getProductsRequest -

Returns:

Result of the GetProducts operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.

NotFoundException - The requested resource can't be found.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ThrottlingException - You've made too many requests exceeding service quotas.

ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.

See Also:

AWS API Documentation

listPriceLists

ListPriceListsResult listPriceLists(ListPriceListsRequest listPriceListsRequest)

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.

Parameters:

listPriceListsRequest -

Returns:

Result of the ListPriceLists operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.

NotFoundException - The requested resource can't be found.

AccessDeniedException - General authentication failure. The request wasn't signed correctly.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ThrottlingException - You've made too many requests exceeding service quotas.

ResourceNotFoundException - The requested resource can't be found.

ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.

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.