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

Creating a Request

data StartMailboxExportJob

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

ToJSON StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

toJSON :: StartMailboxExportJob -> Value

toEncoding :: StartMailboxExportJob -> Encoding

toJSONList :: [StartMailboxExportJob] -> Value

toEncodingList :: [StartMailboxExportJob] -> Encoding

ToHeaders StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

toHeaders :: StartMailboxExportJob -> [Header]

ToPath StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

toPath :: StartMailboxExportJob -> ByteString

ToQuery StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

toQuery :: StartMailboxExportJob -> QueryString

AWSRequest StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type AWSResponse StartMailboxExportJob

Methods

request :: (Service -> Service) -> StartMailboxExportJob -> Request StartMailboxExportJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartMailboxExportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartMailboxExportJob)))

Generic StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type Rep StartMailboxExportJob :: Type -> Type

Methods

from :: StartMailboxExportJob -> Rep StartMailboxExportJob x

to :: Rep StartMailboxExportJob x -> StartMailboxExportJob

Read StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

readsPrec :: Int -> ReadS StartMailboxExportJob

readList :: ReadS [StartMailboxExportJob]

readPrec :: ReadPrec StartMailboxExportJob

readListPrec :: ReadPrec [StartMailboxExportJob]

Show StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

showsPrec :: Int -> StartMailboxExportJob -> ShowS

show :: StartMailboxExportJob -> String

showList :: [StartMailboxExportJob] -> ShowS

NFData StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

rnf :: StartMailboxExportJob -> ()

Eq StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

(==) :: StartMailboxExportJob -> StartMailboxExportJob -> Bool

(/=) :: StartMailboxExportJob -> StartMailboxExportJob -> Bool

Hashable StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

hashWithSalt :: Int -> StartMailboxExportJob -> Int

hash :: StartMailboxExportJob -> Int

type AWSResponse StartMailboxExportJob

Defined in Amazonka.WorkMail.StartMailboxExportJob

type AWSResponse StartMailboxExportJob = StartMailboxExportJobResponse

type Rep StartMailboxExportJob

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

Arguments

:: Text

$sel:clientToken:StartMailboxExportJob'

-> Text

StartMailboxExportJob

-> Text

StartMailboxExportJob

-> Text

$sel:roleArn:StartMailboxExportJob'

-> Text

$sel:kmsKeyArn:StartMailboxExportJob'

-> Text

StartMailboxExportJob

-> Text

$sel:s3Prefix:StartMailboxExportJob'

-> StartMailboxExportJob

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_description :: Lens' StartMailboxExportJob (Maybe Text)

The mailbox export job description.

startMailboxExportJob_clientToken :: Lens' StartMailboxExportJob Text

The idempotency token for the client request.

startMailboxExportJob_organizationId :: Lens' StartMailboxExportJob Text

The identifier associated with the organization.

startMailboxExportJob_entityId :: Lens' StartMailboxExportJob Text

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

startMailboxExportJob_roleArn :: Lens' StartMailboxExportJob Text

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

startMailboxExportJob_kmsKeyArn :: Lens' StartMailboxExportJob Text

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

startMailboxExportJob_s3BucketName :: Lens' StartMailboxExportJob Text

The name of the S3 bucket.

startMailboxExportJob_s3Prefix :: Lens' StartMailboxExportJob Text

The S3 bucket prefix.

Destructuring the Response

data StartMailboxExportJobResponse

See: newStartMailboxExportJobResponse smart constructor.

Constructors

StartMailboxExportJobResponse'

Fields

• jobId :: Maybe Text

  The job ID.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartMailboxExportJobResponse

Defined in Amazonka.WorkMail.StartMailboxExportJob

Associated Types

type Rep StartMailboxExportJobResponse :: Type -> Type

Methods

from :: StartMailboxExportJobResponse -> Rep StartMailboxExportJobResponse x

to :: Rep StartMailboxExportJobResponse x -> StartMailboxExportJobResponse

Read StartMailboxExportJobResponse

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

readsPrec :: Int -> ReadS StartMailboxExportJobResponse

readList :: ReadS [StartMailboxExportJobResponse]

readPrec :: ReadPrec StartMailboxExportJobResponse

readListPrec :: ReadPrec [StartMailboxExportJobResponse]

Show StartMailboxExportJobResponse

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

showsPrec :: Int -> StartMailboxExportJobResponse -> ShowS

show :: StartMailboxExportJobResponse -> String

showList :: [StartMailboxExportJobResponse] -> ShowS

NFData StartMailboxExportJobResponse

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

rnf :: StartMailboxExportJobResponse -> ()

Eq StartMailboxExportJobResponse

Defined in Amazonka.WorkMail.StartMailboxExportJob

Methods

(==) :: StartMailboxExportJobResponse -> StartMailboxExportJobResponse -> Bool

(/=) :: StartMailboxExportJobResponse -> StartMailboxExportJobResponse -> Bool

type Rep StartMailboxExportJobResponse

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

Arguments

:: Int

$sel:httpStatus:StartMailboxExportJobResponse'

-> StartMailboxExportJobResponse

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

startMailboxExportJobResponse_jobId :: Lens' StartMailboxExportJobResponse (Maybe Text)

The job ID.

startMailboxExportJobResponse_httpStatus :: Lens' StartMailboxExportJobResponse Int

The response's http status code.