software.amazon.awssdk.services.qldb

Interface QldbAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface QldbAsyncClient
extends SdkClient

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

The control plane for Amazon QLDB

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static QldbAsyncClientBuilder	builder() Create a builder that can be used to configure and create a QldbAsyncClient.
default CompletableFuture<CancelJournalKinesisStreamResponse>	cancelJournalKinesisStream(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.
default CompletableFuture<CancelJournalKinesisStreamResponse>	cancelJournalKinesisStream(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest) Ends a given Amazon QLDB journal stream.
static QldbAsyncClient	create() Create a QldbAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateLedgerResponse>	createLedger(Consumer<CreateLedgerRequest.Builder> createLedgerRequest) Creates a new ledger in your AWS account.
default CompletableFuture<CreateLedgerResponse>	createLedger(CreateLedgerRequest createLedgerRequest) Creates a new ledger in your AWS account.
default CompletableFuture<DeleteLedgerResponse>	deleteLedger(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest) Deletes a ledger and all of its contents.
default CompletableFuture<DeleteLedgerResponse>	deleteLedger(DeleteLedgerRequest deleteLedgerRequest) Deletes a ledger and all of its contents.
default CompletableFuture<DescribeJournalKinesisStreamResponse>	describeJournalKinesisStream(Consumer<DescribeJournalKinesisStreamRequest.Builder> describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream.
default CompletableFuture<DescribeJournalKinesisStreamResponse>	describeJournalKinesisStream(DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest) Returns detailed information about a given Amazon QLDB journal stream.
default CompletableFuture<DescribeJournalS3ExportResponse>	describeJournalS3Export(Consumer<DescribeJournalS3ExportRequest.Builder> describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
default CompletableFuture<DescribeJournalS3ExportResponse>	describeJournalS3Export(DescribeJournalS3ExportRequest describeJournalS3ExportRequest) Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
default CompletableFuture<DescribeLedgerResponse>	describeLedger(Consumer<DescribeLedgerRequest.Builder> describeLedgerRequest) Returns information about a ledger, including its state and when it was created.
default CompletableFuture<DescribeLedgerResponse>	describeLedger(DescribeLedgerRequest describeLedgerRequest) Returns information about a ledger, including its state and when it was created.
default CompletableFuture<ExportJournalToS3Response>	exportJournalToS3(Consumer<ExportJournalToS3Request.Builder> exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
default CompletableFuture<ExportJournalToS3Response>	exportJournalToS3(ExportJournalToS3Request exportJournalToS3Request) Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
default CompletableFuture<GetBlockResponse>	getBlock(Consumer<GetBlockRequest.Builder> getBlockRequest) Returns a block object at a specified address in a journal.
default CompletableFuture<GetBlockResponse>	getBlock(GetBlockRequest getBlockRequest) Returns a block object at a specified address in a journal.
default CompletableFuture<GetDigestResponse>	getDigest(Consumer<GetDigestRequest.Builder> getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.
default CompletableFuture<GetDigestResponse>	getDigest(GetDigestRequest getDigestRequest) Returns the digest of a ledger at the latest committed block in the journal.
default CompletableFuture<GetRevisionResponse>	getRevision(Consumer<GetRevisionRequest.Builder> getRevisionRequest) Returns a revision data object for a specified document ID and block address.
default CompletableFuture<GetRevisionResponse>	getRevision(GetRevisionRequest getRevisionRequest) Returns a revision data object for a specified document ID and block address.
default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse>	listJournalKinesisStreamsForLedger(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse>	listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
default ListJournalKinesisStreamsForLedgerPublisher	listJournalKinesisStreamsForLedgerPaginator(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest) Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
default ListJournalKinesisStreamsForLedgerPublisher	listJournalKinesisStreamsForLedgerPaginator(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest) Returns an array of all Amazon QLDB journal stream descriptors for a given ledger.
default CompletableFuture<ListJournalS3ExportsResponse>	listJournalS3Exports(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
default CompletableFuture<ListJournalS3ExportsResponse>	listJournalS3Exports(ListJournalS3ExportsRequest listJournalS3ExportsRequest) Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
default CompletableFuture<ListJournalS3ExportsForLedgerResponse>	listJournalS3ExportsForLedger(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) Returns an array of journal export job descriptions for a specified ledger.
default CompletableFuture<ListJournalS3ExportsForLedgerResponse>	listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) Returns an array of journal export job descriptions for a specified ledger.
default ListJournalS3ExportsForLedgerPublisher	listJournalS3ExportsForLedgerPaginator(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest) Returns an array of journal export job descriptions for a specified ledger.
default ListJournalS3ExportsForLedgerPublisher	listJournalS3ExportsForLedgerPaginator(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest) Returns an array of journal export job descriptions for a specified ledger.
default ListJournalS3ExportsPublisher	listJournalS3ExportsPaginator(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest) Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
default ListJournalS3ExportsPublisher	listJournalS3ExportsPaginator(ListJournalS3ExportsRequest listJournalS3ExportsRequest) Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
default CompletableFuture<ListLedgersResponse>	listLedgers(Consumer<ListLedgersRequest.Builder> listLedgersRequest) Returns an array of ledger summaries that are associated with the current AWS account and Region.
default CompletableFuture<ListLedgersResponse>	listLedgers(ListLedgersRequest listLedgersRequest) Returns an array of ledger summaries that are associated with the current AWS account and Region.
default ListLedgersPublisher	listLedgersPaginator(Consumer<ListLedgersRequest.Builder> listLedgersRequest) Returns an array of ledger summaries that are associated with the current AWS account and Region.
default ListLedgersPublisher	listLedgersPaginator(ListLedgersRequest listLedgersRequest) Returns an array of ledger summaries that are associated with the current AWS account and Region.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns all tags for a specified Amazon QLDB resource.
default CompletableFuture<StreamJournalToKinesisResponse>	streamJournalToKinesis(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.
default CompletableFuture<StreamJournalToKinesisResponse>	streamJournalToKinesis(StreamJournalToKinesisRequest streamJournalToKinesisRequest) Creates a journal stream for a given Amazon QLDB ledger.
default CompletableFuture<TagResourceResponse>	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.
default CompletableFuture<TagResourceResponse>	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to a specified Amazon QLDB resource.
default CompletableFuture<UntagResourceResponse>	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.
default CompletableFuture<UntagResourceResponse>	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a specified Amazon QLDB resource.
default CompletableFuture<UpdateLedgerResponse>	updateLedger(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest) Updates properties on a ledger.
default CompletableFuture<UpdateLedgerResponse>	updateLedger(UpdateLedgerRequest updateLedgerRequest) Updates properties on a ledger.

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static QldbAsyncClient create()

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

builder

static QldbAsyncClientBuilder builder()

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

cancelJournalKinesisStream

default CompletableFuture<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream(CancelJournalKinesisStreamRequest cancelJournalKinesisStreamRequest)

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.

You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

Parameters:

cancelJournalKinesisStreamRequest -

Returns:

A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

cancelJournalKinesisStream

default CompletableFuture<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream(Consumer<CancelJournalKinesisStreamRequest.Builder> cancelJournalKinesisStreamRequest)

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.

You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

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

Parameters:

cancelJournalKinesisStreamRequest - A Consumer that will call methods on CancelJournalKinesisStreamRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createLedger

default CompletableFuture<CreateLedgerResponse> createLedger(CreateLedgerRequest createLedgerRequest)

Creates a new ledger in your AWS account.

Parameters:

createLedgerRequest -

Returns:

A Java Future containing the result of the CreateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException You have reached the limit on the maximum number of resources allowed.
• ResourceInUseException The specified resource can't be modified at this time.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createLedger

default CompletableFuture<CreateLedgerResponse> createLedger(Consumer<CreateLedgerRequest.Builder> createLedgerRequest)

Creates a new ledger in your AWS account.

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

Parameters:

createLedgerRequest - A Consumer that will call methods on CreateLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException You have reached the limit on the maximum number of resources allowed.
• ResourceInUseException The specified resource can't be modified at this time.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteLedger

default CompletableFuture<DeleteLedgerResponse> deleteLedger(DeleteLedgerRequest deleteLedgerRequest)

Deletes a ledger and all of its contents. This action is irreversible.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Parameters:

deleteLedgerRequest -

Returns:

A Java Future containing the result of the DeleteLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourceInUseException The specified resource can't be modified at this time.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteLedger

default CompletableFuture<DeleteLedgerResponse> deleteLedger(Consumer<DeleteLedgerRequest.Builder> deleteLedgerRequest)

Deletes a ledger and all of its contents. This action is irreversible.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

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

Parameters:

deleteLedgerRequest - A Consumer that will call methods on DeleteLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourceInUseException The specified resource can't be modified at this time.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeJournalKinesisStream

default CompletableFuture<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream(DescribeJournalKinesisStreamRequest describeJournalKinesisStreamRequest)

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.

Parameters:

describeJournalKinesisStreamRequest -

Returns:

A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeJournalKinesisStream

default CompletableFuture<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream(Consumer<DescribeJournalKinesisStreamRequest.Builder> describeJournalKinesisStreamRequest)

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.

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

Parameters:

describeJournalKinesisStreamRequest - A Consumer that will call methods on DescribeJournalKinesisStreamRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeJournalS3Export

default CompletableFuture<DescribeJournalS3ExportResponse> describeJournalS3Export(DescribeJournalS3ExportRequest describeJournalS3ExportRequest)

Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

Parameters:

describeJournalS3ExportRequest -

Returns:

A Java Future containing the result of the DescribeJournalS3Export operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeJournalS3Export

default CompletableFuture<DescribeJournalS3ExportResponse> describeJournalS3Export(Consumer<DescribeJournalS3ExportRequest.Builder> describeJournalS3ExportRequest)

Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

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

Parameters:

describeJournalS3ExportRequest - A Consumer that will call methods on DescribeJournalS3ExportRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeJournalS3Export operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeLedger

default CompletableFuture<DescribeLedgerResponse> describeLedger(DescribeLedgerRequest describeLedgerRequest)

Returns information about a ledger, including its state and when it was created.

Parameters:

describeLedgerRequest -

Returns:

A Java Future containing the result of the DescribeLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeLedger

default CompletableFuture<DescribeLedgerResponse> describeLedger(Consumer<DescribeLedgerRequest.Builder> describeLedgerRequest)

Returns information about a ledger, including its state and when it was created.

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

Parameters:

describeLedgerRequest - A Consumer that will call methods on DescribeLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

exportJournalToS3

default CompletableFuture<ExportJournalToS3Response> exportJournalToS3(ExportJournalToS3Request exportJournalToS3Request)

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

Parameters:

exportJournalToS3Request -

Returns:

A Java Future containing the result of the ExportJournalToS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

exportJournalToS3

default CompletableFuture<ExportJournalToS3Response> exportJournalToS3(Consumer<ExportJournalToS3Request.Builder> exportJournalToS3Request)

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

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

Parameters:

exportJournalToS3Request - A Consumer that will call methods on ExportJournalToS3Request.Builder to create a request.

Returns:

A Java Future containing the result of the ExportJournalToS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBlock

default CompletableFuture<GetBlockResponse> getBlock(GetBlockRequest getBlockRequest)

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.

If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

If no block exists with the specified address, then throws InvalidParameterException.

Parameters:

getBlockRequest -

Returns:

A Java Future containing the result of the GetBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBlock

default CompletableFuture<GetBlockResponse> getBlock(Consumer<GetBlockRequest.Builder> getBlockRequest)

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.

If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

If no block exists with the specified address, then throws InvalidParameterException.

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

Parameters:

getBlockRequest - A Consumer that will call methods on GetBlockRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDigest

default CompletableFuture<GetDigestResponse> getDigest(GetDigestRequest getDigestRequest)

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

Parameters:

getDigestRequest -

Returns:

A Java Future containing the result of the GetDigest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDigest

default CompletableFuture<GetDigestResponse> getDigest(Consumer<GetDigestRequest.Builder> getDigestRequest)

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

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

Parameters:

getDigestRequest - A Consumer that will call methods on GetDigestRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetDigest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getRevision

default CompletableFuture<GetRevisionResponse> getRevision(GetRevisionRequest getRevisionRequest)

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

Parameters:

getRevisionRequest -

Returns:

A Java Future containing the result of the GetRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getRevision

default CompletableFuture<GetRevisionResponse> getRevision(Consumer<GetRevisionRequest.Builder> getRevisionRequest)

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

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

Parameters:

getRevisionRequest - A Consumer that will call methods on GetRevisionRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalKinesisStreamsForLedger

default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse> listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest)

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

Parameters:

listJournalKinesisStreamsForLedgerRequest -

Returns:

A Java Future containing the result of the ListJournalKinesisStreamsForLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalKinesisStreamsForLedger

default CompletableFuture<ListJournalKinesisStreamsForLedgerResponse> listJournalKinesisStreamsForLedger(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest)

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

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

Parameters:

listJournalKinesisStreamsForLedgerRequest - A Consumer that will call methods on ListJournalKinesisStreamsForLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListJournalKinesisStreamsForLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalKinesisStreamsForLedgerPaginator

default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(ListJournalKinesisStreamsForLedgerRequest listJournalKinesisStreamsForLedgerRequest)

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

This is a variant of listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest) operation.

Parameters:

listJournalKinesisStreamsForLedgerRequest -

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalKinesisStreamsForLedgerPaginator

default ListJournalKinesisStreamsForLedgerPublisher listJournalKinesisStreamsForLedgerPaginator(Consumer<ListJournalKinesisStreamsForLedgerRequest.Builder> listJournalKinesisStreamsForLedgerRequest)

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

This is a variant of listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalKinesisStreamsForLedgerPublisher publisher = client.listJournalKinesisStreamsForLedgerPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalKinesisStreamsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalKinesisStreamsForLedgerRequest) operation.

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

Parameters:

listJournalKinesisStreamsForLedgerRequest - A Consumer that will call methods on ListJournalKinesisStreamsForLedgerRequest.Builder to create a request.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3Exports

default CompletableFuture<ListJournalS3ExportsResponse> listJournalS3Exports(ListJournalS3ExportsRequest listJournalS3ExportsRequest)

Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

Parameters:

listJournalS3ExportsRequest -

Returns:

A Java Future containing the result of the ListJournalS3Exports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3Exports

default CompletableFuture<ListJournalS3ExportsResponse> listJournalS3Exports(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest)

Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

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

Parameters:

listJournalS3ExportsRequest - A Consumer that will call methods on ListJournalS3ExportsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListJournalS3Exports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsForLedger

default CompletableFuture<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest)

Returns an array of journal export job descriptions for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

Parameters:

listJournalS3ExportsForLedgerRequest -

Returns:

A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsForLedger

default CompletableFuture<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest)

Returns an array of journal export job descriptions for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

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

Parameters:

listJournalS3ExportsForLedgerRequest - A Consumer that will call methods on ListJournalS3ExportsForLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsForLedgerPaginator

default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest)

Returns an array of journal export job descriptions for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

This is a variant of listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest) operation.

