Qldb

Trait Qldb 

Source
pub trait Qldb {
Show 19 methods // Required methods fn cancel_journal_kinesis_stream<'life0, 'async_trait>( &'life0 self, input: CancelJournalKinesisStreamRequest, ) -> Pin<Box<dyn Future<Output = Result<CancelJournalKinesisStreamResponse, RusotoError<CancelJournalKinesisStreamError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn create_ledger<'life0, 'async_trait>( &'life0 self, input: CreateLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLedgerResponse, RusotoError<CreateLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn delete_ledger<'life0, 'async_trait>( &'life0 self, input: DeleteLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn describe_journal_kinesis_stream<'life0, 'async_trait>( &'life0 self, input: DescribeJournalKinesisStreamRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeJournalKinesisStreamResponse, RusotoError<DescribeJournalKinesisStreamError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn describe_journal_s3_export<'life0, 'async_trait>( &'life0 self, input: DescribeJournalS3ExportRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeJournalS3ExportResponse, RusotoError<DescribeJournalS3ExportError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn describe_ledger<'life0, 'async_trait>( &'life0 self, input: DescribeLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLedgerResponse, RusotoError<DescribeLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn export_journal_to_s3<'life0, 'async_trait>( &'life0 self, input: ExportJournalToS3Request, ) -> Pin<Box<dyn Future<Output = Result<ExportJournalToS3Response, RusotoError<ExportJournalToS3Error>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn get_block<'life0, 'async_trait>( &'life0 self, input: GetBlockRequest, ) -> Pin<Box<dyn Future<Output = Result<GetBlockResponse, RusotoError<GetBlockError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn get_digest<'life0, 'async_trait>( &'life0 self, input: GetDigestRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDigestResponse, RusotoError<GetDigestError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn get_revision<'life0, 'async_trait>( &'life0 self, input: GetRevisionRequest, ) -> Pin<Box<dyn Future<Output = Result<GetRevisionResponse, RusotoError<GetRevisionError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn list_journal_kinesis_streams_for_ledger<'life0, 'async_trait>( &'life0 self, input: ListJournalKinesisStreamsForLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalKinesisStreamsForLedgerResponse, RusotoError<ListJournalKinesisStreamsForLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn list_journal_s3_exports<'life0, 'async_trait>( &'life0 self, input: ListJournalS3ExportsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalS3ExportsResponse, RusotoError<ListJournalS3ExportsError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn list_journal_s3_exports_for_ledger<'life0, 'async_trait>( &'life0 self, input: ListJournalS3ExportsForLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalS3ExportsForLedgerResponse, RusotoError<ListJournalS3ExportsForLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn list_ledgers<'life0, 'async_trait>( &'life0 self, input: ListLedgersRequest, ) -> Pin<Box<dyn Future<Output = Result<ListLedgersResponse, RusotoError<ListLedgersError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn stream_journal_to_kinesis<'life0, 'async_trait>( &'life0 self, input: StreamJournalToKinesisRequest, ) -> Pin<Box<dyn Future<Output = Result<StreamJournalToKinesisResponse, RusotoError<StreamJournalToKinesisError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn tag_resource<'life0, 'async_trait>( &'life0 self, input: TagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn untag_resource<'life0, 'async_trait>( &'life0 self, input: UntagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait; fn update_ledger<'life0, 'async_trait>( &'life0 self, input: UpdateLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateLedgerResponse, RusotoError<UpdateLedgerError>>> + Send + 'async_trait>> where Self: 'async_trait, 'life0: 'async_trait;
}
Expand description

Trait representing the capabilities of the QLDB API. QLDB clients implement this trait.

Required Methods§

Source

fn cancel_journal_kinesis_stream<'life0, 'async_trait>( &'life0 self, input: CancelJournalKinesisStreamRequest, ) -> Pin<Box<dyn Future<Output = Result<CancelJournalKinesisStreamResponse, RusotoError<CancelJournalKinesisStreamError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn create_ledger<'life0, 'async_trait>( &'life0 self, input: CreateLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLedgerResponse, RusotoError<CreateLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Creates a new ledger in your AWS account.

Source

fn delete_ledger<'life0, 'async_trait>( &'life0 self, input: DeleteLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn describe_journal_kinesis_stream<'life0, 'async_trait>( &'life0 self, input: DescribeJournalKinesisStreamRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeJournalKinesisStreamResponse, RusotoError<DescribeJournalKinesisStreamError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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 your original stream creation request.

Source

fn describe_journal_s3_export<'life0, 'async_trait>( &'life0 self, input: DescribeJournalS3ExportRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeJournalS3ExportResponse, RusotoError<DescribeJournalS3ExportError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

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.

Source

fn describe_ledger<'life0, 'async_trait>( &'life0 self, input: DescribeLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLedgerResponse, RusotoError<DescribeLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns information about a ledger, including its state and when it was created.

Source

fn export_journal_to_s3<'life0, 'async_trait>( &'life0 self, input: ExportJournalToS3Request, ) -> Pin<Box<dyn Future<Output = Result<ExportJournalToS3Response, RusotoError<ExportJournalToS3Error>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn get_block<'life0, 'async_trait>( &'life0 self, input: GetBlockRequest, ) -> Pin<Box<dyn Future<Output = Result<GetBlockResponse, RusotoError<GetBlockError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn get_digest<'life0, 'async_trait>( &'life0 self, input: GetDigestRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDigestResponse, RusotoError<GetDigestError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn get_revision<'life0, 'async_trait>( &'life0 self, input: GetRevisionRequest, ) -> Pin<Box<dyn Future<Output = Result<GetRevisionResponse, RusotoError<GetRevisionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn list_journal_kinesis_streams_for_ledger<'life0, 'async_trait>( &'life0 self, input: ListJournalKinesisStreamsForLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalKinesisStreamsForLedgerResponse, RusotoError<ListJournalKinesisStreamsForLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

Source

fn list_journal_s3_exports<'life0, 'async_trait>( &'life0 self, input: ListJournalS3ExportsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalS3ExportsResponse, RusotoError<ListJournalS3ExportsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

Source

fn list_journal_s3_exports_for_ledger<'life0, 'async_trait>( &'life0 self, input: ListJournalS3ExportsForLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<ListJournalS3ExportsForLedgerResponse, RusotoError<ListJournalS3ExportsForLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

Source

fn list_ledgers<'life0, 'async_trait>( &'life0 self, input: ListLedgersRequest, ) -> Pin<Box<dyn Future<Output = Result<ListLedgersResponse, RusotoError<ListLedgersError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns all tags for a specified Amazon QLDB resource.

Source

fn stream_journal_to_kinesis<'life0, 'async_trait>( &'life0 self, input: StreamJournalToKinesisRequest, ) -> Pin<Box<dyn Future<Output = Result<StreamJournalToKinesisResponse, RusotoError<StreamJournalToKinesisError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn tag_resource<'life0, 'async_trait>( &'life0 self, input: TagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

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.

Source

fn untag_resource<'life0, 'async_trait>( &'life0 self, input: UntagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

Source

fn update_ledger<'life0, 'async_trait>( &'life0 self, input: UpdateLedgerRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateLedgerResponse, RusotoError<UpdateLedgerError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Updates properties on a ledger.

Implementors§