AmazonQLDB (AWS SDK for Java

All Known Subinterfaces:

AmazonQLDBAsync

All Known Implementing Classes:

AbstractAmazonQLDB, AbstractAmazonQLDBAsync, AmazonQLDBAsyncClient, AmazonQLDBClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQLDB
```
Interface for accessing QLDB.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonQLDB instead.

The control plane for Amazon QLDB

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateLedgerResult`	`createLedger(CreateLedgerRequest createLedgerRequest)` Creates a new ledger in your AWS account.
`DeleteLedgerResult`	`deleteLedger(DeleteLedgerRequest deleteLedgerRequest)` Deletes a ledger and all of its contents.
`DescribeJournalS3ExportResult`	`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.
`DescribeLedgerResult`	`describeLedger(DescribeLedgerRequest describeLedgerRequest)` Returns information about a ledger, including its state and when it was created.
`ExportJournalToS3Result`	`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.
`GetBlockResult`	`getBlock(GetBlockRequest getBlockRequest)` Returns a journal block object at a specified address in a ledger.
`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 getDigestRequest)` Returns the digest of a ledger at the latest committed block in the journal.
`GetRevisionResult`	`getRevision(GetRevisionRequest getRevisionRequest)` Returns a revision data object for a specified document ID and block address.
`ListJournalS3ExportsResult`	`listJournalS3Exports(ListJournalS3ExportsRequest listJournalS3ExportsRequest)` Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
`ListJournalS3ExportsForLedgerResult`	`listJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest listJournalS3ExportsForLedgerRequest)` Returns an array of journal export job descriptions for a specified ledger.
`ListLedgersResult`	`listLedgers(ListLedgersRequest listLedgersRequest)` Returns an array of ledger summaries that are associated with the current AWS account and Region.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all tags for a specified Amazon QLDB resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to a specified Amazon QLDB resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from a specified Amazon QLDB resource.
`UpdateLedgerResult`	`updateLedger(UpdateLedgerRequest updateLedgerRequest)` Updates properties on a ledger.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createLedger
```
CreateLedgerResult createLedger(CreateLedgerRequest createLedgerRequest)
```
    Creates a new ledger in your AWS account.
    
    Parameters:
    
    createLedgerRequest -
    
    Returns:
    
    Result of the CreateLedger operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteLedger
```
DeleteLedgerResult 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:
    
    Result of the DeleteLedger operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeJournalS3Export
```
DescribeJournalS3ExportResult 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.
    
    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:
    
    Result of the DescribeJournalS3Export operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeLedger
```
DescribeLedgerResult describeLedger(DescribeLedgerRequest describeLedgerRequest)
```
    Returns information about a ledger, including its state and when it was created.
    
    Parameters:
    
    describeLedgerRequest -
    
    Returns:
    
    Result of the DescribeLedger operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters in the request aren't valid.
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - exportJournalToS3
```
ExportJournalToS3Result 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:
    
    Result of the ExportJournalToS3 operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    ResourcePreconditionNotMetException - The operation failed because a condition wasn't satisfied in advance.
    
    See Also:
    
    AWS API Documentation
  - getBlock
```
GetBlockResult getBlock(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.
    
    Parameters:
    
    getBlockRequest -
    
    Returns:
    
    Result of the GetBlock operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDigest
```
GetDigestResult 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:
    
    Result of the GetDigest operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getRevision
```
GetRevisionResult 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:
    
    Result of the GetRevision operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listJournalS3Exports
```
ListJournalS3ExportsResult 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.
    
    Parameters:
    
    listJournalS3ExportsRequest -
    
    Returns:
    
    Result of the ListJournalS3Exports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listJournalS3ExportsForLedger
```
ListJournalS3ExportsForLedgerResult 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.
    
    Parameters:
    
    listJournalS3ExportsForLedgerRequest -
    
    Returns:
    
    Result of the ListJournalS3ExportsForLedger operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLedgers
```
ListLedgersResult 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:
    
    Result of the ListLedgers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns all tags for a specified Amazon QLDB resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters in the request aren't valid.
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult 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:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters in the request aren't valid.
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult 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:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters in the request aren't valid.
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - updateLedger
```
UpdateLedgerResult updateLedger(UpdateLedgerRequest updateLedgerRequest)
```
    Updates properties on a ledger.
    
    Parameters:
    
    updateLedgerRequest -
    
    Returns:
    
    Result of the UpdateLedger operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters in the request aren't valid.
    
    ResourceNotFoundException - The specified resource doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonQLDB

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createLedger

deleteLedger

describeJournalS3Export

describeLedger

exportJournalToS3

getBlock

getDigest

getRevision

listJournalS3Exports

listJournalS3ExportsForLedger

listLedgers

listTagsForResource

tagResource

untagResource

updateLedger

shutdown

getCachedResponseMetadata