com.amazonaws.services.pricing

Class AWSPricingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pricing.AWSPricingClient

All Implemented Interfaces:

AWSPricing

Direct Known Subclasses:

AWSPricingAsyncClient

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

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

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 build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and 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 AWS 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.

Service Endpoint

Amazon Web Services Price List service API provides the following two endpoints:

• https://api.pricing.us-east-1.amazonaws.com

• https://api.pricing.ap-south-1.amazonaws.com

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.pricing.AWSPricing

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSPricingClientBuilder	builder()
DescribeServicesResult	describeServices(DescribeServicesRequest request) Returns the metadata for one service or a list of the metadata for all services.
GetAttributeValuesResult	getAttributeValues(GetAttributeValuesRequest request) 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 request) This feature is in preview release and is subject to change.
GetProductsResult	getProducts(GetProductsRequest request) Returns a list of all products that match the filter criteria.
ListPriceListsResult	listPriceLists(ListPriceListsRequest request) 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.

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

describeServices

public DescribeServicesResult describeServices(DescribeServicesRequest request)

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.

Specified by:

describeServices in interface AWSPricing

Parameters:

describeServicesRequest -

Returns:

Result of the DescribeServices operation returned by the service.

Throws:

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

InvalidParameterException - One or more parameters had an invalid value.

NotFoundException - The requested resource can't be found.

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

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

See Also:

AWS API Documentation

getAttributeValues

public GetAttributeValuesResult getAttributeValues(GetAttributeValuesRequest request)

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.

Specified by:

getAttributeValues in interface AWSPricing

Parameters:

getAttributeValuesRequest -

Returns:

Result of the GetAttributeValues operation returned by the service.

Throws:

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

InvalidParameterException - One or more parameters had an invalid value.

NotFoundException - The requested resource can't be found.

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

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

See Also:

AWS API Documentation

getPriceListFileUrl

public GetPriceListFileUrlResult getPriceListFileUrl(GetPriceListFileUrlRequest request)

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.

Specified by:

getPriceListFileUrl in interface AWSPricing

Parameters:

getPriceListFileUrlRequest -

Returns:

Result of the GetPriceListFileUrl operation returned by the service.

Throws:

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

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.

See Also:

AWS API Documentation

getProducts

public GetProductsResult getProducts(GetProductsRequest request)

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

Specified by:

getProducts in interface AWSPricing

Parameters:

getProductsRequest -

Returns:

Result of the GetProducts operation returned by the service.

Throws:

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

InvalidParameterException - One or more parameters had an invalid value.

NotFoundException - The requested resource can't be found.

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

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

See Also:

AWS API Documentation

listPriceLists

public ListPriceListsResult listPriceLists(ListPriceListsRequest request)

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.

Specified by:

listPriceLists in interface AWSPricing

Parameters:

listPriceListsRequest -

Returns:

Result of the ListPriceLists operation returned by the service.

Throws:

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

InvalidParameterException - One or more parameters had an invalid value.

NotFoundException - The requested resource can't be found.

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

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

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

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 AWSPricing

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 AWSPricing

Overrides:

shutdown in class AmazonWebServiceClient