@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PricingClient extends AwsClient
builder() method.
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.
You can use the following endpoints for the Amazon Web Services Price List API:
https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PricingClientBuilder |
builder()
Create a builder that can be used to configure and create a
PricingClient. |
static PricingClient |
create()
Create a
PricingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DescribeServicesResponse |
describeServices()
Returns the metadata for one service or a list of the metadata for all services.
|
default DescribeServicesResponse |
describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Returns the metadata for one service or a list of the metadata for all services.
|
default DescribeServicesResponse |
describeServices(DescribeServicesRequest describeServicesRequest)
Returns the metadata for one service or a list of the metadata for all services.
|
default DescribeServicesIterable |
describeServicesPaginator()
Returns the metadata for one service or a list of the metadata for all services.
|
default DescribeServicesIterable |
describeServicesPaginator(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Returns the metadata for one service or a list of the metadata for all services.
|
default DescribeServicesIterable |
describeServicesPaginator(DescribeServicesRequest describeServicesRequest)
Returns the metadata for one service or a list of the metadata for all services.
|
default GetAttributeValuesResponse |
getAttributeValues(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest)
Returns a list of attribute values.
|
default GetAttributeValuesResponse |
getAttributeValues(GetAttributeValuesRequest getAttributeValuesRequest)
Returns a list of attribute values.
|
default GetAttributeValuesIterable |
getAttributeValuesPaginator(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest)
Returns a list of attribute values.
|
default GetAttributeValuesIterable |
getAttributeValuesPaginator(GetAttributeValuesRequest getAttributeValuesRequest)
Returns a list of attribute values.
|
default GetPriceListFileUrlResponse |
getPriceListFileUrl(Consumer<GetPriceListFileUrlRequest.Builder> getPriceListFileUrlRequest)
This feature is in preview release and is subject to change.
|
default GetPriceListFileUrlResponse |
getPriceListFileUrl(GetPriceListFileUrlRequest getPriceListFileUrlRequest)
This feature is in preview release and is subject to change.
|
default GetProductsResponse |
getProducts(Consumer<GetProductsRequest.Builder> getProductsRequest)
Returns a list of all products that match the filter criteria.
|
default GetProductsResponse |
getProducts(GetProductsRequest getProductsRequest)
Returns a list of all products that match the filter criteria.
|
default GetProductsIterable |
getProductsPaginator(Consumer<GetProductsRequest.Builder> getProductsRequest)
Returns a list of all products that match the filter criteria.
|
default GetProductsIterable |
getProductsPaginator(GetProductsRequest getProductsRequest)
Returns a list of all products that match the filter criteria.
|
default ListPriceListsResponse |
listPriceLists(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest)
This feature is in preview release and is subject to change.
|
default ListPriceListsResponse |
listPriceLists(ListPriceListsRequest listPriceListsRequest)
This feature is in preview release and is subject to change.
|
default ListPriceListsIterable |
listPriceListsPaginator(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest)
This feature is in preview release and is subject to change.
|
default ListPriceListsIterable |
listPriceListsPaginator(ListPriceListsRequest listPriceListsRequest)
This feature is in preview release and is subject to change.
|
default PricingServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a convenience which creates an instance of the DescribeServicesRequest.Builder avoiding the need
to create one manually via DescribeServicesRequest.builder()
describeServicesRequest - A Consumer that will call methods on
DescribeServicesRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServicesResponse describeServices() throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeServices(DescribeServicesRequest),
AWS API
Documentationdefault DescribeServicesIterable describeServicesPaginator() throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client
.describeServicesPaginator(request);
for (software.amazon.awssdk.services.pricing.model.DescribeServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeServicesPaginator(DescribeServicesRequest),
AWS API
Documentationdefault DescribeServicesIterable describeServicesPaginator(DescribeServicesRequest describeServicesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client
.describeServicesPaginator(request);
for (software.amazon.awssdk.services.pricing.model.DescribeServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServicesIterable describeServicesPaginator(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client
.describeServicesPaginator(request);
for (software.amazon.awssdk.services.pricing.model.DescribeServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.DescribeServicesIterable responses = client.describeServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
This is a convenience which creates an instance of the DescribeServicesRequest.Builder avoiding the need
to create one manually via DescribeServicesRequest.builder()
describeServicesRequest - A Consumer that will call methods on
DescribeServicesRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAttributeValuesResponse getAttributeValues(GetAttributeValuesRequest getAttributeValuesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAttributeValuesResponse getAttributeValues(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a convenience which creates an instance of the GetAttributeValuesRequest.Builder avoiding the
need to create one manually via GetAttributeValuesRequest.builder()
getAttributeValuesRequest - A Consumer that will call methods on
GetAttributeValuesRequest.Builder to create a
request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAttributeValuesIterable getAttributeValuesPaginator(GetAttributeValuesRequest getAttributeValuesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of
getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client.getAttributeValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client
.getAttributeValuesPaginator(request);
for (software.amazon.awssdk.services.pricing.model.GetAttributeValuesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client.getAttributeValuesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest)
operation.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAttributeValuesIterable getAttributeValuesPaginator(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of
getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client.getAttributeValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client
.getAttributeValuesPaginator(request);
for (software.amazon.awssdk.services.pricing.model.GetAttributeValuesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.GetAttributeValuesIterable responses = client.getAttributeValuesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest)
operation.
This is a convenience which creates an instance of the GetAttributeValuesRequest.Builder avoiding the
need to create one manually via GetAttributeValuesRequest.builder()
getAttributeValuesRequest - A Consumer that will call methods on
GetAttributeValuesRequest.Builder to create a
request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPriceListFileUrlResponse getPriceListFileUrl(GetPriceListFileUrlRequest getPriceListFileUrlRequest) throws InvalidParameterException, NotFoundException, AccessDeniedException, InternalErrorException, AwsServiceException, SdkClientException, PricingException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPriceListFileUrlResponse getPriceListFileUrl(Consumer<GetPriceListFileUrlRequest.Builder> getPriceListFileUrlRequest) throws InvalidParameterException, NotFoundException, AccessDeniedException, InternalErrorException, AwsServiceException, SdkClientException, PricingException
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.
This is a convenience which creates an instance of the GetPriceListFileUrlRequest.Builder avoiding the
need to create one manually via GetPriceListFileUrlRequest.builder()
getPriceListFileUrlRequest - A Consumer that will call methods on
GetPriceListFileUrlRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetProductsResponse getProducts(GetProductsRequest getProductsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetProductsResponse getProducts(Consumer<GetProductsRequest.Builder> getProductsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
Returns a list of all products that match the filter criteria.
This is a convenience which creates an instance of the GetProductsRequest.Builder avoiding the need to
create one manually via GetProductsRequest.builder()
getProductsRequest - A Consumer that will call methods on
GetProductsRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetProductsIterable getProductsPaginator(GetProductsRequest getProductsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
Returns a list of all products that match the filter criteria.
This is a variant of getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
for (software.amazon.awssdk.services.pricing.model.GetProductsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest) operation.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetProductsIterable getProductsPaginator(Consumer<GetProductsRequest.Builder> getProductsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
Returns a list of all products that match the filter criteria.
This is a variant of getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
for (software.amazon.awssdk.services.pricing.model.GetProductsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.GetProductsIterable responses = client.getProductsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest) operation.
This is a convenience which creates an instance of the GetProductsRequest.Builder avoiding the need to
create one manually via GetProductsRequest.builder()
getProductsRequest - A Consumer that will call methods on
GetProductsRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPriceListsResponse listPriceLists(ListPriceListsRequest listPriceListsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, AccessDeniedException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPriceListsResponse listPriceLists(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, AccessDeniedException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a convenience which creates an instance of the ListPriceListsRequest.Builder avoiding the need to
create one manually via ListPriceListsRequest.builder()
listPriceListsRequest - A Consumer that will call methods on
ListPriceListsRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPriceListsIterable listPriceListsPaginator(ListPriceListsRequest listPriceListsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, AccessDeniedException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
for (software.amazon.awssdk.services.pricing.model.ListPriceListsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest) operation.
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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPriceListsIterable listPriceListsPaginator(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest) throws InvalidParameterException, InvalidNextTokenException, NotFoundException, AccessDeniedException, InternalErrorException, ExpiredNextTokenException, AwsServiceException, SdkClientException, PricingException
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.
This is a variant of listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
for (software.amazon.awssdk.services.pricing.model.ListPriceListsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pricing.paginators.ListPriceListsIterable responses = client.listPriceListsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest) operation.
This is a convenience which creates an instance of the ListPriceListsRequest.Builder avoiding the need to
create one manually via ListPriceListsRequest.builder()
listPriceListsRequest - A Consumer that will call methods on
ListPriceListsRequest.Builder to create a request.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.ExpiredNextTokenException - The pagination token expired. Try again without a pagination token.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PricingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic PricingClient create()
PricingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PricingClientBuilder builder()
PricingClient.static ServiceMetadata serviceMetadata()
default PricingServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.