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.Types.MailboxExportJob

Description

Synopsis

data MailboxExportJob = MailboxExportJob' {
- state :: Maybe MailboxExportJobState
- jobId :: Maybe Text
- startTime :: Maybe POSIX
- estimatedProgress :: Maybe Natural
- endTime :: Maybe POSIX
- s3Path :: Maybe Text
- entityId :: Maybe Text
- description :: Maybe Text
- s3BucketName :: Maybe Text
}
newMailboxExportJob :: MailboxExportJob
mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState)
mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text)
mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime)
mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural)
mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime)
mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text)
mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text)
mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text)
mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text)

Documentation

data MailboxExportJob Source #

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

See: newMailboxExportJob smart constructor.

Constructors

MailboxExportJob'

Fields

state :: Maybe MailboxExportJobState
The state of the mailbox export job.
jobId :: Maybe Text
The identifier of the mailbox export job.
startTime :: Maybe POSIX
The mailbox export job start timestamp.
estimatedProgress :: Maybe Natural
The estimated progress of the mailbox export job, in percentage points.
endTime :: Maybe POSIX
The mailbox export job end timestamp.
s3Path :: Maybe Text
The path to the S3 bucket and file that the mailbox export job exports to.
entityId :: Maybe Text
The identifier of the user or resource associated with the mailbox.
description :: Maybe Text
The mailbox export job description.
s3BucketName :: Maybe Text
The name of the S3 bucket.

Instances

Instances details

Eq MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods (==) :: MailboxExportJob -> MailboxExportJob -> Bool # (/=) :: MailboxExportJob -> MailboxExportJob -> Bool #
Read MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods readsPrec :: Int -> ReadS MailboxExportJob # readList :: ReadS [MailboxExportJob] # readPrec :: ReadPrec MailboxExportJob # readListPrec :: ReadPrec [MailboxExportJob] #
Show MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods showsPrec :: Int -> MailboxExportJob -> ShowS # show :: MailboxExportJob -> String # showList :: [MailboxExportJob] -> ShowS #
Generic MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Associated Types type Rep MailboxExportJob :: Type -> Type # Methods from :: MailboxExportJob -> Rep MailboxExportJob x # to :: Rep MailboxExportJob x -> MailboxExportJob #
NFData MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods rnf :: MailboxExportJob -> () #
Hashable MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods hashWithSalt :: Int -> MailboxExportJob -> Int # hash :: MailboxExportJob -> Int #
FromJSON MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob Methods parseJSON :: Value -> Parser MailboxExportJob # parseJSONList :: Value -> Parser [MailboxExportJob] #
type Rep MailboxExportJob Source #
Instance details Defined in Amazonka.WorkMail.Types.MailboxExportJob type Rep MailboxExportJob = D1 ('MetaData "MailboxExportJob" "Amazonka.WorkMail.Types.MailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "MailboxExportJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MailboxExportJobState)) :: S1 ('MetaSel ('Just "jobId") '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 "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMailboxExportJob :: MailboxExportJob Source #

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

$sel:jobId:MailboxExportJob', mailboxExportJob_jobId - The identifier of the mailbox export job.

$sel:startTime:MailboxExportJob', mailboxExportJob_startTime - The mailbox export job start timestamp.

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

$sel:endTime:MailboxExportJob', mailboxExportJob_endTime - The mailbox export job end timestamp.

$sel:s3Path:MailboxExportJob', mailboxExportJob_s3Path - The path to the S3 bucket and file that the mailbox export job exports to.

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

$sel:description:MailboxExportJob', mailboxExportJob_description - The mailbox export job description.

$sel:s3BucketName:MailboxExportJob', mailboxExportJob_s3BucketName - The name of the S3 bucket.

mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState) Source #

The state of the mailbox export job.

mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text) Source #

The identifier of the mailbox export job.

mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #

The mailbox export job start timestamp.

mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural) Source #

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

mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #

The mailbox export job end timestamp.

mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text) Source #

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

mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text) Source #

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

mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text) Source #

The mailbox export job description.

mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text) Source #

The name of the S3 bucket.