@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonQLDB extends Object implements AmazonQLDB
AmazonQLDB. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CancelJournalKinesisStreamResult |
cancelJournalKinesisStream(CancelJournalKinesisStreamRequest request)
Ends a given Amazon QLDB journal stream.
|
CreateLedgerResult |
createLedger(CreateLedgerRequest request)
Creates a new ledger in your Amazon Web Services account in the current Region.
|
DeleteLedgerResult |
deleteLedger(DeleteLedgerRequest request)
Deletes a ledger and all of its contents.
|
DescribeJournalKinesisStreamResult |
describeJournalKinesisStream(DescribeJournalKinesisStreamRequest request)
Returns detailed information about a given Amazon QLDB journal stream.
|
DescribeJournalS3ExportResult |
describeJournalS3Export(DescribeJournalS3ExportRequest request)
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.
|
DescribeLedgerResult |
describeLedger(DescribeLedgerRequest request)
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when
it was created.
|
ExportJournalToS3Result |
exportJournalToS3(ExportJournalToS3Request request)
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage
Service (Amazon S3) bucket.
|
GetBlockResult |
getBlock(GetBlockRequest request)
Returns a block object at a specified address in a journal.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDigestResult |
getDigest(GetDigestRequest request)
Returns the digest of a ledger at the latest committed block in the journal.
|
GetRevisionResult |
getRevision(GetRevisionRequest request)
Returns a revision data object for a specified document ID and block address.
|
ListJournalKinesisStreamsForLedgerResult |
listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest request)
Returns all Amazon QLDB journal streams for a given ledger.
|
ListJournalS3ExportsResult |
listJournalS3Exports(ListJournalS3ExportsRequest request)
Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account
and Region.
|
ListJournalS3ExportsForLedgerResult |
listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest request)
Returns all journal export jobs for a specified ledger.
|
ListLedgersResult |
listLedgers(ListLedgersRequest request)
Returns all ledgers that are associated with the current Amazon Web Services account and Region.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all tags for a specified Amazon QLDB resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StreamJournalToKinesisResult |
streamJournalToKinesis(StreamJournalToKinesisRequest request)
Creates a journal stream for a given Amazon QLDB ledger.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a specified Amazon QLDB resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a specified Amazon QLDB resource.
|
UpdateLedgerResult |
updateLedger(UpdateLedgerRequest request)
Updates properties on a ledger.
|
UpdateLedgerPermissionsModeResult |
updateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest request)
Updates the permissions mode of a ledger.
|
public CancelJournalKinesisStreamResult cancelJournalKinesisStream(CancelJournalKinesisStreamRequest request)
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.
cancelJournalKinesisStream in interface AmazonQLDBpublic CreateLedgerResult createLedger(CreateLedgerRequest request)
AmazonQLDBCreates a new ledger in your Amazon Web Services account in the current Region.
createLedger in interface AmazonQLDBpublic DeleteLedgerResult deleteLedger(DeleteLedgerRequest request)
AmazonQLDBDeletes 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.
deleteLedger in interface AmazonQLDBpublic DescribeJournalKinesisStreamResult describeJournalKinesisStream(DescribeJournalKinesisStreamRequest request)
AmazonQLDBReturns 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.
describeJournalKinesisStream in interface AmazonQLDBpublic DescribeJournalS3ExportResult describeJournalS3Export(DescribeJournalS3ExportRequest request)
AmazonQLDBReturns 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.
describeJournalS3Export in interface AmazonQLDBpublic DescribeLedgerResult describeLedger(DescribeLedgerRequest request)
AmazonQLDBReturns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
describeLedger in interface AmazonQLDBpublic ExportJournalToS3Result exportJournalToS3(ExportJournalToS3Request request)
AmazonQLDBExports 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.
exportJournalToS3 in interface AmazonQLDBpublic GetBlockResult getBlock(GetBlockRequest request)
AmazonQLDB
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.
getBlock in interface AmazonQLDBpublic GetDigestResult getDigest(GetDigestRequest request)
AmazonQLDBReturns 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.
getDigest in interface AmazonQLDBpublic GetRevisionResult getRevision(GetRevisionRequest request)
AmazonQLDB
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.
getRevision in interface AmazonQLDBpublic ListJournalKinesisStreamsForLedgerResult listJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest request)
AmazonQLDBReturns 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.
listJournalKinesisStreamsForLedger in interface AmazonQLDBpublic ListJournalS3ExportsResult listJournalS3Exports(ListJournalS3ExportsRequest request)
AmazonQLDBReturns 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.
listJournalS3Exports in interface AmazonQLDBpublic ListJournalS3ExportsForLedgerResult listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest request)
AmazonQLDBReturns 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.
listJournalS3ExportsForLedger in interface AmazonQLDBpublic ListLedgersResult listLedgers(ListLedgersRequest request)
AmazonQLDBReturns 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.
listLedgers in interface AmazonQLDBpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonQLDBReturns all tags for a specified Amazon QLDB resource.
listTagsForResource in interface AmazonQLDBpublic StreamJournalToKinesisResult streamJournalToKinesis(StreamJournalToKinesisRequest request)
AmazonQLDBCreates 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.
streamJournalToKinesis in interface AmazonQLDBpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonQLDBAdds 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.
tagResource in interface AmazonQLDBpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonQLDBRemoves one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
untagResource in interface AmazonQLDBpublic UpdateLedgerResult updateLedger(UpdateLedgerRequest request)
AmazonQLDBUpdates properties on a ledger.
updateLedger in interface AmazonQLDBpublic UpdateLedgerPermissionsModeResult updateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest request)
AmazonQLDBUpdates 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.
updateLedgerPermissionsMode in interface AmazonQLDBpublic void shutdown()
AmazonQLDBshutdown in interface AmazonQLDBpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonQLDBResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonQLDBrequest - The originally executed request.