Parameters:

listJournalS3ExportsForLedgerRequest -

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsForLedgerPaginator

default ListJournalS3ExportsForLedgerPublisher listJournalS3ExportsForLedgerPaginator(Consumer<ListJournalS3ExportsForLedgerRequest.Builder> listJournalS3ExportsForLedgerRequest)

Returns an array of journal export job descriptions for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

This is a variant of listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsForLedgerPublisher publisher = client.listJournalS3ExportsForLedgerPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalS3ExportsForLedger(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsForLedgerRequest) operation.

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

Parameters:

listJournalS3ExportsForLedgerRequest - A Consumer that will call methods on ListJournalS3ExportsForLedgerRequest.Builder to create a request.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsPaginator

default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(ListJournalS3ExportsRequest listJournalS3ExportsRequest)

Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

This is a variant of listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest) operation.

Parameters:

listJournalS3ExportsRequest -

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listJournalS3ExportsPaginator

default ListJournalS3ExportsPublisher listJournalS3ExportsPaginator(Consumer<ListJournalS3ExportsRequest.Builder> listJournalS3ExportsRequest)

Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

This is a variant of listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListJournalS3ExportsPublisher publisher = client.listJournalS3ExportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listJournalS3Exports(software.amazon.awssdk.services.qldb.model.ListJournalS3ExportsRequest) operation.

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

