/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.qldb; import javax.annotation.Generated; import com.amazonaws.services.qldb.model.*; /** * Interface for accessing QLDB asynchronously. Each asynchronous method will return a Java Future object representing * the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.qldb.AbstractAmazonQLDBAsync} instead. *
**
* The resource management API for Amazon QLDB *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQLDBAsync extends AmazonQLDB { /** *
* 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. *
* * @param cancelJournalKinesisStreamRequest * @return A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service. * @sample AmazonQLDBAsync.CancelJournalKinesisStream * @see AWS API Documentation */ java.util.concurrent.Future
* 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. *
* * @param cancelJournalKinesisStreamRequest * @param 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. * @return A Java Future containing the result of the CancelJournalKinesisStream operation returned by the service. * @sample AmazonQLDBAsyncHandler.CancelJournalKinesisStream * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new ledger in your Amazon Web Services account in the current Region. *
* * @param createLedgerRequest * @return A Java Future containing the result of the CreateLedger operation returned by the service. * @sample AmazonQLDBAsync.CreateLedger * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new ledger in your Amazon Web Services account in the current Region. *
* * @param createLedgerRequest * @param 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. * @return A Java Future containing the result of the CreateLedger operation returned by the service. * @sample AmazonQLDBAsyncHandler.CreateLedger * @see AWS API * Documentation */ java.util.concurrent.Future* 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. You can disable it
* by calling the UpdateLedger
operation to set this parameter to false
.
*
* 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. You can disable it
* by calling the UpdateLedger
operation to set this parameter to false
.
*
* 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 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. *
* * @param describeJournalKinesisStreamRequest * @return A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the * service. * @sample AmazonQLDBAsync.DescribeJournalKinesisStream * @see AWS API Documentation */ java.util.concurrent.Future* 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 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. *
* * @param describeJournalKinesisStreamRequest * @param 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. * @return A Java Future containing the result of the DescribeJournalKinesisStream operation returned by the * service. * @sample AmazonQLDBAsyncHandler.DescribeJournalKinesisStream * @see AWS API Documentation */ java.util.concurrent.Future* Returns 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
.
*
* Returns 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
.
*
* Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when * it was created. *
* * @param describeLedgerRequest * @return A Java Future containing the result of the DescribeLedger operation returned by the service. * @sample AmazonQLDBAsync.DescribeLedger * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when * it was created. *
* * @param describeLedgerRequest * @param 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. * @return A Java Future containing the result of the DescribeLedger operation returned by the service. * @sample AmazonQLDBAsyncHandler.DescribeLedger * @see AWS API * Documentation */ java.util.concurrent.Future* Exports 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
.
*
* Exports 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
.
*
* 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
.
*
* 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
.
*
* 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. *
* * @param getDigestRequest * @return A Java Future containing the result of the GetDigest operation returned by the service. * @sample AmazonQLDBAsync.GetDigest * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param getDigestRequest * @param 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. * @return A Java Future containing the result of the GetDigest operation returned by the service. * @sample AmazonQLDBAsyncHandler.GetDigest * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Returns 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.
*
* Returns 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.
*
* Returns 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. *
* * @param listJournalS3ExportsRequest * @return A Java Future containing the result of the ListJournalS3Exports operation returned by the service. * @sample AmazonQLDBAsync.ListJournalS3Exports * @see AWS API * Documentation */ java.util.concurrent.Future* Returns 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. *
* * @param listJournalS3ExportsRequest * @param 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. * @return A Java Future containing the result of the ListJournalS3Exports operation returned by the service. * @sample AmazonQLDBAsyncHandler.ListJournalS3Exports * @see AWS API * Documentation */ java.util.concurrent.Future* Returns 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. *
* * @param listJournalS3ExportsForLedgerRequest * @return A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the * service. * @sample AmazonQLDBAsync.ListJournalS3ExportsForLedger * @see AWS API Documentation */ java.util.concurrent.Future* Returns 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. *
* * @param listJournalS3ExportsForLedgerRequest * @param 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. * @return A Java Future containing the result of the ListJournalS3ExportsForLedger operation returned by the * service. * @sample AmazonQLDBAsyncHandler.ListJournalS3ExportsForLedger * @see AWS API Documentation */ java.util.concurrent.Future* Returns 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.
*
* Returns 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.
*
* Returns all tags for a specified Amazon QLDB resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonQLDBAsync.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future* Returns all tags for a specified Amazon QLDB resource. *
* * @param listTagsForResourceRequest * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonQLDBAsyncHandler.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param streamJournalToKinesisRequest * @return A Java Future containing the result of the StreamJournalToKinesis operation returned by the service. * @sample AmazonQLDBAsync.StreamJournalToKinesis * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param streamJournalToKinesisRequest * @param 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. * @return A Java Future containing the result of the StreamJournalToKinesis operation returned by the service. * @sample AmazonQLDBAsyncHandler.StreamJournalToKinesis * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonQLDBAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param tagResourceRequest * @param 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. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonQLDBAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonQLDBAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. *
* * @param untagResourceRequest * @param 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. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonQLDBAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Updates properties on a ledger. *
* * @param updateLedgerRequest * @return A Java Future containing the result of the UpdateLedger operation returned by the service. * @sample AmazonQLDBAsync.UpdateLedger * @see AWS API * Documentation */ java.util.concurrent.Future* Updates properties on a ledger. *
* * @param updateLedgerRequest * @param 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. * @return A Java Future containing the result of the UpdateLedger operation returned by the service. * @sample AmazonQLDBAsyncHandler.UpdateLedger * @see AWS API * Documentation */ java.util.concurrent.Future* Updates 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.
*
* Updates 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.
*