@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQLDBAsyncClient extends AmazonQLDBClient implements AmazonQLDBAsync
AsyncHandler can be used to receive notification when an
asynchronous operation completes.
The resource management API for Amazon QLDB
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, cancelJournalKinesisStream, createLedger, deleteLedger, describeJournalKinesisStream, describeJournalS3Export, describeLedger, exportJournalToS3, getBlock, getCachedResponseMetadata, getDigest, getRevision, listJournalKinesisStreamsForLedger, listJournalS3Exports, listJournalS3ExportsForLedger, listLedgers, listTagsForResource, streamJournalToKinesis, tagResource, untagResource, updateLedger, updateLedgerPermissionsModeaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelJournalKinesisStream, createLedger, deleteLedger, describeJournalKinesisStream, describeJournalS3Export, describeLedger, exportJournalToS3, getBlock, getCachedResponseMetadata, getDigest, getRevision, listJournalKinesisStreamsForLedger, listJournalS3Exports, listJournalS3ExportsForLedger, listLedgers, listTagsForResource, streamJournalToKinesis, tagResource, untagResource, updateLedger, updateLedgerPermissionsModepublic static AmazonQLDBAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelJournalKinesisStreamResult> cancelJournalKinesisStreamAsync(CancelJournalKinesisStreamRequest request)
AmazonQLDBAsync
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.
cancelJournalKinesisStreamAsync in interface AmazonQLDBAsyncpublic Future<CancelJournalKinesisStreamResult> cancelJournalKinesisStreamAsync(CancelJournalKinesisStreamRequest request, AsyncHandler<CancelJournalKinesisStreamRequest,CancelJournalKinesisStreamResult> asyncHandler)
AmazonQLDBAsync
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.
cancelJournalKinesisStreamAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest request)
AmazonQLDBAsyncCreates a new ledger in your Amazon Web Services account in the current Region.
createLedgerAsync in interface AmazonQLDBAsyncpublic Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest request, AsyncHandler<CreateLedgerRequest,CreateLedgerResult> asyncHandler)
AmazonQLDBAsyncCreates a new ledger in your Amazon Web Services account in the current Region.
createLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLedgerResult> deleteLedgerAsync(DeleteLedgerRequest request)
AmazonQLDBAsyncDeletes 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. You can disable it
by calling the UpdateLedger operation to set this parameter to false.
deleteLedgerAsync in interface AmazonQLDBAsyncpublic Future<DeleteLedgerResult> deleteLedgerAsync(DeleteLedgerRequest request, AsyncHandler<DeleteLedgerRequest,DeleteLedgerResult> asyncHandler)
AmazonQLDBAsyncDeletes 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. You can disable it
by calling the UpdateLedger operation to set this parameter to false.
deleteLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeJournalKinesisStreamResult> describeJournalKinesisStreamAsync(DescribeJournalKinesisStreamRequest request)
AmazonQLDBAsyncReturns 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 the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
describeJournalKinesisStreamAsync in interface AmazonQLDBAsyncpublic Future<DescribeJournalKinesisStreamResult> describeJournalKinesisStreamAsync(DescribeJournalKinesisStreamRequest request, AsyncHandler<DescribeJournalKinesisStreamRequest,DescribeJournalKinesisStreamResult> asyncHandler)
AmazonQLDBAsyncReturns 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 the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
describeJournalKinesisStreamAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request)
AmazonQLDBAsyncReturns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
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.
describeJournalS3ExportAsync in interface AmazonQLDBAsyncpublic Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(DescribeJournalS3ExportRequest request, AsyncHandler<DescribeJournalS3ExportRequest,DescribeJournalS3ExportResult> asyncHandler)
AmazonQLDBAsyncReturns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
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.
describeJournalS3ExportAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest request)
AmazonQLDBAsyncReturns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
describeLedgerAsync in interface AmazonQLDBAsyncpublic Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest request, AsyncHandler<DescribeLedgerRequest,DescribeLedgerResult> asyncHandler)
AmazonQLDBAsyncReturns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
describeLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ExportJournalToS3Result> exportJournalToS3Async(ExportJournalToS3Request request)
AmazonQLDBAsyncExports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text 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.
exportJournalToS3Async in interface AmazonQLDBAsyncpublic Future<ExportJournalToS3Result> exportJournalToS3Async(ExportJournalToS3Request request, AsyncHandler<ExportJournalToS3Request,ExportJournalToS3Result> asyncHandler)
AmazonQLDBAsyncExports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text 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.
exportJournalToS3Async in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetBlockResult> getBlockAsync(GetBlockRequest request)
AmazonQLDBAsync
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.
getBlockAsync in interface AmazonQLDBAsyncpublic Future<GetBlockResult> getBlockAsync(GetBlockRequest request, AsyncHandler<GetBlockRequest,GetBlockResult> asyncHandler)
AmazonQLDBAsync
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.
getBlockAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDigestResult> getDigestAsync(GetDigestRequest request)
AmazonQLDBAsyncReturns 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.
getDigestAsync in interface AmazonQLDBAsyncpublic Future<GetDigestResult> getDigestAsync(GetDigestRequest request, AsyncHandler<GetDigestRequest,GetDigestResult> asyncHandler)
AmazonQLDBAsyncReturns 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.
getDigestAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetRevisionResult> getRevisionAsync(GetRevisionRequest request)
AmazonQLDBAsync
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.
getRevisionAsync in interface AmazonQLDBAsyncpublic Future<GetRevisionResult> getRevisionAsync(GetRevisionRequest request, AsyncHandler<GetRevisionRequest,GetRevisionResult> asyncHandler)
AmazonQLDBAsync
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.
getRevisionAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListJournalKinesisStreamsForLedgerResult> listJournalKinesisStreamsForLedgerAsync(ListJournalKinesisStreamsForLedgerRequest request)
AmazonQLDBAsyncReturns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the
items by calling ListJournalKinesisStreamsForLedger multiple times.
listJournalKinesisStreamsForLedgerAsync in interface AmazonQLDBAsyncpublic Future<ListJournalKinesisStreamsForLedgerResult> listJournalKinesisStreamsForLedgerAsync(ListJournalKinesisStreamsForLedgerRequest request, AsyncHandler<ListJournalKinesisStreamsForLedgerRequest,ListJournalKinesisStreamsForLedgerResult> asyncHandler)
AmazonQLDBAsyncReturns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the
items by calling ListJournalKinesisStreamsForLedger multiple times.
listJournalKinesisStreamsForLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(ListJournalS3ExportsRequest request)
AmazonQLDBAsyncReturns all journal export jobs for all ledgers that are associated with the current Amazon Web Services 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.
listJournalS3ExportsAsync in interface AmazonQLDBAsyncpublic Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(ListJournalS3ExportsRequest request, AsyncHandler<ListJournalS3ExportsRequest,ListJournalS3ExportsResult> asyncHandler)
AmazonQLDBAsyncReturns all journal export jobs for all ledgers that are associated with the current Amazon Web Services 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.
listJournalS3ExportsAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request)
AmazonQLDBAsyncReturns all journal export jobs 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.
listJournalS3ExportsForLedgerAsync in interface AmazonQLDBAsyncpublic Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request, AsyncHandler<ListJournalS3ExportsForLedgerRequest,ListJournalS3ExportsForLedgerResult> asyncHandler)
AmazonQLDBAsyncReturns all journal export jobs 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.
listJournalS3ExportsForLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLedgersResult> listLedgersAsync(ListLedgersRequest request)
AmazonQLDBAsyncReturns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults items and is paginated so that you can retrieve all the
items by calling ListLedgers multiple times.
listLedgersAsync in interface AmazonQLDBAsyncpublic Future<ListLedgersResult> listLedgersAsync(ListLedgersRequest request, AsyncHandler<ListLedgersRequest,ListLedgersResult> asyncHandler)
AmazonQLDBAsyncReturns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults items and is paginated so that you can retrieve all the
items by calling ListLedgers multiple times.
listLedgersAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonQLDBAsyncReturns all tags for a specified Amazon QLDB resource.
listTagsForResourceAsync in interface AmazonQLDBAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonQLDBAsyncReturns all tags for a specified Amazon QLDB resource.
listTagsForResourceAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StreamJournalToKinesisResult> streamJournalToKinesisAsync(StreamJournalToKinesisRequest request)
AmazonQLDBAsyncCreates 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.
streamJournalToKinesisAsync in interface AmazonQLDBAsyncpublic Future<StreamJournalToKinesisResult> streamJournalToKinesisAsync(StreamJournalToKinesisRequest request, AsyncHandler<StreamJournalToKinesisRequest,StreamJournalToKinesisResult> asyncHandler)
AmazonQLDBAsyncCreates 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.
streamJournalToKinesisAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonQLDBAsyncAdds 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.
tagResourceAsync in interface AmazonQLDBAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonQLDBAsyncAdds 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.
tagResourceAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonQLDBAsyncRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceAsync in interface AmazonQLDBAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonQLDBAsyncRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest request)
AmazonQLDBAsyncUpdates properties on a ledger.
updateLedgerAsync in interface AmazonQLDBAsyncpublic Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest request, AsyncHandler<UpdateLedgerRequest,UpdateLedgerResult> asyncHandler)
AmazonQLDBAsyncUpdates properties on a ledger.
updateLedgerAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLedgerPermissionsModeResult> updateLedgerPermissionsModeAsync(UpdateLedgerPermissionsModeRequest request)
AmazonQLDBAsyncUpdates the permissions mode of a ledger.
Before you switch to the STANDARD permissions mode, you must first create all required IAM policies
and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.
updateLedgerPermissionsModeAsync in interface AmazonQLDBAsyncpublic Future<UpdateLedgerPermissionsModeResult> updateLedgerPermissionsModeAsync(UpdateLedgerPermissionsModeRequest request, AsyncHandler<UpdateLedgerPermissionsModeRequest,UpdateLedgerPermissionsModeResult> asyncHandler)
AmazonQLDBAsyncUpdates the permissions mode of a ledger.
Before you switch to the STANDARD permissions mode, you must first create all required IAM policies
and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.
updateLedgerPermissionsModeAsync in interface AmazonQLDBAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonQLDBshutdown in class AmazonQLDBClient