@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSPricing
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
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
.
describeServicesRequest
- 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.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.
getAttributeValuesRequest
- 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.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.
getPriceListFileUrlRequest
- 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.GetProductsResult getProducts(GetProductsRequest getProductsRequest)
Returns a list of all products that match the filter criteria.
getProductsRequest
- 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.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.
listPriceListsRequest
- 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.void shutdown()
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 a request.
request
- The originally executed request.