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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Synopsis

data GetBackupPlan = GetBackupPlan' {
- versionId :: Maybe Text
- backupPlanId :: Text
}
newGetBackupPlan :: Text -> GetBackupPlan
getBackupPlan_versionId :: Lens' GetBackupPlan (Maybe Text)
getBackupPlan_backupPlanId :: Lens' GetBackupPlan Text
data GetBackupPlanResponse = GetBackupPlanResponse' {
- versionId :: Maybe Text
- advancedBackupSettings :: Maybe [AdvancedBackupSetting]
- backupPlanId :: Maybe Text
- creatorRequestId :: Maybe Text
- backupPlanArn :: Maybe Text
- lastExecutionDate :: Maybe POSIX
- backupPlan :: Maybe BackupPlan
- creationDate :: Maybe POSIX
- deletionDate :: Maybe POSIX
- httpStatus :: Int
}
newGetBackupPlanResponse :: Int -> GetBackupPlanResponse
getBackupPlanResponse_versionId :: Lens' GetBackupPlanResponse (Maybe Text)
getBackupPlanResponse_advancedBackupSettings :: Lens' GetBackupPlanResponse (Maybe [AdvancedBackupSetting])
getBackupPlanResponse_backupPlanId :: Lens' GetBackupPlanResponse (Maybe Text)
getBackupPlanResponse_creatorRequestId :: Lens' GetBackupPlanResponse (Maybe Text)
getBackupPlanResponse_backupPlanArn :: Lens' GetBackupPlanResponse (Maybe Text)
getBackupPlanResponse_lastExecutionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)
getBackupPlanResponse_backupPlan :: Lens' GetBackupPlanResponse (Maybe BackupPlan)
getBackupPlanResponse_creationDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)
getBackupPlanResponse_deletionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)
getBackupPlanResponse_httpStatus :: Lens' GetBackupPlanResponse Int

Creating a Request

data GetBackupPlan Source #

See: newGetBackupPlan smart constructor.

Constructors

GetBackupPlan'
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. backupPlanId :: Text Uniquely identifies a backup plan.

Instances

Instances details

