@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSPricingClient extends AmazonWebServiceClient implements AWSPricing
AWS Price List Service API (AWS Price List Service) is a centralized and convenient way to programmatically query
Amazon Web Services for services, products, and pricing information. The AWS Price List Service uses standardized
product attributes such as Location
, Storage Class
, and Operating System
, and
provides prices at the SKU level. You can use the AWS Price List Service 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 AWS.
Use GetServices
without a service code to retrieve the service codes for all AWS services, then
GetServices
with a service code to retreive 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
AWS 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
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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.
|
GetProductsResult |
getProducts(GetProductsRequest request)
Returns a list of all products that match the filter criteria.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AWSPricingClientBuilder builder()
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
.
describeServices
in interface AWSPricing
describeServicesRequest
- 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.public GetAttributeValuesResult getAttributeValues(GetAttributeValuesRequest request)
Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide.
getAttributeValues
in interface AWSPricing
getAttributeValuesRequest
- 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.public GetProductsResult getProducts(GetProductsRequest request)
Returns a list of all products that match the filter criteria.
getProducts
in interface AWSPricing
getProductsRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSPricing
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.