amazonka-workmail-2.0: Amazon WorkMail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkMail.StartMailboxExportJob

Description

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 WorkMail Administrator Guide.

Synopsis

Creating a Request

data StartMailboxExportJob Source #

See: newStartMailboxExportJob smart constructor.

Constructors

StartMailboxExportJob' 

Fields

  • description :: Maybe Text

    The mailbox export job description.

  • clientToken :: Text

    The idempotency token for the client request.

  • organizationId :: Text

    The identifier associated with the organization.

  • entityId :: Text

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

  • roleArn :: Text

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

  • kmsKeyArn :: Text

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

  • s3BucketName :: Text

    The name of the S3 bucket.

  • s3Prefix :: Text

    The S3 bucket prefix.

Instances

Instances details
ToJSON StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

ToHeaders StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

ToPath StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

ToQuery StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

AWSRequest StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type AWSResponse StartMailboxExportJob #

Generic StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type Rep StartMailboxExportJob :: Type -> Type #

Read StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Show StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

NFData StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

rnf :: StartMailboxExportJob -> () #

Eq StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Hashable StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

type AWSResponse StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

type Rep StartMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

type Rep StartMailboxExportJob = D1 ('MetaData "StartMailboxExportJob" "Amazonka.WorkMail.StartMailboxExportJob" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "StartMailboxExportJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartMailboxExportJob Source #

Create a value of StartMailboxExportJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartMailboxExportJob, startMailboxExportJob_description - The mailbox export job description.

$sel:clientToken:StartMailboxExportJob', startMailboxExportJob_clientToken - The idempotency token for the client request.

StartMailboxExportJob, startMailboxExportJob_organizationId - The identifier associated with the organization.

StartMailboxExportJob, startMailboxExportJob_entityId - The identifier of the user or resource associated with the mailbox.

$sel:roleArn:StartMailboxExportJob', startMailboxExportJob_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

$sel:kmsKeyArn:StartMailboxExportJob', startMailboxExportJob_kmsKeyArn - The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

StartMailboxExportJob, startMailboxExportJob_s3BucketName - The name of the S3 bucket.

$sel:s3Prefix:StartMailboxExportJob', startMailboxExportJob_s3Prefix - The S3 bucket prefix.

Request Lenses

startMailboxExportJob_clientToken :: Lens' StartMailboxExportJob Text Source #

The idempotency token for the client request.

startMailboxExportJob_organizationId :: Lens' StartMailboxExportJob Text Source #

The identifier associated with the organization.

startMailboxExportJob_entityId :: Lens' StartMailboxExportJob Text Source #

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

startMailboxExportJob_roleArn :: Lens' StartMailboxExportJob Text Source #

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

startMailboxExportJob_kmsKeyArn :: Lens' StartMailboxExportJob Text Source #

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

Destructuring the Response

data StartMailboxExportJobResponse Source #

See: newStartMailboxExportJobResponse smart constructor.

Constructors

StartMailboxExportJobResponse' 

Fields

Instances

Instances details
Generic StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type Rep StartMailboxExportJobResponse :: Type -> Type #

Read StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Show StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

NFData StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

Eq StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

type Rep StartMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.StartMailboxExportJob

type Rep StartMailboxExportJobResponse = D1 ('MetaData "StartMailboxExportJobResponse" "Amazonka.WorkMail.StartMailboxExportJob" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "StartMailboxExportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartMailboxExportJobResponse Source #

Create a value of StartMailboxExportJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartMailboxExportJobResponse, startMailboxExportJobResponse_jobId - The job ID.

$sel:httpStatus:StartMailboxExportJobResponse', startMailboxExportJobResponse_httpStatus - The response's http status code.

Response Lenses