Amazonka.Backup.GetBackupPlan

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

Creating a Request

data GetBackupPlan

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

ToHeaders GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

toHeaders :: GetBackupPlan -> [Header]

ToPath GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

toPath :: GetBackupPlan -> ByteString

ToQuery GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

toQuery :: GetBackupPlan -> QueryString

AWSRequest GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Associated Types

type AWSResponse GetBackupPlan

Methods

request :: (Service -> Service) -> GetBackupPlan -> Request GetBackupPlan

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBackupPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBackupPlan)))

Generic GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Associated Types

type Rep GetBackupPlan :: Type -> Type

Methods

from :: GetBackupPlan -> Rep GetBackupPlan x

to :: Rep GetBackupPlan x -> GetBackupPlan

Read GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

readsPrec :: Int -> ReadS GetBackupPlan

readList :: ReadS [GetBackupPlan]

readPrec :: ReadPrec GetBackupPlan

readListPrec :: ReadPrec [GetBackupPlan]

Show GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

showsPrec :: Int -> GetBackupPlan -> ShowS

show :: GetBackupPlan -> String

showList :: [GetBackupPlan] -> ShowS

NFData GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

rnf :: GetBackupPlan -> ()

Eq GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

(==) :: GetBackupPlan -> GetBackupPlan -> Bool

(/=) :: GetBackupPlan -> GetBackupPlan -> Bool

Hashable GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

Methods

hashWithSalt :: Int -> GetBackupPlan -> Int

hash :: GetBackupPlan -> Int

type AWSResponse GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

type AWSResponse GetBackupPlan = GetBackupPlanResponse

type Rep GetBackupPlan

Defined in Amazonka.Backup.GetBackupPlan

type Rep GetBackupPlan = D1 ('MetaData "GetBackupPlan" "Amazonka.Backup.GetBackupPlan" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" '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)))

newGetBackupPlan

Arguments

:: Text

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:

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

GetBackupPlan, getBackupPlan_backupPlanId - Uniquely identifies a backup plan.

Request Lenses

getBackupPlan_versionId :: Lens' GetBackupPlan (Maybe Text)

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

Uniquely identifies a backup plan.

Destructuring the Response

data GetBackupPlanResponse

See: newGetBackupPlanResponse smart constructor.

Constructors

GetBackupPlanResponse'

Fields

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

• backupPlan :: Maybe BackupPlan

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

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

• backupPlanId :: Maybe Text

  Uniquely identifies a backup plan.

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

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

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

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

• versionId :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBackupPlanResponse

Defined in Amazonka.Backup.GetBackupPlan

Associated Types

type Rep GetBackupPlanResponse :: Type -> Type

Methods

from :: GetBackupPlanResponse -> Rep GetBackupPlanResponse x

to :: Rep GetBackupPlanResponse x -> GetBackupPlanResponse

Show GetBackupPlanResponse

Defined in Amazonka.Backup.GetBackupPlan

Methods

showsPrec :: Int -> GetBackupPlanResponse -> ShowS

show :: GetBackupPlanResponse -> String

showList :: [GetBackupPlanResponse] -> ShowS

NFData GetBackupPlanResponse

Defined in Amazonka.Backup.GetBackupPlan

Methods

rnf :: GetBackupPlanResponse -> ()

Eq GetBackupPlanResponse

Defined in Amazonka.Backup.GetBackupPlan

Methods

(==) :: GetBackupPlanResponse -> GetBackupPlanResponse -> Bool

(/=) :: GetBackupPlanResponse -> GetBackupPlanResponse -> Bool

type Rep GetBackupPlanResponse

Defined in Amazonka.Backup.GetBackupPlan

type Rep GetBackupPlanResponse = D1 ('MetaData "GetBackupPlanResponse" "Amazonka.Backup.GetBackupPlan" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "GetBackupPlanResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "advancedBackupSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedBackupSetting])) :*: S1 ('MetaSel ('Just "backupPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupPlan))) :*: (S1 ('MetaSel ('Just "backupPlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backupPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lastExecutionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBackupPlanResponse

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:

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:backupPlan:GetBackupPlanResponse', getBackupPlanResponse_backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

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.

GetBackupPlan, getBackupPlanResponse_backupPlanId - Uniquely identifies a backup plan.

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.

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.

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.

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.

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:httpStatus:GetBackupPlanResponse', getBackupPlanResponse_httpStatus - The response's http status code.

Response Lenses

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

getBackupPlanResponse_backupPlan :: Lens' GetBackupPlanResponse (Maybe BackupPlan)

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

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

getBackupPlanResponse_backupPlanId :: Lens' GetBackupPlanResponse (Maybe Text)

Uniquely identifies a backup plan.

getBackupPlanResponse_creationDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)

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_creatorRequestId :: Lens' GetBackupPlanResponse (Maybe Text)

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

getBackupPlanResponse_deletionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)

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_lastExecutionDate :: Lens' GetBackupPlanResponse (Maybe UTCTime)

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_versionId :: Lens' GetBackupPlanResponse (Maybe Text)

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

getBackupPlanResponse_httpStatus :: Lens' GetBackupPlanResponse Int

The response's http status code.