Parameters:

listJournalS3ExportsRequest - A Consumer that will call methods on ListJournalS3ExportsRequest.Builder to create a request.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLedgers

default CompletableFuture<ListLedgersResponse> listLedgers(ListLedgersRequest listLedgersRequest)

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

Parameters:

listLedgersRequest -

Returns:

A Java Future containing the result of the ListLedgers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLedgers

default CompletableFuture<ListLedgersResponse> listLedgers(Consumer<ListLedgersRequest.Builder> listLedgersRequest)

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

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

Parameters:

listLedgersRequest - A Consumer that will call methods on ListLedgersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListLedgers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLedgersPaginator

default ListLedgersPublisher listLedgersPaginator(ListLedgersRequest listLedgersRequest)

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

This is a variant of listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListLedgersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest) operation.

Parameters:

listLedgersRequest -

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLedgersPaginator

default ListLedgersPublisher listLedgersPaginator(Consumer<ListLedgersRequest.Builder> listLedgersRequest)

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

This is a variant of listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.qldb.paginators.ListLedgersPublisher publisher = client.listLedgersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qldb.model.ListLedgersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qldb.model.ListLedgersResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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 listLedgers(software.amazon.awssdk.services.qldb.model.ListLedgersRequest) operation.

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

Parameters:

