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 CreateBillingViewResponse	createBillingView(Consumer<CreateBillingViewRequest.Builder> createBillingViewRequest)	Creates a billing view with the specified billing view attributes.
default CreateBillingViewResponse	createBillingView(CreateBillingViewRequest createBillingViewRequest)	Creates a billing view with the specified billing view attributes.
default DeleteBillingViewResponse	deleteBillingView(Consumer<DeleteBillingViewRequest.Builder> deleteBillingViewRequest)	Deletes the specified billing view.
default DeleteBillingViewResponse	deleteBillingView(DeleteBillingViewRequest deleteBillingViewRequest)	Deletes the specified billing view.
default GetBillingViewResponse	getBillingView(Consumer<GetBillingViewRequest.Builder> getBillingViewRequest)	Returns the metadata associated to the specified billing view ARN.
default GetBillingViewResponse	getBillingView(GetBillingViewRequest getBillingViewRequest)	Returns the metadata associated to the specified billing view ARN.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Returns the resource-based policy document attached to the resource in JSON format.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Returns the resource-based policy document attached to the resource in JSON format.
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 ListSourceViewsForBillingViewResponse	listSourceViewsForBillingView(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)	Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
default ListSourceViewsForBillingViewResponse	listSourceViewsForBillingView(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)	Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
default ListSourceViewsForBillingViewIterable	listSourceViewsForBillingViewPaginator(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)	This is a variant of listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) operation.
default ListSourceViewsForBillingViewIterable	listSourceViewsForBillingViewPaginator(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)	This is a variant of listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists tags associated with the billing view resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists tags associated with the billing view resource.
default BillingServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	An API operation for adding one or more tags (key-value pairs) to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	An API operation for adding one or more tags (key-value pairs) to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from a resource.
default UpdateBillingViewResponse	updateBillingView(Consumer<UpdateBillingViewRequest.Builder> updateBillingViewRequest)	An API to update the attributes of the billing view.
default UpdateBillingViewResponse	updateBillingView(UpdateBillingViewRequest updateBillingViewRequest)	An API to update the attributes of the billing view.

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

createBillingView

default CreateBillingViewResponse createBillingView(CreateBillingViewRequest createBillingViewRequest)
                                             throws ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Creates a billing view with the specified billing view attributes.

Parameters:

createBillingViewRequest -

Returns:

Result of the CreateBillingView operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException - The request was denied due to request throttling.

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

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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

createBillingView

default CreateBillingViewResponse createBillingView(Consumer<CreateBillingViewRequest.Builder> createBillingViewRequest)
                                             throws ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Creates a billing view with the specified billing view attributes.

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

Parameters:

createBillingViewRequest - A Consumer that will call methods on CreateBillingViewRequest.Builder to create a request.

Returns:

Result of the CreateBillingView operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException - The request was denied due to request throttling.

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

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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

deleteBillingView

default DeleteBillingViewResponse deleteBillingView(DeleteBillingViewRequest deleteBillingViewRequest)
                                             throws ThrottlingException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Deletes the specified billing view.

Parameters:

deleteBillingViewRequest -

Returns:

Result of the DeleteBillingView 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.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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

deleteBillingView

default DeleteBillingViewResponse deleteBillingView(Consumer<DeleteBillingViewRequest.Builder> deleteBillingViewRequest)
                                             throws ThrottlingException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Deletes the specified billing view.

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

Parameters:

deleteBillingViewRequest - A Consumer that will call methods on DeleteBillingViewRequest.Builder to create a request.

Returns:

Result of the DeleteBillingView 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.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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

getBillingView

default GetBillingViewResponse getBillingView(GetBillingViewRequest getBillingViewRequest)
                                       throws ThrottlingException,
                                              ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              BillingException

Returns the metadata associated to the specified billing view ARN.

Parameters:

getBillingViewRequest -

Returns:

Result of the GetBillingView operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

getBillingView

default GetBillingViewResponse getBillingView(Consumer<GetBillingViewRequest.Builder> getBillingViewRequest)
                                       throws ThrottlingException,
                                              ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              BillingException

