Skip to content

/AWS1/CL_BUPGETBACKUPPLANOUT

GetBackupPlanOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

io_backupplan TYPE REF TO /AWS1/CL_BUPBACKUPPLAN /AWS1/CL_BUPBACKUPPLAN

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

iv_backupplanid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

Uniquely identifies a backup plan.

iv_backupplanarn TYPE /AWS1/BUPARN /AWS1/BUPARN

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.

iv_versionid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

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

iv_creatorrequestid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

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

iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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.

iv_deletiondate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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.

iv_lastexecutiondate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The last time this backup plan was run. 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.

it_advancedbackupsettings TYPE /AWS1/CL_BUPADVANCEDBACKUPSE00=>TT_ADVANCEDBACKUPSETTINGS TT_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.

it_scheduledrunspreview TYPE /AWS1/CL_BUPSCHDPLANEXEMEMBER=>TT_SCHEDULEDRUNSPREVIEW TT_SCHEDULEDRUNSPREVIEW

List of upcoming scheduled backup runs. Only included when MaxScheduledRunsPreview parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.

Queryable Attributes

BackupPlan

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

Accessible with the following methods

Method Description
GET_BACKUPPLAN() Getter for BACKUPPLAN

BackupPlanId

Uniquely identifies a backup plan.

Accessible with the following methods

Method Description
GET_BACKUPPLANID() Getter for BACKUPPLANID, with configurable default
ASK_BACKUPPLANID() Getter for BACKUPPLANID w/ exceptions if field has no value
HAS_BACKUPPLANID() Determine if BACKUPPLANID has a value

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.

Accessible with the following methods

Method Description
GET_BACKUPPLANARN() Getter for BACKUPPLANARN, with configurable default
ASK_BACKUPPLANARN() Getter for BACKUPPLANARN w/ exceptions if field has no value
HAS_BACKUPPLANARN() Determine if BACKUPPLANARN has a value

VersionId

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

Accessible with the following methods

Method Description
GET_VERSIONID() Getter for VERSIONID, with configurable default
ASK_VERSIONID() Getter for VERSIONID w/ exceptions if field has no value
HAS_VERSIONID() Determine if VERSIONID has a value

CreatorRequestId

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

Accessible with the following methods

Method Description
GET_CREATORREQUESTID() Getter for CREATORREQUESTID, with configurable default
ASK_CREATORREQUESTID() Getter for CREATORREQUESTID w/ exceptions if field has no va
HAS_CREATORREQUESTID() Determine if CREATORREQUESTID has a value

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.

Accessible with the following methods

Method Description
GET_CREATIONDATE() Getter for CREATIONDATE, with configurable default
ASK_CREATIONDATE() Getter for CREATIONDATE w/ exceptions if field has no value
HAS_CREATIONDATE() Determine if CREATIONDATE has a value

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.

Accessible with the following methods

Method Description
GET_DELETIONDATE() Getter for DELETIONDATE, with configurable default
ASK_DELETIONDATE() Getter for DELETIONDATE w/ exceptions if field has no value
HAS_DELETIONDATE() Determine if DELETIONDATE has a value

LastExecutionDate

The last time this backup plan was run. 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.

Accessible with the following methods

Method Description
GET_LASTEXECUTIONDATE() Getter for LASTEXECUTIONDATE, with configurable default
ASK_LASTEXECUTIONDATE() Getter for LASTEXECUTIONDATE w/ exceptions if field has no v
HAS_LASTEXECUTIONDATE() Determine if LASTEXECUTIONDATE has a value

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.

Accessible with the following methods

Method Description
GET_ADVANCEDBACKUPSETTINGS() Getter for ADVANCEDBACKUPSETTINGS, with configurable default
ASK_ADVANCEDBACKUPSETTINGS() Getter for ADVANCEDBACKUPSETTINGS w/ exceptions if field has
HAS_ADVANCEDBACKUPSETTINGS() Determine if ADVANCEDBACKUPSETTINGS has a value

ScheduledRunsPreview

List of upcoming scheduled backup runs. Only included when MaxScheduledRunsPreview parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.

Accessible with the following methods

Method Description
GET_SCHEDULEDRUNSPREVIEW() Getter for SCHEDULEDRUNSPREVIEW, with configurable default
ASK_SCHEDULEDRUNSPREVIEW() Getter for SCHEDULEDRUNSPREVIEW w/ exceptions if field has n
HAS_SCHEDULEDRUNSPREVIEW() Determine if SCHEDULEDRUNSPREVIEW has a value