Struct aws_sdk_workmail::client::fluent_builders::StartMailboxExportJob

pub struct StartMailboxExportJob<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StartMailboxExportJob.

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.

Implementations

impl<C, M, R> StartMailboxExportJob<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartMailboxExportJobOutput, SdkError<StartMailboxExportJobError>> where
    R::Policy: SmithyRetryPolicy<StartMailboxExportJobInputOperationOutputAlias, StartMailboxExportJobOutput, StartMailboxExportJobError, StartMailboxExportJobInputOperationRetryAlias>, 

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 client_token(self, inp: impl Into<String>) -> Self

The idempotency token for the client request.

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

The idempotency token for the client request.

pub fn organization_id(self, inp: impl Into<String>) -> Self

The identifier associated with the organization.

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

The identifier associated with the organization.

pub fn entity_id(self, inp: impl Into<String>) -> Self

The identifier of the user or resource associated with the mailbox.

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

The identifier of the user or resource associated with the mailbox.

pub fn description(self, inp: impl Into<String>) -> Self

The mailbox export job description.

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

The mailbox export job description.

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

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

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

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

pub fn kms_key_arn(self, inp: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

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

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

pub fn s3_bucket_name(self, inp: impl Into<String>) -> Self

The name of the S3 bucket.

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

The name of the S3 bucket.

pub fn s3_prefix(self, inp: impl Into<String>) -> Self

The S3 bucket prefix.

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

The S3 bucket prefix.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StartMailboxExportJob<C, M, R>

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

Formats the value using the given formatter.