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.Backup.UpdateBackupPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Synopsis

data UpdateBackupPlan = UpdateBackupPlan' {
- backupPlanId :: Text
- backupPlan :: BackupPlanInput
}
newUpdateBackupPlan :: Text -> BackupPlanInput -> UpdateBackupPlan
updateBackupPlan_backupPlanId :: Lens' UpdateBackupPlan Text
updateBackupPlan_backupPlan :: Lens' UpdateBackupPlan BackupPlanInput
data UpdateBackupPlanResponse = UpdateBackupPlanResponse' {
- versionId :: Maybe Text
- advancedBackupSettings :: Maybe [AdvancedBackupSetting]
- backupPlanId :: Maybe Text
- backupPlanArn :: Maybe Text
- creationDate :: Maybe POSIX
- httpStatus :: Int
}
newUpdateBackupPlanResponse :: Int -> UpdateBackupPlanResponse
updateBackupPlanResponse_versionId :: Lens' UpdateBackupPlanResponse (Maybe Text)
updateBackupPlanResponse_advancedBackupSettings :: Lens' UpdateBackupPlanResponse (Maybe [AdvancedBackupSetting])
updateBackupPlanResponse_backupPlanId :: Lens' UpdateBackupPlanResponse (Maybe Text)
updateBackupPlanResponse_backupPlanArn :: Lens' UpdateBackupPlanResponse (Maybe Text)
updateBackupPlanResponse_creationDate :: Lens' UpdateBackupPlanResponse (Maybe UTCTime)
updateBackupPlanResponse_httpStatus :: Lens' UpdateBackupPlanResponse Int

Creating a Request

data UpdateBackupPlan Source #

See: newUpdateBackupPlan smart constructor.

Constructors

UpdateBackupPlan'
Fields backupPlanId :: Text Uniquely identifies a backup plan. backupPlan :: BackupPlanInput Specifies the body of a backup plan. Includes a `BackupPlanName` and one or more sets of `Rules`.

Instances

Instances details

Eq UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods (==) :: UpdateBackupPlan -> UpdateBackupPlan -> Bool # (/=) :: UpdateBackupPlan -> UpdateBackupPlan -> Bool #
Show UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods showsPrec :: Int -> UpdateBackupPlan -> ShowS # show :: UpdateBackupPlan -> String # showList :: [UpdateBackupPlan] -> ShowS #
Generic UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Associated Types type Rep UpdateBackupPlan :: Type -> Type # Methods from :: UpdateBackupPlan -> Rep UpdateBackupPlan x # to :: Rep UpdateBackupPlan x -> UpdateBackupPlan #
NFData UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods rnf :: UpdateBackupPlan -> () #
Hashable UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods hashWithSalt :: Int -> UpdateBackupPlan -> Int # hash :: UpdateBackupPlan -> Int #
ToJSON UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods toJSON :: UpdateBackupPlan -> Value # toEncoding :: UpdateBackupPlan -> Encoding # toJSONList :: [UpdateBackupPlan] -> Value # toEncodingList :: [UpdateBackupPlan] -> Encoding #
AWSRequest UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Associated Types type AWSResponse UpdateBackupPlan # Methods request :: UpdateBackupPlan -> Request UpdateBackupPlan # response :: MonadResource m => Logger -> Service -> Proxy UpdateBackupPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateBackupPlan))) #
ToHeaders UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods toHeaders :: UpdateBackupPlan -> [Header] #
ToPath UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods toPath :: UpdateBackupPlan -> ByteString #
ToQuery UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan Methods toQuery :: UpdateBackupPlan -> QueryString #
type Rep UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan type Rep UpdateBackupPlan = D1 ('MetaData "UpdateBackupPlan" "Amazonka.Backup.UpdateBackupPlan" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "UpdateBackupPlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "backupPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupPlanInput)))
type AWSResponse UpdateBackupPlan Source #
Instance details Defined in Amazonka.Backup.UpdateBackupPlan type AWSResponse UpdateBackupPlan = UpdateBackupPlanResponse

newUpdateBackupPlan Source #

Arguments

:: Text	`$sel:backupPlanId:UpdateBackupPlan'`
-> BackupPlanInput	`$sel:backupPlan:UpdateBackupPlan'`
-> UpdateBackupPlan

Create a value of UpdateBackupPlan 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:backupPlanId:UpdateBackupPlan', updateBackupPlan_backupPlanId - Uniquely identifies a backup plan.

$sel:backupPlan:UpdateBackupPlan', updateBackupPlan_backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Request Lenses

updateBackupPlan_backupPlanId :: Lens' UpdateBackupPlan Text Source #

Uniquely identifies a backup plan.

updateBackupPlan_backupPlan :: Lens' UpdateBackupPlan BackupPlanInput Source #

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Destructuring the Response

data UpdateBackupPlanResponse Source #

See: newUpdateBackupPlanResponse smart constructor.

Constructors

UpdateBackupPlanResponse'

Fields

versionId :: Maybe Text
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
advancedBackupSettings :: Maybe [AdvancedBackupSetting]
Contains a list of BackupOptions for each resource type.
backupPlanId :: Maybe Text
Uniquely identifies a backup plan.
backupPlanArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
creationDate :: Maybe POSIX
The date and time a backup plan 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateBackupPlanResponse Source #

Arguments

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

Create a value of UpdateBackupPlanResponse 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:versionId:UpdateBackupPlanResponse', updateBackupPlanResponse_versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

$sel:advancedBackupSettings:UpdateBackupPlanResponse', updateBackupPlanResponse_advancedBackupSettings - Contains a list of BackupOptions for each resource type.

$sel:backupPlanId:UpdateBackupPlan', updateBackupPlanResponse_backupPlanId - Uniquely identifies a backup plan.

$sel:backupPlanArn:UpdateBackupPlanResponse', updateBackupPlanResponse_backupPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

$sel:creationDate:UpdateBackupPlanResponse', updateBackupPlanResponse_creationDate - The date and time a backup plan 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:httpStatus:UpdateBackupPlanResponse', updateBackupPlanResponse_httpStatus - The response's http status code.

Response Lenses

updateBackupPlanResponse_versionId :: Lens' UpdateBackupPlanResponse (Maybe Text) Source #

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

updateBackupPlanResponse_advancedBackupSettings :: Lens' UpdateBackupPlanResponse (Maybe [AdvancedBackupSetting]) Source #

Contains a list of BackupOptions for each resource type.

updateBackupPlanResponse_backupPlanId :: Lens' UpdateBackupPlanResponse (Maybe Text) Source #

Uniquely identifies a backup plan.

updateBackupPlanResponse_backupPlanArn :: Lens' UpdateBackupPlanResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

updateBackupPlanResponse_creationDate :: Lens' UpdateBackupPlanResponse (Maybe UTCTime) Source #

The date and time a backup plan 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.

updateBackupPlanResponse_httpStatus :: Lens' UpdateBackupPlanResponse Int Source #

The response's http status code.