Interface PricingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PricingClient
extends AwsClient

Service client for accessing AWS Pricing. This can be created using the static 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 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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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()	This is a variant of describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
default DescribeServicesIterable	describeServicesPaginator(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)	This is a variant of describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
default DescribeServicesIterable	describeServicesPaginator(DescribeServicesRequest describeServicesRequest)	This is a variant of describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest) operation.
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)	This is a variant of getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest) operation.
default GetAttributeValuesIterable	getAttributeValuesPaginator(GetAttributeValuesRequest getAttributeValuesRequest)	This is a variant of getAttributeValues(software.amazon.awssdk.services.pricing.model.GetAttributeValuesRequest) operation.
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)	This is a variant of getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest) operation.
default GetProductsIterable	getProductsPaginator(GetProductsRequest getProductsRequest)	This is a variant of getProducts(software.amazon.awssdk.services.pricing.model.GetProductsRequest) operation.
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 is a variant of listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest) operation.
default ListPriceListsIterable	listPriceListsPaginator(ListPriceListsRequest listPriceListsRequest)	This is a variant of listPriceLists(software.amazon.awssdk.services.pricing.model.ListPriceListsRequest) operation.
default PricingServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

describeServices

default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest)
                                           throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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.

Parameters:

describeServicesRequest -

Returns:

Result of the DescribeServices operation returned by the service.

See Also:

• AWS API Documentation

describeServices

default DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
                                           throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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()

Parameters:

describeServicesRequest - A Consumer that will call methods on DescribeServicesRequest.Builder to create a request.

Returns:

Result of the DescribeServices operation returned by the service.

See Also:

• AWS API Documentation

describeServices

default DescribeServicesResponse describeServices()
                                           throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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.

Returns:

Result of the DescribeServices operation returned by the service.

See Also:

• describeServices(DescribeServicesRequest)
• AWS API Documentation

describeServicesPaginator

default DescribeServicesIterable describeServicesPaginator()
                                                    throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeServicesPaginator(DescribeServicesRequest)
• AWS API Documentation

describeServicesPaginator

default DescribeServicesIterable describeServicesPaginator(DescribeServicesRequest describeServicesRequest)
                                                    throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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.

Parameters:

describeServicesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeServicesPaginator

default DescribeServicesIterable describeServicesPaginator(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
                                                    throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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

Parameters:

describeServicesRequest - A Consumer that will call methods on DescribeServicesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAttributeValues

default GetAttributeValuesResponse getAttributeValues(GetAttributeValuesRequest getAttributeValuesRequest)
                                               throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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.

Parameters:

getAttributeValuesRequest -

Returns:

Result of the GetAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

getAttributeValues

default GetAttributeValuesResponse getAttributeValues(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest)
                                               throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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()

Parameters:

getAttributeValuesRequest - A Consumer that will call methods on GetAttributeValuesRequest.Builder to create a request.

Returns:

Result of the GetAttributeValues operation returned by the service.

See Also:

• AWS API Documentation

getAttributeValuesPaginator

default GetAttributeValuesIterable getAttributeValuesPaginator(GetAttributeValuesRequest getAttributeValuesRequest)
                                                        throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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.

Parameters:

getAttributeValuesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAttributeValuesPaginator

default GetAttributeValuesIterable getAttributeValuesPaginator(Consumer<GetAttributeValuesRequest.Builder> getAttributeValuesRequest)
                                                        throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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

Parameters:

getAttributeValuesRequest - A Consumer that will call methods on GetAttributeValuesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getPriceListFileUrl

default GetPriceListFileUrlResponse getPriceListFileUrl(GetPriceListFileUrlRequest getPriceListFileUrlRequest)
                                                 throws InvalidParameterException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
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.

Parameters:

getPriceListFileUrlRequest -

Returns:

Result of the GetPriceListFileUrl operation returned by the service.

See Also:

• AWS API Documentation

getPriceListFileUrl

default GetPriceListFileUrlResponse getPriceListFileUrl(Consumer<GetPriceListFileUrlRequest.Builder> getPriceListFileUrlRequest)
                                                 throws InvalidParameterException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
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()

Parameters:

getPriceListFileUrlRequest - A Consumer that will call methods on GetPriceListFileUrlRequest.Builder to create a request.

Returns:

Result of the GetPriceListFileUrl operation returned by the service.

See Also:

• AWS API Documentation

getProducts

default GetProductsResponse getProducts(GetProductsRequest getProductsRequest)
                                 throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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

Parameters:

getProductsRequest -

Returns:

Result of the GetProducts operation returned by the service.

See Also:

• AWS API Documentation

getProducts

default GetProductsResponse getProducts(Consumer<GetProductsRequest.Builder> getProductsRequest)
                                 throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
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()

Parameters:

getProductsRequest - A Consumer that will call methods on GetProductsRequest.Builder to create a request.

Returns:

Result of the GetProducts operation returned by the service.

See Also:

• AWS API Documentation

getProductsPaginator

default GetProductsIterable getProductsPaginator(GetProductsRequest getProductsRequest)
                                          throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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.

Parameters:

getProductsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getProductsPaginator

default GetProductsIterable getProductsPaginator(Consumer<GetProductsRequest.Builder> getProductsRequest)
                                          throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
InternalErrorException,
ThrottlingException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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

Parameters:

getProductsRequest - A Consumer that will call methods on GetProductsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPriceLists

default ListPriceListsResponse listPriceLists(ListPriceListsRequest listPriceListsRequest)
                                       throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
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.

Parameters:

listPriceListsRequest -

Returns:

Result of the ListPriceLists operation returned by the service.

See Also:

• AWS API Documentation

listPriceLists

default ListPriceListsResponse listPriceLists(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest)
                                       throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
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()

Parameters:

listPriceListsRequest - A Consumer that will call methods on ListPriceListsRequest.Builder to create a request.

Returns:

Result of the ListPriceLists operation returned by the service.

See Also:

• AWS API Documentation

listPriceListsPaginator

default ListPriceListsIterable listPriceListsPaginator(ListPriceListsRequest listPriceListsRequest)
                                                throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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.

Parameters:

listPriceListsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPriceListsPaginator

default ListPriceListsIterable listPriceListsPaginator(Consumer<ListPriceListsRequest.Builder> listPriceListsRequest)
                                                throws InvalidParameterException,
InvalidNextTokenException,
NotFoundException,
AccessDeniedException,
InternalErrorException,
ThrottlingException,
ResourceNotFoundException,
ExpiredNextTokenException,
AwsServiceException,
SdkClientException,
PricingException

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

Parameters:

listPriceListsRequest - A Consumer that will call methods on ListPriceListsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

create

static PricingClient create()

Create a PricingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PricingClientBuilder builder()

Create a builder that can be used to configure and create a PricingClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PricingServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration