pub struct ExportJournalToS3FluentBuilder { /* private fields */ }
Expand description
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.
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§
Source§impl ExportJournalToS3FluentBuilder
impl ExportJournalToS3FluentBuilder
Sourcepub fn as_input(&self) -> &ExportJournalToS3InputBuilder
pub fn as_input(&self) -> &ExportJournalToS3InputBuilder
Access the ExportJournalToS3 as a reference.
Sourcepub async fn send(
self,
) -> Result<ExportJournalToS3Output, SdkError<ExportJournalToS3Error, HttpResponse>>
pub async fn send( self, ) -> Result<ExportJournalToS3Output, SdkError<ExportJournalToS3Error, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<ExportJournalToS3Output, ExportJournalToS3Error, Self>
pub fn customize( self, ) -> CustomizableOperation<ExportJournalToS3Output, ExportJournalToS3Error, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn inclusive_start_time(self, input: DateTime) -> Self
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
.
Sourcepub fn set_inclusive_start_time(self, input: Option<DateTime>) -> Self
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
.
Sourcepub fn get_inclusive_start_time(&self) -> &Option<DateTime>
pub fn get_inclusive_start_time(&self) -> &Option<DateTime>
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
.
Sourcepub fn exclusive_end_time(self, input: DateTime) -> Self
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.
Sourcepub fn set_exclusive_end_time(self, input: Option<DateTime>) -> Self
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.
Sourcepub fn get_exclusive_end_time(&self) -> &Option<DateTime>
pub fn get_exclusive_end_time(&self) -> &Option<DateTime>
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.
Sourcepub fn s3_export_configuration(self, input: S3ExportConfiguration) -> Self
pub fn s3_export_configuration(self, input: S3ExportConfiguration) -> Self
The configuration settings of the Amazon S3 bucket destination for your export request.
Sourcepub fn set_s3_export_configuration(
self,
input: Option<S3ExportConfiguration>,
) -> Self
pub fn set_s3_export_configuration( self, input: Option<S3ExportConfiguration>, ) -> Self
The configuration settings of the Amazon S3 bucket destination for your export request.
Sourcepub fn get_s3_export_configuration(&self) -> &Option<S3ExportConfiguration>
pub fn get_s3_export_configuration(&self) -> &Option<S3ExportConfiguration>
The configuration settings of the Amazon S3 bucket destination for your export request.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
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 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.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
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 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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
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 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.
Sourcepub fn output_format(self, input: OutputFormat) -> Self
pub fn output_format(self, input: OutputFormat) -> Self
The output format of your exported journal data. 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.
Default: ION_TEXT
In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.
Sourcepub fn set_output_format(self, input: Option<OutputFormat>) -> Self
pub fn set_output_format(self, input: Option<OutputFormat>) -> Self
The output format of your exported journal data. 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.
Default: ION_TEXT
In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.
Sourcepub fn get_output_format(&self) -> &Option<OutputFormat>
pub fn get_output_format(&self) -> &Option<OutputFormat>
The output format of your exported journal data. 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.
Default: ION_TEXT
In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.
Trait Implementations§
Source§impl Clone for ExportJournalToS3FluentBuilder
impl Clone for ExportJournalToS3FluentBuilder
Source§fn clone(&self) -> ExportJournalToS3FluentBuilder
fn clone(&self) -> ExportJournalToS3FluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ExportJournalToS3FluentBuilder
impl !RefUnwindSafe for ExportJournalToS3FluentBuilder
impl Send for ExportJournalToS3FluentBuilder
impl Sync for ExportJournalToS3FluentBuilder
impl Unpin for ExportJournalToS3FluentBuilder
impl !UnwindSafe for ExportJournalToS3FluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);