listLedgersRequest - A Consumer that will call methods on ListLedgersRequest.Builder to create a request.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns all tags for a specified Amazon QLDB resource.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Returns all tags for a specified Amazon QLDB 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:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

streamJournalToKinesis

default CompletableFuture<StreamJournalToKinesisResponse> streamJournalToKinesis(StreamJournalToKinesisRequest streamJournalToKinesisRequest)

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

Parameters:

streamJournalToKinesisRequest -

Returns:

A Java Future containing the result of the StreamJournalToKinesis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

streamJournalToKinesis

default CompletableFuture<StreamJournalToKinesisResponse> streamJournalToKinesis(Consumer<StreamJournalToKinesisRequest.Builder> streamJournalToKinesisRequest)

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

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

Parameters:

streamJournalToKinesisRequest - A Consumer that will call methods on StreamJournalToKinesisRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StreamJournalToKinesis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• ResourcePreconditionNotMetException The operation failed because a condition wasn't satisfied in advance.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

Adds one or more tags to a specified Amazon QLDB resource.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Adds one or more tags to a specified Amazon QLDB resource.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

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:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

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:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLedger

default CompletableFuture<UpdateLedgerResponse> updateLedger(UpdateLedgerRequest updateLedgerRequest)

Updates properties on a ledger.

Parameters:

updateLedgerRequest -

Returns:

A Java Future containing the result of the UpdateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLedger

default CompletableFuture<UpdateLedgerResponse> updateLedger(Consumer<UpdateLedgerRequest.Builder> updateLedgerRequest)

Updates properties on a ledger.

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

Parameters:

updateLedgerRequest - A Consumer that will call methods on UpdateLedgerRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateLedger operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException One or more parameters in the request aren't valid.
• ResourceNotFoundException The specified resource doesn't exist.
• 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.
• QldbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation