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.StartCopyJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Synopsis

data StartCopyJob = StartCopyJob' {
- idempotencyToken :: Maybe Text
- lifecycle :: Maybe Lifecycle
- recoveryPointArn :: Text
- sourceBackupVaultName :: Text
- destinationBackupVaultArn :: Text
- iamRoleArn :: Text
}
newStartCopyJob :: Text -> Text -> Text -> Text -> StartCopyJob
startCopyJob_idempotencyToken :: Lens' StartCopyJob (Maybe Text)
startCopyJob_lifecycle :: Lens' StartCopyJob (Maybe Lifecycle)
startCopyJob_recoveryPointArn :: Lens' StartCopyJob Text
startCopyJob_sourceBackupVaultName :: Lens' StartCopyJob Text
startCopyJob_destinationBackupVaultArn :: Lens' StartCopyJob Text
startCopyJob_iamRoleArn :: Lens' StartCopyJob Text
data StartCopyJobResponse = StartCopyJobResponse' {
- copyJobId :: Maybe Text
- creationDate :: Maybe POSIX
- isParent :: Maybe Bool
- httpStatus :: Int
}
newStartCopyJobResponse :: Int -> StartCopyJobResponse
startCopyJobResponse_copyJobId :: Lens' StartCopyJobResponse (Maybe Text)
startCopyJobResponse_creationDate :: Lens' StartCopyJobResponse (Maybe UTCTime)
startCopyJobResponse_isParent :: Lens' StartCopyJobResponse (Maybe Bool)
startCopyJobResponse_httpStatus :: Lens' StartCopyJobResponse Int

Creating a Request

data StartCopyJob Source #

See: newStartCopyJob smart constructor.

Constructors

StartCopyJob'

Fields

idempotencyToken :: Maybe Text
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
lifecycle :: Maybe Lifecycle
recoveryPointArn :: Text
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
sourceBackupVaultName :: Text
The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
destinationBackupVaultArn :: Text
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
iamRoleArn :: Text
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Instances

Instances details

