@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQLDBAsync extends AmazonQLDB
AsyncHandler
can be used to receive notification when
an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonQLDBAsync
instead.
The control plane for Amazon QLDB
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CreateLedgerResult> |
createLedgerAsync(CreateLedgerRequest createLedgerRequest)
Creates a new ledger in your AWS account.
|
Future<CreateLedgerResult> |
createLedgerAsync(CreateLedgerRequest createLedgerRequest,
AsyncHandler<CreateLedgerRequest,CreateLedgerResult> asyncHandler)
Creates a new ledger in your AWS account.
|
Future<DeleteLedgerResult> |
deleteLedgerAsync(DeleteLedgerRequest deleteLedgerRequest)
Deletes a ledger and all of its contents.
|
Future<DeleteLedgerResult> |
deleteLedgerAsync(DeleteLedgerRequest deleteLedgerRequest,
AsyncHandler<DeleteLedgerRequest,DeleteLedgerResult> asyncHandler)
Deletes a ledger and all of its contents.
|
Future<DescribeJournalS3ExportResult> |
describeJournalS3ExportAsync(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.
|
Future<DescribeJournalS3ExportResult> |
describeJournalS3ExportAsync(DescribeJournalS3ExportRequest describeJournalS3ExportRequest,
AsyncHandler<DescribeJournalS3ExportRequest,DescribeJournalS3ExportResult> asyncHandler)
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.
|
Future<DescribeLedgerResult> |
describeLedgerAsync(DescribeLedgerRequest describeLedgerRequest)
Returns information about a ledger, including its state and when it was created.
|
Future<DescribeLedgerResult> |
describeLedgerAsync(DescribeLedgerRequest describeLedgerRequest,
AsyncHandler<DescribeLedgerRequest,DescribeLedgerResult> asyncHandler)
Returns information about a ledger, including its state and when it was created.
|
Future<ExportJournalToS3Result> |
exportJournalToS3Async(ExportJournalToS3Request exportJournalToS3Request)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage
Service (Amazon S3) bucket.
|
Future<ExportJournalToS3Result> |
exportJournalToS3Async(ExportJournalToS3Request exportJournalToS3Request,
AsyncHandler<ExportJournalToS3Request,ExportJournalToS3Result> asyncHandler)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage
Service (Amazon S3) bucket.
|
Future<GetBlockResult> |
getBlockAsync(GetBlockRequest getBlockRequest)
Returns a journal block object at a specified address in a ledger.
|
Future<GetBlockResult> |
getBlockAsync(GetBlockRequest getBlockRequest,
AsyncHandler<GetBlockRequest,GetBlockResult> asyncHandler)
Returns a journal block object at a specified address in a ledger.
|
Future<GetDigestResult> |
getDigestAsync(GetDigestRequest getDigestRequest)
Returns the digest of a ledger at the latest committed block in the journal.
|
Future<GetDigestResult> |
getDigestAsync(GetDigestRequest getDigestRequest,
AsyncHandler<GetDigestRequest,GetDigestResult> asyncHandler)
Returns the digest of a ledger at the latest committed block in the journal.
|
Future<GetRevisionResult> |
getRevisionAsync(GetRevisionRequest getRevisionRequest)
Returns a revision data object for a specified document ID and block address.
|
Future<GetRevisionResult> |
getRevisionAsync(GetRevisionRequest getRevisionRequest,
AsyncHandler<GetRevisionRequest,GetRevisionResult> asyncHandler)
Returns a revision data object for a specified document ID and block address.
|
Future<ListJournalS3ExportsResult> |
listJournalS3ExportsAsync(ListJournalS3ExportsRequest listJournalS3ExportsRequest)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS
account and Region.
|
Future<ListJournalS3ExportsResult> |
listJournalS3ExportsAsync(ListJournalS3ExportsRequest listJournalS3ExportsRequest,
AsyncHandler<ListJournalS3ExportsRequest,ListJournalS3ExportsResult> asyncHandler)
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS
account and Region.
|
Future<ListJournalS3ExportsForLedgerResult> |
listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest)
Returns an array of journal export job descriptions for a specified ledger.
|
Future<ListJournalS3ExportsForLedgerResult> |
listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest,
AsyncHandler<ListJournalS3ExportsForLedgerRequest,ListJournalS3ExportsForLedgerResult> asyncHandler)
Returns an array of journal export job descriptions for a specified ledger.
|
Future<ListLedgersResult> |
listLedgersAsync(ListLedgersRequest listLedgersRequest)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
|
Future<ListLedgersResult> |
listLedgersAsync(ListLedgersRequest listLedgersRequest,
AsyncHandler<ListLedgersRequest,ListLedgersResult> asyncHandler)
Returns an array of ledger summaries that are associated with the current AWS account and Region.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all tags for a specified Amazon QLDB resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns all tags for a specified Amazon QLDB resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds one or more tags to a specified Amazon QLDB resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds one or more tags to a specified Amazon QLDB resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a specified Amazon QLDB resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from a specified Amazon QLDB resource.
|
Future<UpdateLedgerResult> |
updateLedgerAsync(UpdateLedgerRequest updateLedgerRequest)
Updates properties on a ledger.
|
Future<UpdateLedgerResult> |
updateLedgerAsync(UpdateLedgerRequest updateLedgerRequest,
AsyncHandler<UpdateLedgerRequest,UpdateLedgerResult> asyncHandler)
Updates properties on a ledger.
|
createLedger, deleteLedger, describeJournalS3Export, describeLedger, exportJournalToS3, getBlock, getCachedResponseMetadata, getDigest, getRevision, listJournalS3Exports, listJournalS3ExportsForLedger, listLedgers, listTagsForResource, shutdown, tagResource, untagResource, updateLedger
Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest createLedgerRequest)
Creates a new ledger in your AWS account.
createLedgerRequest
- Future<CreateLedgerResult> createLedgerAsync(CreateLedgerRequest createLedgerRequest, AsyncHandler<CreateLedgerRequest,CreateLedgerResult> asyncHandler)
Creates a new ledger in your AWS account.
createLedgerRequest
- asyncHandler
- 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.Future<DeleteLedgerResult> deleteLedgerAsync(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.
deleteLedgerRequest
- Future<DeleteLedgerResult> deleteLedgerAsync(DeleteLedgerRequest deleteLedgerRequest, AsyncHandler<DeleteLedgerRequest,DeleteLedgerResult> asyncHandler)
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.
deleteLedgerRequest
- asyncHandler
- 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.Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(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.
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
.
describeJournalS3ExportRequest
- Future<DescribeJournalS3ExportResult> describeJournalS3ExportAsync(DescribeJournalS3ExportRequest describeJournalS3ExportRequest, AsyncHandler<DescribeJournalS3ExportRequest,DescribeJournalS3ExportResult> asyncHandler)
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.
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
.
describeJournalS3ExportRequest
- asyncHandler
- 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.Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest describeLedgerRequest)
Returns information about a ledger, including its state and when it was created.
describeLedgerRequest
- Future<DescribeLedgerResult> describeLedgerAsync(DescribeLedgerRequest describeLedgerRequest, AsyncHandler<DescribeLedgerRequest,DescribeLedgerResult> asyncHandler)
Returns information about a ledger, including its state and when it was created.
describeLedgerRequest
- asyncHandler
- 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.Future<ExportJournalToS3Result> exportJournalToS3Async(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
.
exportJournalToS3Request
- Future<ExportJournalToS3Result> exportJournalToS3Async(ExportJournalToS3Request exportJournalToS3Request, AsyncHandler<ExportJournalToS3Request,ExportJournalToS3Result> asyncHandler)
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
.
exportJournalToS3Request
- asyncHandler
- 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.Future<GetBlockResult> getBlockAsync(GetBlockRequest getBlockRequest)
Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block
for verification if DigestTipAddress
is provided.
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
.
getBlockRequest
- Future<GetBlockResult> getBlockAsync(GetBlockRequest getBlockRequest, AsyncHandler<GetBlockRequest,GetBlockResult> asyncHandler)
Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block
for verification if DigestTipAddress
is provided.
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
.
getBlockRequest
- asyncHandler
- 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.Future<GetDigestResult> getDigestAsync(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.
getDigestRequest
- Future<GetDigestResult> getDigestAsync(GetDigestRequest getDigestRequest, AsyncHandler<GetDigestRequest,GetDigestResult> asyncHandler)
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.
getDigestRequest
- asyncHandler
- 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.Future<GetRevisionResult> getRevisionAsync(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.
getRevisionRequest
- Future<GetRevisionResult> getRevisionAsync(GetRevisionRequest getRevisionRequest, AsyncHandler<GetRevisionRequest,GetRevisionResult> asyncHandler)
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.
getRevisionRequest
- asyncHandler
- 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.Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(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.
listJournalS3ExportsRequest
- Future<ListJournalS3ExportsResult> listJournalS3ExportsAsync(ListJournalS3ExportsRequest listJournalS3ExportsRequest, AsyncHandler<ListJournalS3ExportsRequest,ListJournalS3ExportsResult> asyncHandler)
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.
listJournalS3ExportsRequest
- asyncHandler
- 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.Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(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.
listJournalS3ExportsForLedgerRequest
- Future<ListJournalS3ExportsForLedgerResult> listJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest, AsyncHandler<ListJournalS3ExportsForLedgerRequest,ListJournalS3ExportsForLedgerResult> asyncHandler)
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.
listJournalS3ExportsForLedgerRequest
- asyncHandler
- 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.Future<ListLedgersResult> listLedgersAsync(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.
listLedgersRequest
- Future<ListLedgersResult> listLedgersAsync(ListLedgersRequest listLedgersRequest, AsyncHandler<ListLedgersRequest,ListLedgersResult> asyncHandler)
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.
listLedgersRequest
- asyncHandler
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all tags for a specified Amazon QLDB resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns all tags for a specified Amazon QLDB resource.
listTagsForResourceRequest
- asyncHandler
- 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.Future<TagResourceResult> tagResourceAsync(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.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest
- asyncHandler
- 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResourceRequest
- asyncHandler
- 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.Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest updateLedgerRequest)
Updates properties on a ledger.
updateLedgerRequest
- Future<UpdateLedgerResult> updateLedgerAsync(UpdateLedgerRequest updateLedgerRequest, AsyncHandler<UpdateLedgerRequest,UpdateLedgerResult> asyncHandler)
Updates properties on a ledger.
updateLedgerRequest
- asyncHandler
- 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.