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.Backup.Types.CopyJob

Description

Synopsis

data CopyJob = CopyJob' {
- accountId :: Maybe Text
- backupSizeInBytes :: Maybe Integer
- childJobsInState :: Maybe (HashMap CopyJobState Integer)
- completionDate :: Maybe POSIX
- compositeMemberIdentifier :: Maybe Text
- copyJobId :: Maybe Text
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- destinationBackupVaultArn :: Maybe Text
- destinationRecoveryPointArn :: Maybe Text
- iamRoleArn :: Maybe Text
- isParent :: Maybe Bool
- numberOfChildJobs :: Maybe Integer
- parentJobId :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- sourceBackupVaultArn :: Maybe Text
- sourceRecoveryPointArn :: Maybe Text
- state :: Maybe CopyJobState
- statusMessage :: Maybe Text
}
newCopyJob :: CopyJob
copyJob_accountId :: Lens' CopyJob (Maybe Text)
copyJob_backupSizeInBytes :: Lens' CopyJob (Maybe Integer)
copyJob_childJobsInState :: Lens' CopyJob (Maybe (HashMap CopyJobState Integer))
copyJob_completionDate :: Lens' CopyJob (Maybe UTCTime)
copyJob_compositeMemberIdentifier :: Lens' CopyJob (Maybe Text)
copyJob_copyJobId :: Lens' CopyJob (Maybe Text)
copyJob_createdBy :: Lens' CopyJob (Maybe RecoveryPointCreator)
copyJob_creationDate :: Lens' CopyJob (Maybe UTCTime)
copyJob_destinationBackupVaultArn :: Lens' CopyJob (Maybe Text)
copyJob_destinationRecoveryPointArn :: Lens' CopyJob (Maybe Text)
copyJob_iamRoleArn :: Lens' CopyJob (Maybe Text)
copyJob_isParent :: Lens' CopyJob (Maybe Bool)
copyJob_numberOfChildJobs :: Lens' CopyJob (Maybe Integer)
copyJob_parentJobId :: Lens' CopyJob (Maybe Text)
copyJob_resourceArn :: Lens' CopyJob (Maybe Text)
copyJob_resourceType :: Lens' CopyJob (Maybe Text)
copyJob_sourceBackupVaultArn :: Lens' CopyJob (Maybe Text)
copyJob_sourceRecoveryPointArn :: Lens' CopyJob (Maybe Text)
copyJob_state :: Lens' CopyJob (Maybe CopyJobState)
copyJob_statusMessage :: Lens' CopyJob (Maybe Text)

Documentation

data CopyJob Source #

Contains detailed information about a copy job.

See: newCopyJob smart constructor.

Constructors

CopyJob'

Fields

accountId :: Maybe Text
The account ID that owns the copy job.
backupSizeInBytes :: Maybe Integer
The size, in bytes, of a copy job.
childJobsInState :: Maybe (HashMap CopyJobState Integer)
This returns the statistics of the included child (nested) copy jobs.
completionDate :: Maybe POSIX
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
compositeMemberIdentifier :: Maybe Text
This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
copyJobId :: Maybe Text
Uniquely identifies a copy job.
createdBy :: Maybe RecoveryPointCreator
creationDate :: Maybe POSIX
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
destinationBackupVaultArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
destinationRecoveryPointArn :: Maybe Text
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
iamRoleArn :: Maybe Text
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
isParent :: Maybe Bool
This is a boolean value indicating this is a parent (composite) copy job.
numberOfChildJobs :: Maybe Integer
This is the number of child (nested) copy jobs.
parentJobId :: Maybe Text
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
resourceArn :: Maybe Text
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
resourceType :: Maybe Text
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
sourceBackupVaultArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
sourceRecoveryPointArn :: Maybe Text
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
state :: Maybe CopyJobState
The current state of a copy job.
statusMessage :: Maybe Text
A detailed message explaining the status of the job to copy a resource.

Instances

Instances details

