libZSservicesZSamazonka-workmailZSamazonka-workmail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkMail.DescribeMailboxExportJob

Description

Describes the current status of a mailbox export job.

Synopsis

Creating a Request

data DescribeMailboxExportJob Source #

See: newDescribeMailboxExportJob smart constructor.

Constructors

DescribeMailboxExportJob' 

Fields

Instances

Instances details
Eq DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

(==) :: DescribeMailboxExportJob -> DescribeMailboxExportJob -> Bool #

(/=) :: DescribeMailboxExportJob -> DescribeMailboxExportJob -> Bool #

Read DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

readsPrec :: Int -> ReadS DescribeMailboxExportJob #

readList :: ReadS [DescribeMailboxExportJob] #

readPrec :: ReadPrec DescribeMailboxExportJob #

readListPrec :: ReadPrec [DescribeMailboxExportJob] #

Show DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

showsPrec :: Int -> DescribeMailboxExportJob -> ShowS #

show :: DescribeMailboxExportJob -> String #

showList :: [DescribeMailboxExportJob] -> ShowS #

Generic DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Associated Types

type Rep DescribeMailboxExportJob :: Type -> Type #

Methods

from :: DescribeMailboxExportJob -> Rep DescribeMailboxExportJob x #

to :: Rep DescribeMailboxExportJob x -> DescribeMailboxExportJob #

NFData DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

rnf :: DescribeMailboxExportJob -> () #

Hashable DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

hashWithSalt :: Int -> DescribeMailboxExportJob -> Int #

hash :: DescribeMailboxExportJob -> Int #

ToJSON DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

toJSON :: DescribeMailboxExportJob -> Value #

toEncoding :: DescribeMailboxExportJob -> Encoding #

toJSONList :: [DescribeMailboxExportJob] -> Value #

toEncodingList :: [DescribeMailboxExportJob] -> Encoding #

AWSRequest DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Associated Types

type AWSResponse DescribeMailboxExportJob #

Methods

request :: DescribeMailboxExportJob -> Request DescribeMailboxExportJob #

response :: MonadResource m => Logger -> Service -> Proxy DescribeMailboxExportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMailboxExportJob))) #

ToHeaders DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

toHeaders :: DescribeMailboxExportJob -> [Header] #

ToPath DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

toPath :: DescribeMailboxExportJob -> ByteString #

ToQuery DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

toQuery :: DescribeMailboxExportJob -> QueryString #

type Rep DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