Returns the metadata associated to the specified billing view ARN.

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

Parameters:

getBillingViewRequest - A Consumer that will call methods on GetBillingViewRequest.Builder to create a request.

Returns:

Result of the GetBillingView operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ThrottlingException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Returns the resource-based policy document attached to the resource in JSON format.

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ThrottlingException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

Returns the resource-based policy document attached to the resource in JSON format.

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

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listSourceViewsForBillingView

default ListSourceViewsForBillingViewResponse listSourceViewsForBillingView(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)
                                                                     throws ThrottlingException,
                                                                            ResourceNotFoundException,
                                                                            AccessDeniedException,
                                                                            ValidationException,
                                                                            InternalServerException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            BillingException

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

Parameters:

listSourceViewsForBillingViewRequest -

Returns:

Result of the ListSourceViewsForBillingView operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listSourceViewsForBillingView

default ListSourceViewsForBillingViewResponse listSourceViewsForBillingView(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)
                                                                     throws ThrottlingException,
                                                                            ResourceNotFoundException,
                                                                            AccessDeniedException,
                                                                            ValidationException,
                                                                            InternalServerException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            BillingException

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

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

Parameters:

listSourceViewsForBillingViewRequest - A Consumer that will call methods on ListSourceViewsForBillingViewRequest.Builder to create a request.

Returns:

Result of the ListSourceViewsForBillingView operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listSourceViewsForBillingViewPaginator

default ListSourceViewsForBillingViewIterable listSourceViewsForBillingViewPaginator(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)
                                                                              throws ThrottlingException,
                                                                                     ResourceNotFoundException,
                                                                                     AccessDeniedException,
                                                                                     ValidationException,
                                                                                     InternalServerException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     BillingException

This is a variant of listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) 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.ListSourceViewsForBillingViewIterable responses = client.listSourceViewsForBillingViewPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewIterable responses = client.listSourceViewsForBillingViewPaginator(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 listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) operation.

Parameters:

listSourceViewsForBillingViewRequest -

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.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listSourceViewsForBillingViewPaginator

default ListSourceViewsForBillingViewIterable listSourceViewsForBillingViewPaginator(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)
                                                                              throws ThrottlingException,
                                                                                     ResourceNotFoundException,
                                                                                     AccessDeniedException,
                                                                                     ValidationException,
                                                                                     InternalServerException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     BillingException

This is a variant of listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) 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.ListSourceViewsForBillingViewIterable responses = client.listSourceViewsForBillingViewPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewIterable responses = client.listSourceViewsForBillingViewPaginator(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 listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest) operation.

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

Parameters:

listSourceViewsForBillingViewRequest - A Consumer that will call methods on ListSourceViewsForBillingViewRequest.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.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        BillingException

Lists tags associated with the billing view resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        BillingException

Lists tags associated with the billing view resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ThrottlingException,
                                        ResourceNotFoundException,
                                        AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        BillingException

An API operation for adding one or more tags (key-value pairs) to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ThrottlingException,
                                        ResourceNotFoundException,
                                        AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        BillingException

An API operation for adding one or more tags (key-value pairs) to a resource.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            BillingException

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            BillingException

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

updateBillingView

default UpdateBillingViewResponse updateBillingView(UpdateBillingViewRequest updateBillingViewRequest)
                                             throws ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

An API to update the attributes of the billing view.

Parameters:

updateBillingViewRequest -

Returns:

Result of the UpdateBillingView operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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

updateBillingView

default UpdateBillingViewResponse updateBillingView(Consumer<UpdateBillingViewRequest.Builder> updateBillingViewRequest)
                                             throws ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ConflictException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    BillingException

An API to update the attributes of the billing view.

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

Parameters:

updateBillingViewRequest - A Consumer that will call methods on UpdateBillingViewRequest.Builder to create a request.

Returns:

Result of the UpdateBillingView operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The specified ARN in the request doesn't exist.

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

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

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