Eq GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods (==) :: GetBackupPlan -> GetBackupPlan -> Bool # (/=) :: GetBackupPlan -> GetBackupPlan -> Bool #
Read GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods readsPrec :: Int -> ReadS GetBackupPlan # readList :: ReadS [GetBackupPlan] # readPrec :: ReadPrec GetBackupPlan # readListPrec :: ReadPrec [GetBackupPlan] #
Show GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods showsPrec :: Int -> GetBackupPlan -> ShowS # show :: GetBackupPlan -> String # showList :: [GetBackupPlan] -> ShowS #
Generic GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Associated Types type Rep GetBackupPlan :: Type -> Type # Methods from :: GetBackupPlan -> Rep GetBackupPlan x # to :: Rep GetBackupPlan x -> GetBackupPlan #
NFData GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods rnf :: GetBackupPlan -> () #
Hashable GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods hashWithSalt :: Int -> GetBackupPlan -> Int # hash :: GetBackupPlan -> Int #
AWSRequest GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Associated Types type AWSResponse GetBackupPlan # Methods request :: GetBackupPlan -> Request GetBackupPlan # response :: MonadResource m => Logger -> Service -> Proxy GetBackupPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBackupPlan))) #
ToHeaders GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods toHeaders :: GetBackupPlan -> [Header] #
ToPath GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods toPath :: GetBackupPlan -> ByteString #
ToQuery GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods toQuery :: GetBackupPlan -> QueryString #
type Rep GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan type Rep GetBackupPlan = D1 ('MetaData "GetBackupPlan" "Amazonka.Backup.GetBackupPlan" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "GetBackupPlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetBackupPlan Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan type AWSResponse GetBackupPlan = GetBackupPlanResponse

newGetBackupPlan Source #

Arguments

:: Text	`$sel:backupPlanId:GetBackupPlan'`
-> GetBackupPlan

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

$sel:backupPlanId:GetBackupPlan', getBackupPlan_backupPlanId - Uniquely identifies a backup plan.

Request Lenses

getBackupPlan_versionId :: Lens' GetBackupPlan (Maybe Text) Source #

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

getBackupPlan_backupPlanId :: Lens' GetBackupPlan Text Source #

Uniquely identifies a backup plan.

Destructuring the Response

data GetBackupPlanResponse Source #

See: newGetBackupPlanResponse smart constructor.

Constructors

GetBackupPlanResponse'

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. The list is populated only if the advanced option is set for the backup plan.
backupPlanId :: Maybe Text
Uniquely identifies a backup plan.
creatorRequestId :: Maybe Text
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
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.
lastExecutionDate :: Maybe POSIX
The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
backupPlan :: Maybe BackupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
creationDate :: Maybe POSIX
The date and time that 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.
deletionDate :: Maybe POSIX
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate 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 GetBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods (==) :: GetBackupPlanResponse -> GetBackupPlanResponse -> Bool # (/=) :: GetBackupPlanResponse -> GetBackupPlanResponse -> Bool #
Show GetBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods showsPrec :: Int -> GetBackupPlanResponse -> ShowS # show :: GetBackupPlanResponse -> String # showList :: [GetBackupPlanResponse] -> ShowS #
Generic GetBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Associated Types type Rep GetBackupPlanResponse :: Type -> Type # Methods from :: GetBackupPlanResponse -> Rep GetBackupPlanResponse x # to :: Rep GetBackupPlanResponse x -> GetBackupPlanResponse #
NFData GetBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan Methods rnf :: GetBackupPlanResponse -> () #
type Rep GetBackupPlanResponse Source #
Instance details Defined in Amazonka.Backup.GetBackupPlan type Rep GetBackupPlanResponse = D1 ('MetaData "GetBackupPlanResponse" "Amazonka.Backup.GetBackupPlan" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "GetBackupPlanResponse'" '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 "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backupPlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "backupPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupPlan))) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBackupPlanResponse Source #

Arguments

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

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

$sel:advancedBackupSettings:GetBackupPlanResponse', getBackupPlanResponse_advancedBackupSettings - Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

$sel:backupPlanId:GetBackupPlan', getBackupPlanResponse_backupPlanId - Uniquely identifies a backup plan.

$sel:creatorRequestId:GetBackupPlanResponse', getBackupPlanResponse_creatorRequestId - A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

$sel:backupPlanArn:GetBackupPlanResponse', getBackupPlanResponse_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:lastExecutionDate:GetBackupPlanResponse', getBackupPlanResponse_lastExecutionDate - The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

$sel:creationDate:GetBackupPlanResponse', getBackupPlanResponse_creationDate - The date and time that 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:deletionDate:GetBackupPlanResponse', getBackupPlanResponse_deletionDate - The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:httpStatus:GetBackupPlanResponse', getBackupPlanResponse_httpStatus - The response's http status code.

Response Lenses

getBackupPlanResponse_versionId :: Lens' GetBackupPlanResponse (Maybe Text) Source #

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

getBackupPlanResponse_advancedBackupSettings :: Lens' GetBackupPlanResponse (Maybe [AdvancedBackupSetting]) Source #

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

getBackupPlanResponse_backupPlanId :: Lens' GetBackupPlanResponse (Maybe Text) Source #

Uniquely identifies a backup plan.

getBackupPlanResponse_creatorRequestId :: Lens' GetBackupPlanResponse (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

getBackupPlanResponse_backupPlanArn :: Lens' GetBackupPlanResponse (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.

getBackupPlanResponse_lastExecutionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

getBackupPlanResponse_backupPlan :: Lens' GetBackupPlanResponse (Maybe BackupPlan) Source #

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

getBackupPlanResponse_creationDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

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

getBackupPlanResponse_deletionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime) Source #

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

getBackupPlanResponse_httpStatus :: Lens' GetBackupPlanResponse Int Source #

The response's http status code.