Package software.amazon.awssdk.services.billing

Interface BillingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Billing. This can be created using the static builder() method.

You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.

The Billing API provides the following endpoint:

https://billing.us-east-1.api.aws

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BillingClientBuilder	builder()	Create a builder that can be used to configure and create a BillingClient.
static BillingClient	create()	Create a BillingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListBillingViewsResponse	listBillingViews(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)	Lists the billing views available for a given time period.
default ListBillingViewsResponse	listBillingViews(ListBillingViewsRequest listBillingViewsRequest)	Lists the billing views available for a given time period.
default ListBillingViewsIterable	listBillingViewsPaginator(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)	This is a variant of listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) operation.
default ListBillingViewsIterable	listBillingViewsPaginator(ListBillingViewsRequest listBillingViewsRequest)	This is a variant of listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) operation.
default BillingServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

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 Detail

listBillingViews

default ListBillingViewsResponse listBillingViews(ListBillingViewsRequest listBillingViewsRequest)
                                           throws ThrottlingException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BillingException

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

Parameters:

listBillingViewsRequest -

Returns:

Result of the ListBillingViews operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing failed because of an unknown error, exception, or failure.

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.

BillingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBillingViews

default ListBillingViewsResponse listBillingViews(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)
                                           throws ThrottlingException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BillingException

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

This is a convenience which creates an instance of the ListBillingViewsRequest.Builder avoiding the need to create one manually via ListBillingViewsRequest.builder()

Parameters:

listBillingViewsRequest - A Consumer that will call methods on ListBillingViewsRequest.Builder to create a request.

Returns:

Result of the ListBillingViews operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing failed because of an unknown error, exception, or failure.

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.

BillingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBillingViewsPaginator

default ListBillingViewsIterable listBillingViewsPaginator(ListBillingViewsRequest listBillingViewsRequest)
                                                    throws ThrottlingException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           InternalServerException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           BillingException

This is a variant of listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) 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.billing.paginators.ListBillingViewsIterable responses = client.listBillingViewsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.billing.paginators.ListBillingViewsIterable responses = client
             .listBillingViewsPaginator(request);
     for (software.amazon.awssdk.services.billing.model.ListBillingViewsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.billing.paginators.ListBillingViewsIterable responses = client.listBillingViewsPaginator(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 listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) operation.

Parameters:

listBillingViewsRequest -

Returns:

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

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing failed because of an unknown error, exception, or failure.

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.

BillingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listBillingViewsPaginator

default ListBillingViewsIterable listBillingViewsPaginator(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)
                                                    throws ThrottlingException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           InternalServerException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           BillingException

This is a variant of listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) 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.billing.paginators.ListBillingViewsIterable responses = client.listBillingViewsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.billing.paginators.ListBillingViewsIterable responses = client
             .listBillingViewsPaginator(request);
     for (software.amazon.awssdk.services.billing.model.ListBillingViewsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.billing.paginators.ListBillingViewsIterable responses = client.listBillingViewsPaginator(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 listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest) operation.

This is a convenience which creates an instance of the ListBillingViewsRequest.Builder avoiding the need to create one manually via ListBillingViewsRequest.builder()

Parameters:

listBillingViewsRequest - A Consumer that will call methods on ListBillingViewsRequest.Builder to create a request.

Returns:

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

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You don't have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing failed because of an unknown error, exception, or failure.

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.

BillingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static BillingClient create()

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

builder

static BillingClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BillingServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient