/AWS1/CL_BUPDESCRRESTOREJOBOUT

DescribeRestoreJobOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_accountid TYPE /AWS1/BUPACCOUNTID /AWS1/BUPACCOUNTID

Returns the account ID that owns the restore job.

iv_restorejobid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

Uniquely identifies the job that restores a recovery point.

iv_recoverypointarn TYPE /AWS1/BUPARN /AWS1/BUPARN

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

iv_sourceresourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN

The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.

iv_backupvaultarn TYPE /AWS1/BUPARN /AWS1/BUPARN

The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.

iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_completiondate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

iv_status TYPE /AWS1/BUPRESTOREJOBSTATUS /AWS1/BUPRESTOREJOBSTATUS

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

iv_statusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

A message showing the status of a job to restore a recovery point.

iv_percentdone TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

Contains an estimated percentage that is complete of a job at the time the job status was queried.

iv_backupsizeinbytes TYPE /AWS1/BUPLONG /AWS1/BUPLONG

The size, in bytes, of the restored resource.

iv_iamrolearn TYPE /AWS1/BUPIAMROLEARN /AWS1/BUPIAMROLEARN

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

iv_expectedcompletiontimem00 TYPE /AWS1/BUPLONG /AWS1/BUPLONG

The amount of time in minutes that a job restoring a recovery point is expected to take.

iv_createdresourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN

The Amazon Resource Name (ARN) of the resource that was created by the restore job.

The format of the ARN depends on the resource type of the backed-up resource.

iv_resourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE

Returns metadata associated with a restore job listed by resource type.

iv_recoverypointcreationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The creation date of the recovery point made by the specifed restore job.

io_createdby TYPE REF TO /AWS1/CL_BUPRESTOREJOBCREATOR /AWS1/CL_BUPRESTOREJOBCREATOR

Contains identifying information about the creation of a restore job.

iv_validationstatus TYPE /AWS1/BUPRESTOREVALIDATIONSTAT /AWS1/BUPRESTOREVALIDATIONSTAT

The status of validation run on the indicated restore job.

iv_validationstatusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

The status message.

iv_deletionstatus TYPE /AWS1/BUPRESTOREDELETIONSTATUS /AWS1/BUPRESTOREDELETIONSTATUS

The status of the data generated by the restore test.

iv_deletionstatusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

This describes the restore job deletion status.

iv_isparent TYPE /AWS1/BUPBOOLEAN2 /AWS1/BUPBOOLEAN2

This is a boolean value indicating whether the restore job is a parent (composite) restore job.

iv_parentjobid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

This is the unique identifier of the parent restore job for the selected restore job.

---

Queryable Attributes

AccountId

Returns the account ID that owns the restore job.

Accessible with the following methods

Method	Description
GET_ACCOUNTID()	Getter for ACCOUNTID, with configurable default
ASK_ACCOUNTID()	Getter for ACCOUNTID w/ exceptions if field has no value
HAS_ACCOUNTID()	Determine if ACCOUNTID has a value

RestoreJobId

Uniquely identifies the job that restores a recovery point.

Accessible with the following methods

Method	Description
GET_RESTOREJOBID()	Getter for RESTOREJOBID, with configurable default
ASK_RESTOREJOBID()	Getter for RESTOREJOBID w/ exceptions if field has no value
HAS_RESTOREJOBID()	Determine if RESTOREJOBID has a value

RecoveryPointArn

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

Accessible with the following methods

Method	Description
GET_RECOVERYPOINTARN()	Getter for RECOVERYPOINTARN, with configurable default
ASK_RECOVERYPOINTARN()	Getter for RECOVERYPOINTARN w/ exceptions if field has no va
HAS_RECOVERYPOINTARN()	Determine if RECOVERYPOINTARN has a value

SourceResourceArn

The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.

Accessible with the following methods

Method	Description
GET_SOURCERESOURCEARN()	Getter for SOURCERESOURCEARN, with configurable default
ASK_SOURCERESOURCEARN()	Getter for SOURCERESOURCEARN w/ exceptions if field has no v
HAS_SOURCERESOURCEARN()	Determine if SOURCERESOURCEARN has a value

BackupVaultArn

The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.

Accessible with the following methods

Method	Description
GET_BACKUPVAULTARN()	Getter for BACKUPVAULTARN, with configurable default
ASK_BACKUPVAULTARN()	Getter for BACKUPVAULTARN w/ exceptions if field has no valu
HAS_BACKUPVAULTARN()	Determine if BACKUPVAULTARN has a value

CreationDate

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

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

CompletionDate

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate 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_COMPLETIONDATE()	Getter for COMPLETIONDATE, with configurable default
ASK_COMPLETIONDATE()	Getter for COMPLETIONDATE w/ exceptions if field has no valu
HAS_COMPLETIONDATE()	Determine if COMPLETIONDATE has a value

Status

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

StatusMessage

A message showing the status of a job to restore a recovery point.

Accessible with the following methods

Method	Description
GET_STATUSMESSAGE()	Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE()	Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE()	Determine if STATUSMESSAGE has a value

PercentDone

Contains an estimated percentage that is complete of a job at the time the job status was queried.

Accessible with the following methods

Method	Description
GET_PERCENTDONE()	Getter for PERCENTDONE, with configurable default
ASK_PERCENTDONE()	Getter for PERCENTDONE w/ exceptions if field has no value
HAS_PERCENTDONE()	Determine if PERCENTDONE has a value