type Rep DescribeMailboxExportJob = D1 ('MetaData "DescribeMailboxExportJob" "Amazonka.WorkMail.DescribeMailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeMailboxExportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeMailboxExportJob Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

type AWSResponse DescribeMailboxExportJob = DescribeMailboxExportJobResponse

newDescribeMailboxExportJob Source #

Arguments

:: Text

$sel:jobId:DescribeMailboxExportJob'

-> Text

$sel:organizationId:DescribeMailboxExportJob'

-> DescribeMailboxExportJob 

Create a value of DescribeMailboxExportJob 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:DescribeMailboxExportJob', describeMailboxExportJob_jobId - The mailbox export job ID.

$sel:organizationId:DescribeMailboxExportJob', describeMailboxExportJob_organizationId - The organization ID.

Request Lenses

describeMailboxExportJob_jobId :: Lens' DescribeMailboxExportJob Text Source #

The mailbox export job ID.

describeMailboxExportJob_organizationId :: Lens' DescribeMailboxExportJob Text Source #

The organization ID.

Destructuring the Response

data DescribeMailboxExportJobResponse Source #

See: newDescribeMailboxExportJobResponse smart constructor.

Constructors

DescribeMailboxExportJobResponse' 

Fields

Instances

Instances details
Eq DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

(==) :: DescribeMailboxExportJobResponse -> DescribeMailboxExportJobResponse -> Bool #

(/=) :: DescribeMailboxExportJobResponse -> DescribeMailboxExportJobResponse -> Bool #

Read DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

readsPrec :: Int -> ReadS DescribeMailboxExportJobResponse #

readList :: ReadS [DescribeMailboxExportJobResponse] #

readPrec :: ReadPrec DescribeMailboxExportJobResponse #

readListPrec :: ReadPrec [DescribeMailboxExportJobResponse] #

Show DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

showsPrec :: Int -> DescribeMailboxExportJobResponse -> ShowS #

show :: DescribeMailboxExportJobResponse -> String #

showList :: [DescribeMailboxExportJobResponse] -> ShowS #

Generic DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Associated Types

type Rep DescribeMailboxExportJobResponse :: Type -> Type #

Methods

from :: DescribeMailboxExportJobResponse -> Rep DescribeMailboxExportJobResponse x #

to :: Rep DescribeMailboxExportJobResponse x -> DescribeMailboxExportJobResponse #

NFData DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

Methods

rnf :: DescribeMailboxExportJobResponse -> () #

type Rep DescribeMailboxExportJobResponse Source # 
Instance details

Defined in Amazonka.WorkMail.DescribeMailboxExportJob

type Rep DescribeMailboxExportJobResponse = D1 ('MetaData "DescribeMailboxExportJobResponse" "Amazonka.WorkMail.DescribeMailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeMailboxExportJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MailboxExportJobState)) :*: (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "estimatedProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeMailboxExportJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeMailboxExportJobResponse'

-> DescribeMailboxExportJobResponse 

Create a value of DescribeMailboxExportJobResponse 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:state:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_state - The state of the mailbox export job.

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

$sel:startTime:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_startTime - The mailbox export job start timestamp.

$sel:estimatedProgress:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_estimatedProgress - The estimated progress of the mailbox export job, in percentage points.

$sel:endTime:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_endTime - The mailbox export job end timestamp.

$sel:s3Path:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_s3Path - The path to the S3 bucket and file that the mailbox export job is exporting to.

$sel:s3Prefix:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_s3Prefix - The S3 bucket prefix.

$sel:entityId:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_entityId - The identifier of the user or resource associated with the mailbox.

$sel:description:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_description - The mailbox export job description.

$sel:errorInfo:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_errorInfo - Error information for failed mailbox export jobs.

$sel:s3BucketName:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_s3BucketName - The name of the S3 bucket.

$sel:roleArn:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

$sel:httpStatus:DescribeMailboxExportJobResponse', describeMailboxExportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeMailboxExportJobResponse_state :: Lens' DescribeMailboxExportJobResponse (Maybe MailboxExportJobState) Source #

The state of the mailbox export job.

describeMailboxExportJobResponse_kmsKeyArn :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

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

describeMailboxExportJobResponse_startTime :: Lens' DescribeMailboxExportJobResponse (Maybe UTCTime) Source #

The mailbox export job start timestamp.

describeMailboxExportJobResponse_estimatedProgress :: Lens' DescribeMailboxExportJobResponse (Maybe Natural) Source #

The estimated progress of the mailbox export job, in percentage points.

describeMailboxExportJobResponse_endTime :: Lens' DescribeMailboxExportJobResponse (Maybe UTCTime) Source #

The mailbox export job end timestamp.

describeMailboxExportJobResponse_s3Path :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

The path to the S3 bucket and file that the mailbox export job is exporting to.

describeMailboxExportJobResponse_s3Prefix :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

The S3 bucket prefix.

describeMailboxExportJobResponse_entityId :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

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

describeMailboxExportJobResponse_description :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

The mailbox export job description.

describeMailboxExportJobResponse_errorInfo :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

Error information for failed mailbox export jobs.

describeMailboxExportJobResponse_s3BucketName :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

The name of the S3 bucket.

describeMailboxExportJobResponse_roleArn :: Lens' DescribeMailboxExportJobResponse (Maybe Text) Source #

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

describeMailboxExportJobResponse_httpStatus :: Lens' DescribeMailboxExportJobResponse Int Source #

The response's http status code.