aws_sdk_workmail/client/
start_mailbox_export_job.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartMailboxExportJob`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_client_token):<br>required: **true**<br><p>The idempotency token for the client request.</p><br>
    ///   - [`organization_id(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier associated with the organization.</p><br>
    ///   - [`entity_id(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_entity_id):<br>required: **true**<br><p>The identifier of the user or resource associated with the mailbox.</p> <p>The identifier can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>. The following identity formats are available:</p> <ul>  <li>   <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: entity@domain.tld</p></li>  <li>   <p>Entity name: entity</p></li> </ul><br>
    ///   - [`description(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_description):<br>required: **false**<br><p>The mailbox export job description.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.</p><br>
    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_kms_key_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.</p><br>
    ///   - [`s3_bucket_name(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::s3_bucket_name) / [`set_s3_bucket_name(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_s3_bucket_name):<br>required: **true**<br><p>The name of the S3 bucket.</p><br>
    ///   - [`s3_prefix(impl Into<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::s3_prefix) / [`set_s3_prefix(Option<String>)`](crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::set_s3_prefix):<br>required: **true**<br><p>The S3 bucket prefix.</p><br>
    /// - On success, responds with [`StartMailboxExportJobOutput`](crate::operation::start_mailbox_export_job::StartMailboxExportJobOutput) with field(s):
    ///   - [`job_id(Option<String>)`](crate::operation::start_mailbox_export_job::StartMailboxExportJobOutput::job_id): <p>The job ID.</p>
    /// - On failure, responds with [`SdkError<StartMailboxExportJobError>`](crate::operation::start_mailbox_export_job::StartMailboxExportJobError)
    pub fn start_mailbox_export_job(&self) -> crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder {
        crate::operation::start_mailbox_export_job::builders::StartMailboxExportJobFluentBuilder::new(self.handle.clone())
    }
}