Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkMail.DescribeMailboxExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the current status of a mailbox export job.

Synopsis

Creating a Request

data DescribeMailboxExportJob Source #

See: newDescribeMailboxExportJob smart constructor.

Constructors

DescribeMailboxExportJob'
Fields jobId :: Text The mailbox export job ID. organizationId :: Text The organization ID.

Instances

Instances details

ToJSON DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods toJSON :: DescribeMailboxExportJob -> Value # toEncoding :: DescribeMailboxExportJob -> Encoding # toJSONList :: [DescribeMailboxExportJob] -> Value # toEncodingList :: [DescribeMailboxExportJob] -> Encoding #
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 #
AWSRequest DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Associated Types type AWSResponse DescribeMailboxExportJob # Methods request :: (Service -> Service) -> DescribeMailboxExportJob -> Request DescribeMailboxExportJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeMailboxExportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMailboxExportJob))) #
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 #
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 #
NFData DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods rnf :: DescribeMailboxExportJob -> () #
Eq DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods (==) :: DescribeMailboxExportJob -> DescribeMailboxExportJob -> Bool # (/=) :: DescribeMailboxExportJob -> DescribeMailboxExportJob -> Bool #
Hashable DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods hashWithSalt :: Int -> DescribeMailboxExportJob -> Int # hash :: DescribeMailboxExportJob -> Int #
type AWSResponse DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob type AWSResponse DescribeMailboxExportJob = DescribeMailboxExportJobResponse
type Rep DescribeMailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob type Rep DescribeMailboxExportJob = D1 ('MetaData "DescribeMailboxExportJob" "Amazonka.WorkMail.DescribeMailboxExportJob" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DescribeMailboxExportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeMailboxExportJob Source #

Arguments

:: Text	`DescribeMailboxExportJob`
-> Text	`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:

DescribeMailboxExportJob, describeMailboxExportJob_jobId - The mailbox export job ID.

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

description :: Maybe Text
The mailbox export job description.
endTime :: Maybe POSIX
The mailbox export job end timestamp.
entityId :: Maybe Text
The identifier of the user or resource associated with the mailbox.
errorInfo :: Maybe Text
Error information for failed mailbox export jobs.
estimatedProgress :: Maybe Natural
The estimated progress of the mailbox export job, in percentage points.
kmsKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
roleArn :: Maybe Text
The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
s3BucketName :: Maybe Text
The name of the S3 bucket.
s3Path :: Maybe Text
The path to the S3 bucket and file that the mailbox export job is exporting to.
s3Prefix :: Maybe Text
The S3 bucket prefix.
startTime :: Maybe POSIX
The mailbox export job start timestamp.
state :: Maybe MailboxExportJobState
The state of the mailbox export job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods rnf :: DescribeMailboxExportJobResponse -> () #
Eq DescribeMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob Methods (==) :: DescribeMailboxExportJobResponse -> DescribeMailboxExportJobResponse -> Bool # (/=) :: DescribeMailboxExportJobResponse -> DescribeMailboxExportJobResponse -> Bool #
type Rep DescribeMailboxExportJobResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeMailboxExportJob type Rep DescribeMailboxExportJobResponse = D1 ('MetaData "DescribeMailboxExportJobResponse" "Amazonka.WorkMail.DescribeMailboxExportJob" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DescribeMailboxExportJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "estimatedProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MailboxExportJobState)) :: 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:

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_description - The mailbox export job description.

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_endTime - The mailbox export job end timestamp.

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_entityId - The identifier of the user or resource associated with the mailbox.

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

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

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

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_s3BucketName - The name of the S3 bucket.

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.

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_startTime - The mailbox export job start timestamp.

DescribeMailboxExportJobResponse, describeMailboxExportJobResponse_state - The state of the mailbox export job.

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