FromJSON CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods parseJSON :: Value -> Parser CopyJob # parseJSONList :: Value -> Parser [CopyJob] #
Generic CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Associated Types type Rep CopyJob :: Type -> Type # Methods from :: CopyJob -> Rep CopyJob x # to :: Rep CopyJob x -> CopyJob #
Read CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods readsPrec :: Int -> ReadS CopyJob # readList :: ReadS [CopyJob] # readPrec :: ReadPrec CopyJob # readListPrec :: ReadPrec [CopyJob] #
Show CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods showsPrec :: Int -> CopyJob -> ShowS # show :: CopyJob -> String # showList :: [CopyJob] -> ShowS #
NFData CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods rnf :: CopyJob -> () #
Eq CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods (==) :: CopyJob -> CopyJob -> Bool # (/=) :: CopyJob -> CopyJob -> Bool #
Hashable CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob Methods hashWithSalt :: Int -> CopyJob -> Int # hash :: CopyJob -> Int #
type Rep CopyJob Source #
Instance details Defined in Amazonka.Backup.Types.CopyJob type Rep CopyJob = D1 ('MetaData "CopyJob" "Amazonka.Backup.Types.CopyJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "CopyJob'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backupSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "childJobsInState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap CopyJobState Integer))) :: (S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "compositeMemberIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "copyJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecoveryPointCreator))) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "destinationBackupVaultArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "destinationRecoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "isParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "numberOfChildJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "parentJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceBackupVaultArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceRecoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyJobState)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newCopyJob :: CopyJob Source #

Create a value of CopyJob 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:accountId:CopyJob', copyJob_accountId - The account ID that owns the copy job.

$sel:backupSizeInBytes:CopyJob', copyJob_backupSizeInBytes - The size, in bytes, of a copy job.

$sel:childJobsInState:CopyJob', copyJob_childJobsInState - This returns the statistics of the included child (nested) copy jobs.

$sel:completionDate:CopyJob', copyJob_completionDate - The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:compositeMemberIdentifier:CopyJob', copyJob_compositeMemberIdentifier - This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

$sel:copyJobId:CopyJob', copyJob_copyJobId - Uniquely identifies a copy job.

$sel:createdBy:CopyJob', copyJob_createdBy - Undocumented member.

$sel:creationDate:CopyJob', copyJob_creationDate - The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:destinationBackupVaultArn:CopyJob', copyJob_destinationBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

$sel:destinationRecoveryPointArn:CopyJob', copyJob_destinationRecoveryPointArn - An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:iamRoleArn:CopyJob', copyJob_iamRoleArn - Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

$sel:isParent:CopyJob', copyJob_isParent - This is a boolean value indicating this is a parent (composite) copy job.

$sel:numberOfChildJobs:CopyJob', copyJob_numberOfChildJobs - This is the number of child (nested) copy jobs.

$sel:parentJobId:CopyJob', copyJob_parentJobId - This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

$sel:resourceArn:CopyJob', copyJob_resourceArn - The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

$sel:resourceType:CopyJob', copyJob_resourceType - The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

$sel:sourceBackupVaultArn:CopyJob', copyJob_sourceBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

$sel:sourceRecoveryPointArn:CopyJob', copyJob_sourceRecoveryPointArn - An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:state:CopyJob', copyJob_state - The current state of a copy job.

$sel:statusMessage:CopyJob', copyJob_statusMessage - A detailed message explaining the status of the job to copy a resource.

copyJob_accountId :: Lens' CopyJob (Maybe Text) Source #

The account ID that owns the copy job.

copyJob_backupSizeInBytes :: Lens' CopyJob (Maybe Integer) Source #

The size, in bytes, of a copy job.

copyJob_childJobsInState :: Lens' CopyJob (Maybe (HashMap CopyJobState Integer)) Source #

This returns the statistics of the included child (nested) copy jobs.

copyJob_completionDate :: Lens' CopyJob (Maybe UTCTime) Source #

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

copyJob_compositeMemberIdentifier :: Lens' CopyJob (Maybe Text) Source #

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

copyJob_copyJobId :: Lens' CopyJob (Maybe Text) Source #

Uniquely identifies a copy job.

copyJob_createdBy :: Lens' CopyJob (Maybe RecoveryPointCreator) Source #

Undocumented member.

copyJob_creationDate :: Lens' CopyJob (Maybe UTCTime) Source #

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

copyJob_destinationBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

copyJob_destinationRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #

An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

copyJob_iamRoleArn :: Lens' CopyJob (Maybe Text) Source #

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

copyJob_isParent :: Lens' CopyJob (Maybe Bool) Source #

This is a boolean value indicating this is a parent (composite) copy job.

copyJob_numberOfChildJobs :: Lens' CopyJob (Maybe Integer) Source #

This is the number of child (nested) copy jobs.

copyJob_parentJobId :: Lens' CopyJob (Maybe Text) Source #

This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

copyJob_resourceArn :: Lens' CopyJob (Maybe Text) Source #

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

copyJob_resourceType :: Lens' CopyJob (Maybe Text) Source #

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

copyJob_sourceBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

copyJob_sourceRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #

An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

copyJob_state :: Lens' CopyJob (Maybe CopyJobState) Source #

The current state of a copy job.

copyJob_statusMessage :: Lens' CopyJob (Maybe Text) Source #

A detailed message explaining the status of the job to copy a resource.