Struct aws_sdk_qldb::client::fluent_builders::ExportJournalToS3

pub struct ExportJournalToS3 { /* private fields */ }

Fluent builder constructing a request to ExportJournalToS3.

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.

In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines.

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.

Implementations

impl ExportJournalToS3

pub async fn send(
    self
) -> Result<ExportJournalToS3Output, SdkError<ExportJournalToS3Error>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the ledger.

pub fn set_name(self, input: Option<String>) -> Self

The name of the ledger.

pub fn inclusive_start_time(self, input: DateTime) -> Self

The inclusive start date and time for the range of journal contents to export.

The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

pub fn set_inclusive_start_time(self, input: Option<DateTime>) -> Self

The inclusive start date and time for the range of journal contents to export.

The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

pub fn exclusive_end_time(self, input: DateTime) -> Self

The exclusive end date and time for the range of journal contents to export.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The ExclusiveEndTime must be less than or equal to the current UTC date and time.

pub fn set_exclusive_end_time(self, input: Option<DateTime>) -> Self

The exclusive end date and time for the range of journal contents to export.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The ExclusiveEndTime must be less than or equal to the current UTC date and time.

pub fn s3_export_configuration(self, input: S3ExportConfiguration) -> Self

The configuration settings of the Amazon S3 bucket destination for your export request.

pub fn set_s3_export_configuration(
    self,
    input: Option<S3ExportConfiguration>
) -> Self

The configuration settings of the Amazon S3 bucket destination for your export request.

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

• Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

• (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

• Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

• (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

pub fn output_format(self, input: OutputFormat) -> Self

The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

pub fn set_output_format(self, input: Option<OutputFormat>) -> Self

The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Trait Implementations

impl Clone for ExportJournalToS3

fn clone(&self) -> ExportJournalToS3

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExportJournalToS3

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.