BackupSizeInBytes

The size, in bytes, of the restored resource.

Accessible with the following methods

Method	Description
GET_BACKUPSIZEINBYTES()	Getter for BACKUPSIZEINBYTES, with configurable default
ASK_BACKUPSIZEINBYTES()	Getter for BACKUPSIZEINBYTES w/ exceptions if field has no v
HAS_BACKUPSIZEINBYTES()	Determine if BACKUPSIZEINBYTES has a value

IamRoleArn

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

Accessible with the following methods

Method	Description
GET_IAMROLEARN()	Getter for IAMROLEARN, with configurable default
ASK_IAMROLEARN()	Getter for IAMROLEARN w/ exceptions if field has no value
HAS_IAMROLEARN()	Determine if IAMROLEARN has a value

ExpectedCompletionTimeMinutes

The amount of time in minutes that a job restoring a recovery point is expected to take.

Accessible with the following methods

Method	Description
GET_EXPECTEDCOMPLETIONTIME00()	Getter for EXPECTEDCOMPLETIONTIMEMINS, with configurable def
ASK_EXPECTEDCOMPLETIONTIME00()	Getter for EXPECTEDCOMPLETIONTIMEMINS w/ exceptions if field
HAS_EXPECTEDCOMPLETIONTIME00()	Determine if EXPECTEDCOMPLETIONTIMEMINS has a value

CreatedResourceArn

The Amazon Resource Name (ARN) of the resource that was created by the restore job.

The format of the ARN depends on the resource type of the backed-up resource.

Accessible with the following methods

Method	Description
GET_CREATEDRESOURCEARN()	Getter for CREATEDRESOURCEARN, with configurable default
ASK_CREATEDRESOURCEARN()	Getter for CREATEDRESOURCEARN w/ exceptions if field has no
HAS_CREATEDRESOURCEARN()	Determine if CREATEDRESOURCEARN has a value

ResourceType

Returns metadata associated with a restore job listed by resource type.

Accessible with the following methods

Method	Description
GET_RESOURCETYPE()	Getter for RESOURCETYPE, with configurable default
ASK_RESOURCETYPE()	Getter for RESOURCETYPE w/ exceptions if field has no value
HAS_RESOURCETYPE()	Determine if RESOURCETYPE has a value

RecoveryPointCreationDate

The creation date of the recovery point made by the specifed restore job.

Accessible with the following methods

Method	Description
GET_RECPOINTCREATIONDATE()	Getter for RECOVERYPOINTCREATIONDATE, with configurable defa
ASK_RECPOINTCREATIONDATE()	Getter for RECOVERYPOINTCREATIONDATE w/ exceptions if field
HAS_RECPOINTCREATIONDATE()	Determine if RECOVERYPOINTCREATIONDATE has a value

CreatedBy

Contains identifying information about the creation of a restore job.

Accessible with the following methods

Method	Description
GET_CREATEDBY()	Getter for CREATEDBY

ValidationStatus

The status of validation run on the indicated restore job.

Accessible with the following methods

Method	Description
GET_VALIDATIONSTATUS()	Getter for VALIDATIONSTATUS, with configurable default
ASK_VALIDATIONSTATUS()	Getter for VALIDATIONSTATUS w/ exceptions if field has no va
HAS_VALIDATIONSTATUS()	Determine if VALIDATIONSTATUS has a value

ValidationStatusMessage

The status message.

Accessible with the following methods

Method	Description
GET_VALIDATIONSTATUSMESSAGE()	Getter for VALIDATIONSTATUSMESSAGE, with configurable defaul
ASK_VALIDATIONSTATUSMESSAGE()	Getter for VALIDATIONSTATUSMESSAGE w/ exceptions if field ha
HAS_VALIDATIONSTATUSMESSAGE()	Determine if VALIDATIONSTATUSMESSAGE has a value

DeletionStatus

The status of the data generated by the restore test.

Accessible with the following methods

Method	Description
GET_DELETIONSTATUS()	Getter for DELETIONSTATUS, with configurable default
ASK_DELETIONSTATUS()	Getter for DELETIONSTATUS w/ exceptions if field has no valu
HAS_DELETIONSTATUS()	Determine if DELETIONSTATUS has a value

DeletionStatusMessage

This describes the restore job deletion status.

Accessible with the following methods

Method	Description
GET_DELETIONSTATUSMESSAGE()	Getter for DELETIONSTATUSMESSAGE, with configurable default
ASK_DELETIONSTATUSMESSAGE()	Getter for DELETIONSTATUSMESSAGE w/ exceptions if field has
HAS_DELETIONSTATUSMESSAGE()	Determine if DELETIONSTATUSMESSAGE has a value

IsParent

This is a boolean value indicating whether the restore job is a parent (composite) restore job.

Accessible with the following methods

Method	Description
GET_ISPARENT()	Getter for ISPARENT

ParentJobId

This is the unique identifier of the parent restore job for the selected restore job.

Accessible with the following methods

Method	Description
GET_PARENTJOBID()	Getter for PARENTJOBID, with configurable default
ASK_PARENTJOBID()	Getter for PARENTJOBID w/ exceptions if field has no value
HAS_PARENTJOBID()	Determine if PARENTJOBID has a value