Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.StartMailboxExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Synopsis

data StartMailboxExportJob = StartMailboxExportJob' {
- description :: Maybe Text
- clientToken :: Text
- organizationId :: Text
- entityId :: Text
- roleArn :: Text
- kmsKeyArn :: Text
- s3BucketName :: Text
- s3Prefix :: Text
}
newStartMailboxExportJob :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> StartMailboxExportJob
startMailboxExportJob_description :: Lens' StartMailboxExportJob (Maybe Text)
startMailboxExportJob_clientToken :: Lens' StartMailboxExportJob Text
startMailboxExportJob_organizationId :: Lens' StartMailboxExportJob Text
startMailboxExportJob_entityId :: Lens' StartMailboxExportJob Text
startMailboxExportJob_roleArn :: Lens' StartMailboxExportJob Text
startMailboxExportJob_kmsKeyArn :: Lens' StartMailboxExportJob Text
startMailboxExportJob_s3BucketName :: Lens' StartMailboxExportJob Text
startMailboxExportJob_s3Prefix :: Lens' StartMailboxExportJob Text
data StartMailboxExportJobResponse = StartMailboxExportJobResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
}
newStartMailboxExportJobResponse :: Int -> StartMailboxExportJobResponse
startMailboxExportJobResponse_jobId :: Lens' StartMailboxExportJobResponse (Maybe Text)
startMailboxExportJobResponse_httpStatus :: Lens' StartMailboxExportJobResponse Int

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

Eq StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods (==) :: StartMailboxExportJob -> StartMailboxExportJob -> Bool # (/=) :: StartMailboxExportJob -> StartMailboxExportJob -> Bool #
Read StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods readsPrec :: Int -> ReadS StartMailboxExportJob # readList :: ReadS [StartMailboxExportJob] # readPrec :: ReadPrec StartMailboxExportJob # readListPrec :: ReadPrec [StartMailboxExportJob] #
Show StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods showsPrec :: Int -> StartMailboxExportJob -> ShowS # show :: StartMailboxExportJob -> String # showList :: [StartMailboxExportJob] -> ShowS #
Generic StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Associated Types type Rep StartMailboxExportJob :: Type -> Type # Methods from :: StartMailboxExportJob -> Rep StartMailboxExportJob x # to :: Rep StartMailboxExportJob x -> StartMailboxExportJob #
NFData StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods rnf :: StartMailboxExportJob -> () #
Hashable StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods hashWithSalt :: Int -> StartMailboxExportJob -> Int # hash :: StartMailboxExportJob -> Int #
ToJSON StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods toJSON :: StartMailboxExportJob -> Value # toEncoding :: StartMailboxExportJob -> Encoding # toJSONList :: [StartMailboxExportJob] -> Value # toEncodingList :: [StartMailboxExportJob] -> Encoding #
AWSRequest StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Associated Types type AWSResponse StartMailboxExportJob # Methods request :: StartMailboxExportJob -> Request StartMailboxExportJob # response :: MonadResource m => Logger -> Service -> Proxy StartMailboxExportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartMailboxExportJob))) #
ToHeaders StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods toHeaders :: StartMailboxExportJob -> [Header] #
ToPath StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods toPath :: StartMailboxExportJob -> ByteString #
ToQuery StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods toQuery :: StartMailboxExportJob -> QueryString #
type Rep StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob type Rep StartMailboxExportJob = D1 ('MetaData "StartMailboxExportJob" "Amazonka.WorkMail.StartMailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" '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)))))
type AWSResponse StartMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob type AWSResponse StartMailboxExportJob = StartMailboxExportJobResponse

newStartMailboxExportJob Source #

Arguments

:: Text	`$sel:clientToken:StartMailboxExportJob'`
-> Text	`$sel:organizationId:StartMailboxExportJob'`
-> Text	`$sel:entityId:StartMailboxExportJob'`
-> Text	`$sel:roleArn:StartMailboxExportJob'`
-> Text	`$sel:kmsKeyArn:StartMailboxExportJob'`
-> Text	`$sel:s3BucketName: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:

$sel:description:StartMailboxExportJob', startMailboxExportJob_description - The mailbox export job description.

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

$sel:organizationId:StartMailboxExportJob', startMailboxExportJob_organizationId - The identifier associated with the organization.

$sel:entityId: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.

$sel:s3BucketName: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) Source #

The mailbox export job description.

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.

startMailboxExportJob_s3BucketName :: Lens' StartMailboxExportJob Text Source #

The name of the S3 bucket.

startMailboxExportJob_s3Prefix :: Lens' StartMailboxExportJob Text Source #

The S3 bucket prefix.

Destructuring the Response

data StartMailboxExportJobResponse Source #

See: newStartMailboxExportJobResponse smart constructor.

Constructors

StartMailboxExportJobResponse'
Fields jobId :: Maybe Text The job ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods (==) :: StartMailboxExportJobResponse -> StartMailboxExportJobResponse -> Bool # (/=) :: StartMailboxExportJobResponse -> StartMailboxExportJobResponse -> Bool #
Read StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods readsPrec :: Int -> ReadS StartMailboxExportJobResponse # readList :: ReadS [StartMailboxExportJobResponse] # readPrec :: ReadPrec StartMailboxExportJobResponse # readListPrec :: ReadPrec [StartMailboxExportJobResponse] #
Show StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods showsPrec :: Int -> StartMailboxExportJobResponse -> ShowS # show :: StartMailboxExportJobResponse -> String # showList :: [StartMailboxExportJobResponse] -> ShowS #
Generic StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Associated Types type Rep StartMailboxExportJobResponse :: Type -> Type # Methods from :: StartMailboxExportJobResponse -> Rep StartMailboxExportJobResponse x # to :: Rep StartMailboxExportJobResponse x -> StartMailboxExportJobResponse #
NFData StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob Methods rnf :: StartMailboxExportJobResponse -> () #
type Rep StartMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.StartMailboxExportJob type Rep StartMailboxExportJobResponse = D1 ('MetaData "StartMailboxExportJobResponse" "Amazonka.WorkMail.StartMailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" '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 #

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:

$sel:jobId: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) Source #

The job ID.

startMailboxExportJobResponse_httpStatus :: Lens' StartMailboxExportJobResponse Int Source #

The response's http status code.