Package software.amazon.awssdk.services.bcmdataexports

Interface BcmDataExportsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Billing and Cost Management Data Exports. This can be created using the static builder() method.

You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost optimization recommendations.

The Data Exports API provides the following endpoint:

• https://bcm-data-exports.us-east-1.api.aws

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 BcmDataExportsClientBuilder	builder()	Create a builder that can be used to configure and create a BcmDataExportsClient.
static BcmDataExportsClient	create()	Create a BcmDataExportsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateExportResponse	createExport(Consumer<CreateExportRequest.Builder> createExportRequest)	Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.
default CreateExportResponse	createExport(CreateExportRequest createExportRequest)	Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.
default DeleteExportResponse	deleteExport(Consumer<DeleteExportRequest.Builder> deleteExportRequest)	Deletes an existing data export.
default DeleteExportResponse	deleteExport(DeleteExportRequest deleteExportRequest)	Deletes an existing data export.
default GetExecutionResponse	getExecution(Consumer<GetExecutionRequest.Builder> getExecutionRequest)	Exports data based on the source data update.
default GetExecutionResponse	getExecution(GetExecutionRequest getExecutionRequest)	Exports data based on the source data update.
default GetExportResponse	getExport(Consumer<GetExportRequest.Builder> getExportRequest)	Views the definition of an existing data export.
default GetExportResponse	getExport(GetExportRequest getExportRequest)	Views the definition of an existing data export.
default GetTableResponse	getTable(Consumer<GetTableRequest.Builder> getTableRequest)	Returns the metadata for the specified table and table properties.
default GetTableResponse	getTable(GetTableRequest getTableRequest)	Returns the metadata for the specified table and table properties.
default ListExecutionsResponse	listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)	Lists the historical executions for the export.
default ListExecutionsResponse	listExecutions(ListExecutionsRequest listExecutionsRequest)	Lists the historical executions for the export.
default ListExecutionsIterable	listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)	This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.
default ListExecutionsIterable	listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)	This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.
default ListExportsResponse	listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)	Lists all data export definitions.
default ListExportsResponse	listExports(ListExportsRequest listExportsRequest)	Lists all data export definitions.
default ListExportsIterable	listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.
default ListExportsIterable	listExportsPaginator(ListExportsRequest listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.
default ListTablesResponse	listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)	Lists all available tables in data exports.
default ListTablesResponse	listTables(ListTablesRequest listTablesRequest)	Lists all available tables in data exports.
default ListTablesIterable	listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)	This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.
default ListTablesIterable	listTablesPaginator(ListTablesRequest listTablesRequest)	This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List tags associated with an existing data export.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List tags associated with an existing data export.
default BcmDataExportsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags for an existing data export definition.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags for an existing data export definition.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Deletes tags associated with an existing data export definition.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Deletes tags associated with an existing data export definition.
default UpdateExportResponse	updateExport(Consumer<UpdateExportRequest.Builder> updateExportRequest)	Updates an existing data export by overwriting all export parameters.
default UpdateExportResponse	updateExport(UpdateExportRequest updateExportRequest)	Updates an existing data export by overwriting all export parameters.

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

createExport

default CreateExportResponse createExport(CreateExportRequest createExportRequest)
                                   throws ServiceQuotaExceededException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations.

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

Parameters:

createExportRequest -

Returns:

Result of the CreateExport operation returned by the service.

See Also:

• AWS API Documentation

createExport

default CreateExportResponse createExport(Consumer<CreateExportRequest.Builder> createExportRequest)
                                   throws ServiceQuotaExceededException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations.

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

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

Parameters:

createExportRequest - A Consumer that will call methods on CreateExportRequest.Builder to create a request.

Returns:

Result of the CreateExport operation returned by the service.

See Also:

• AWS API Documentation

deleteExport