ToJSON StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods toJSON :: StartCopyJob -> Value # toEncoding :: StartCopyJob -> Encoding # toJSONList :: [StartCopyJob] -> Value # toEncodingList :: [StartCopyJob] -> Encoding #
ToHeaders StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods toHeaders :: StartCopyJob -> [Header] #
ToPath StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods toPath :: StartCopyJob -> ByteString #
ToQuery StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods toQuery :: StartCopyJob -> QueryString #
AWSRequest StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Associated Types type AWSResponse StartCopyJob # Methods request :: (Service -> Service) -> StartCopyJob -> Request StartCopyJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartCopyJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartCopyJob))) #
Generic StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Associated Types type Rep StartCopyJob :: Type -> Type # Methods from :: StartCopyJob -> Rep StartCopyJob x # to :: Rep StartCopyJob x -> StartCopyJob #
Read StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods readsPrec :: Int -> ReadS StartCopyJob # readList :: ReadS [StartCopyJob] # readPrec :: ReadPrec StartCopyJob # readListPrec :: ReadPrec [StartCopyJob] #
Show StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods showsPrec :: Int -> StartCopyJob -> ShowS # show :: StartCopyJob -> String # showList :: [StartCopyJob] -> ShowS #
NFData StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods rnf :: StartCopyJob -> () #
Eq StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods (==) :: StartCopyJob -> StartCopyJob -> Bool # (/=) :: StartCopyJob -> StartCopyJob -> Bool #
Hashable StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods hashWithSalt :: Int -> StartCopyJob -> Int # hash :: StartCopyJob -> Int #
type AWSResponse StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob type AWSResponse StartCopyJob = StartCopyJobResponse
type Rep StartCopyJob Source #
Instance details Defined in Amazonka.Backup.StartCopyJob type Rep StartCopyJob = D1 ('MetaData "StartCopyJob" "Amazonka.Backup.StartCopyJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "StartCopyJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Lifecycle)) :: S1 ('MetaSel ('Just "recoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "sourceBackupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "destinationBackupVaultArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartCopyJob Source #

Arguments

:: Text	`StartCopyJob`
-> Text	`$sel:sourceBackupVaultName:StartCopyJob'`
-> Text	`StartCopyJob`
-> Text	`StartCopyJob`
-> StartCopyJob

Create a value of StartCopyJob 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:idempotencyToken:StartCopyJob', startCopyJob_idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

StartCopyJob, startCopyJob_lifecycle - Undocumented member.

StartCopyJob, startCopyJob_recoveryPointArn - An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:sourceBackupVaultName:StartCopyJob', startCopyJob_sourceBackupVaultName - The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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

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

Request Lenses

startCopyJob_idempotencyToken :: Lens' StartCopyJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startCopyJob_lifecycle :: Lens' StartCopyJob (Maybe Lifecycle) Source #

Undocumented member.

startCopyJob_recoveryPointArn :: Lens' StartCopyJob Text Source #

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

startCopyJob_sourceBackupVaultName :: Lens' StartCopyJob Text Source #

The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

startCopyJob_destinationBackupVaultArn :: Lens' StartCopyJob Text Source #

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

startCopyJob_iamRoleArn :: Lens' StartCopyJob Text Source #

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

Destructuring the Response

data StartCopyJobResponse Source #

See: newStartCopyJobResponse smart constructor.

Constructors

StartCopyJobResponse'

Fields

copyJobId :: Maybe Text
Uniquely identifies a copy job.
creationDate :: Maybe POSIX
The date and time that 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.
isParent :: Maybe Bool
This is a returned boolean value indicating this is a parent (composite) copy job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Associated Types type Rep StartCopyJobResponse :: Type -> Type # Methods from :: StartCopyJobResponse -> Rep StartCopyJobResponse x # to :: Rep StartCopyJobResponse x -> StartCopyJobResponse #
Read StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods readsPrec :: Int -> ReadS StartCopyJobResponse # readList :: ReadS [StartCopyJobResponse] # readPrec :: ReadPrec StartCopyJobResponse # readListPrec :: ReadPrec [StartCopyJobResponse] #
Show StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods showsPrec :: Int -> StartCopyJobResponse -> ShowS # show :: StartCopyJobResponse -> String # showList :: [StartCopyJobResponse] -> ShowS #
NFData StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods rnf :: StartCopyJobResponse -> () #
Eq StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob Methods (==) :: StartCopyJobResponse -> StartCopyJobResponse -> Bool # (/=) :: StartCopyJobResponse -> StartCopyJobResponse -> Bool #
type Rep StartCopyJobResponse Source #
Instance details Defined in Amazonka.Backup.StartCopyJob type Rep StartCopyJobResponse = D1 ('MetaData "StartCopyJobResponse" "Amazonka.Backup.StartCopyJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "StartCopyJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "isParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartCopyJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartCopyJobResponse'`
-> StartCopyJobResponse

Create a value of StartCopyJobResponse 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:

StartCopyJobResponse, startCopyJobResponse_copyJobId - Uniquely identifies a copy job.

StartCopyJobResponse, startCopyJobResponse_creationDate - The date and time that 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.

StartCopyJobResponse, startCopyJobResponse_isParent - This is a returned boolean value indicating this is a parent (composite) copy job.

$sel:httpStatus:StartCopyJobResponse', startCopyJobResponse_httpStatus - The response's http status code.

Response Lenses

startCopyJobResponse_copyJobId :: Lens' StartCopyJobResponse (Maybe Text) Source #

Uniquely identifies a copy job.

startCopyJobResponse_creationDate :: Lens' StartCopyJobResponse (Maybe UTCTime) Source #

The date and time that 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.

startCopyJobResponse_isParent :: Lens' StartCopyJobResponse (Maybe Bool) Source #

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

startCopyJobResponse_httpStatus :: Lens' StartCopyJobResponse Int Source #

The response's http status code.