default DeleteExportResponse deleteExport(DeleteExportRequest deleteExportRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Deletes an existing data export.

Parameters:

deleteExportRequest -

Returns:

Result of the DeleteExport operation returned by the service.

See Also:

• AWS API Documentation

deleteExport

default DeleteExportResponse deleteExport(Consumer<DeleteExportRequest.Builder> deleteExportRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Deletes an existing data export.

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

Parameters:

deleteExportRequest - A Consumer that will call methods on DeleteExportRequest.Builder to create a request.

Returns:

Result of the DeleteExport operation returned by the service.

See Also:

• AWS API Documentation

getExecution

default GetExecutionResponse getExecution(GetExecutionRequest getExecutionRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Exports data based on the source data update.

Parameters:

getExecutionRequest -

Returns:

Result of the GetExecution operation returned by the service.

See Also:

• AWS API Documentation

getExecution

default GetExecutionResponse getExecution(Consumer<GetExecutionRequest.Builder> getExecutionRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Exports data based on the source data update.

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

Parameters:

getExecutionRequest - A Consumer that will call methods on GetExecutionRequest.Builder to create a request.

Returns:

Result of the GetExecution operation returned by the service.

See Also:

• AWS API Documentation

getExport

default GetExportResponse getExport(GetExportRequest getExportRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Views the definition of an existing data export.

Parameters:

getExportRequest -

Returns:

Result of the GetExport operation returned by the service.

See Also:

• AWS API Documentation

getExport

default GetExportResponse getExport(Consumer<GetExportRequest.Builder> getExportRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Views the definition of an existing data export.

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

Parameters:

getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request.

Returns:

Result of the GetExport operation returned by the service.

See Also:

• AWS API Documentation

getTable

default GetTableResponse getTable(GetTableRequest getTableRequest)
                           throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

Parameters:

getTableRequest -

Returns:

Result of the GetTable operation returned by the service.

See Also:

• AWS API Documentation

getTable

default GetTableResponse getTable(Consumer<GetTableRequest.Builder> getTableRequest)
                           throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

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

Parameters:

getTableRequest - A Consumer that will call methods on GetTableRequest.Builder to create a request.

Returns:

Result of the GetTable operation returned by the service.

See Also:

• AWS API Documentation

listExecutions

default ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists the historical executions for the export.

Parameters:

listExecutionsRequest -

Returns:

Result of the ListExecutions operation returned by the service.

See Also:

• AWS API Documentation

listExecutions

default ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists the historical executions for the export.

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

Parameters:

listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.

Returns:

Result of the ListExecutions operation returned by the service.

See Also:

• AWS API Documentation

listExecutionsPaginator

default ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
                                                throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) 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.bcmdataexports.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsIterable responses = client
             .listExecutionsPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(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 listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.

Parameters:

listExecutionsRequest -

Returns:

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

See Also:

• AWS API Documentation

listExecutionsPaginator

default ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
                                                throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) 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.bcmdataexports.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsIterable responses = client
             .listExecutionsPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(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 listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.

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

Parameters:

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

listExports

default ListExportsResponse listExports(ListExportsRequest listExportsRequest)
                                 throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists all data export definitions.

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

See Also:

• AWS API Documentation

listExports

default ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                 throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists all data export definitions.

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

Parameters:

listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.

Returns:

Result of the ListExports operation returned by the service.

See Also:

• AWS API Documentation

listExportsPaginator

default ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest)
                                          throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) 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.bcmdataexports.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsIterable responses = client
             .listExportsPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsIterable responses = client.listExportsPaginator(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 listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.

Parameters:

listExportsRequest -

Returns:

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

See Also:

• AWS API Documentation

listExportsPaginator

default ListExportsIterable listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                          throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) 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.bcmdataexports.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsIterable responses = client
             .listExportsPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsIterable responses = client.listExportsPaginator(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 listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.

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

Parameters:

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

listTables

default ListTablesResponse listTables(ListTablesRequest listTablesRequest)
                               throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists all available tables in data exports.

Parameters:

listTablesRequest -

Returns:

Result of the ListTables operation returned by the service.

See Also:

• AWS API Documentation

listTables

default ListTablesResponse listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
                               throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Lists all available tables in data exports.

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

Parameters:

listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.

Returns:

Result of the ListTables operation returned by the service.

See Also:

• AWS API Documentation

listTablesPaginator

default ListTablesIterable listTablesPaginator(ListTablesRequest listTablesRequest)
                                        throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) 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.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(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 listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.

Parameters:

listTablesRequest -

Returns:

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

See Also:

• AWS API Documentation

listTablesPaginator

default ListTablesIterable listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
                                        throws InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) 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.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
     for (software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesIterable responses = client.listTablesPaginator(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 listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.

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

Parameters:

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

listTagsForResource

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

List tags associated with an existing data export.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

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

List tags associated with an existing data export.

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.

See Also:

• AWS API Documentation

tagResource

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

Adds tags for an existing data export definition.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

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

Adds tags for an existing data export definition.

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.

See Also:

• AWS API Documentation

untagResource

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

Deletes tags associated with an existing data export definition.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

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

Deletes tags associated with an existing data export definition.

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.

See Also:

• AWS API Documentation

updateExport

default UpdateExportResponse updateExport(UpdateExportRequest updateExportRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

Parameters:

updateExportRequest -

Returns:

Result of the UpdateExport operation returned by the service.

See Also:

• AWS API Documentation

updateExport

default UpdateExportResponse updateExport(Consumer<UpdateExportRequest.Builder> updateExportRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDataExportsException

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

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

Parameters:

updateExportRequest - A Consumer that will call methods on UpdateExportRequest.Builder to create a request.

Returns:

Result of the UpdateExport operation returned by the service.

See Also:

• AWS API Documentation

create

static BcmDataExportsClient create()

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

builder

static BcmDataExportsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BcmDataExportsServiceClientConfiguration 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