/AWS1/CL_BUPDESCRBACKUPJOBOUT¶
DescribeBackupJobOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_accountid TYPE /AWS1/BUPACCOUNTID /AWS1/BUPACCOUNTID¶
Returns the account ID that owns the backup job.
iv_backupjobid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
Uniquely identifies a request to Backup to back up a resource.
iv_backupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME¶
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
iv_backupvaultarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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_resourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis 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 create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
iv_state TYPE /AWS1/BUPBACKUPJOBSTATE /AWS1/BUPBACKUPJOBSTATE¶
The current state of a backup job.
iv_statusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
A detailed message explaining the status of the job to back up a resource.
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 a backup (recovery point).
This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of
0, which may differ from the anticipated value.The expected behavior for values by resource type are described as follows:
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation
GetBackupJobStatus.For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
Amazon FSx does not populate this value from the operation
GetBackupJobStatusfor FSx file systems.An Amazon RDS instance will show as
0.For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
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.
io_createdby TYPE REF TO /AWS1/CL_BUPRECPOINTCREATOR /AWS1/CL_BUPRECPOINTCREATOR¶
Contains identifying information about the creation of a backup job, including the
BackupPlanArn,BackupPlanId,BackupPlanVersion, andBackupRuleIdof the backup plan that is used to create it.
iv_resourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE¶
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
iv_bytestransferred TYPE /AWS1/BUPLONG /AWS1/BUPLONG¶
The size in bytes transferred to a backup vault at the time that the job status was queried.
iv_expectedcompletiondate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of
ExpectedCompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
iv_startby TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the
StartBytime would be 8:00 PM on the date specified. The value ofStartByis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
it_backupoptions TYPE /AWS1/CL_BUPBACKUPOPTIONS_W=>TT_BACKUPOPTIONS TT_BACKUPOPTIONS¶
Represents the options specified as part of backup plan or on-demand backup job.
iv_backuptype TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken,
BackupTypereturns"WindowsVSS". IfBackupTypeis empty, then the backup type was a regular backup.
iv_parentjobid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
This returns the parent (composite) resource backup job ID.
iv_isparent TYPE /AWS1/BUPBOOLEAN2 /AWS1/BUPBOOLEAN2¶
This returns the boolean value that a backup job is a parent (composite) job.
iv_numberofchildjobs TYPE /AWS1/BUPLONG /AWS1/BUPLONG¶
This returns the number of child (nested) backup jobs.
it_childjobsinstate TYPE /AWS1/CL_BUPBACKUPJOBCHILDJO00=>TT_BACKUPJOBCHILDJOBSINSTATE TT_BACKUPJOBCHILDJOBSINSTATE¶
This returns the statistics of the included child (nested) backup jobs.
iv_resourcename TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The non-unique name of the resource that belongs to the specified backup.
iv_initiationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date a backup job was initiated.
iv_messagecategory TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The job count for the specified message category.
Example strings may include
AccessDenied,SUCCESS,AGGREGATE_ALL, andINVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
Queryable Attributes¶
AccountId¶
Returns the account ID that owns the backup 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 |
BackupJobId¶
Uniquely identifies a request to Backup to back up a resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPJOBID() |
Getter for BACKUPJOBID, with configurable default |
ASK_BACKUPJOBID() |
Getter for BACKUPJOBID w/ exceptions if field has no value |
HAS_BACKUPJOBID() |
Determine if BACKUPJOBID has a value |
BackupVaultName¶
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPVAULTNAME() |
Getter for BACKUPVAULTNAME, with configurable default |
ASK_BACKUPVAULTNAME() |
Getter for BACKUPVAULTNAME w/ exceptions if field has no val |
HAS_BACKUPVAULTNAME() |
Determine if BACKUPVAULTNAME has a value |
BackupVaultArn¶
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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 |
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 |
ResourceArn¶
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARN() |
Getter for RESOURCEARN, with configurable default |
ASK_RESOURCEARN() |
Getter for RESOURCEARN w/ exceptions if field has no value |
HAS_RESOURCEARN() |
Determine if RESOURCEARN has a value |
CreationDate¶
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis 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 create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDateis 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 |
State¶
The current state of a backup job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
StatusMessage¶
A detailed message explaining the status of the job to back up a resource.
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 a backup (recovery point).
This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of
0, which may differ from the anticipated value.The expected behavior for values by resource type are described as follows:
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation
GetBackupJobStatus.For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
Amazon FSx does not populate this value from the operation
GetBackupJobStatusfor FSx file systems.An Amazon RDS instance will show as
0.For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
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 |
CreatedBy¶
Contains identifying information about the creation of a backup job, including the
BackupPlanArn,BackupPlanId,BackupPlanVersion, andBackupRuleIdof the backup plan that is used to create it.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDBY() |
Getter for CREATEDBY |
ResourceType¶
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
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 |
BytesTransferred¶
The size in bytes transferred to a backup vault at the time that the job status was queried.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BYTESTRANSFERRED() |
Getter for BYTESTRANSFERRED, with configurable default |
ASK_BYTESTRANSFERRED() |
Getter for BYTESTRANSFERRED w/ exceptions if field has no va |
HAS_BYTESTRANSFERRED() |
Determine if BYTESTRANSFERRED has a value |
ExpectedCompletionDate¶
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of
ExpectedCompletionDateis 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_EXPECTEDCOMPLETIONDATE() |
Getter for EXPECTEDCOMPLETIONDATE, with configurable default |
ASK_EXPECTEDCOMPLETIONDATE() |
Getter for EXPECTEDCOMPLETIONDATE w/ exceptions if field has |
HAS_EXPECTEDCOMPLETIONDATE() |
Determine if EXPECTEDCOMPLETIONDATE has a value |
StartBy¶
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the
StartBytime would be 8:00 PM on the date specified. The value ofStartByis 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_STARTBY() |
Getter for STARTBY, with configurable default |
ASK_STARTBY() |
Getter for STARTBY w/ exceptions if field has no value |
HAS_STARTBY() |
Determine if STARTBY has a value |
BackupOptions¶
Represents the options specified as part of backup plan or on-demand backup job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPOPTIONS() |
Getter for BACKUPOPTIONS, with configurable default |
ASK_BACKUPOPTIONS() |
Getter for BACKUPOPTIONS w/ exceptions if field has no value |
HAS_BACKUPOPTIONS() |
Determine if BACKUPOPTIONS has a value |
BackupType¶
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken,
BackupTypereturns"WindowsVSS". IfBackupTypeis empty, then the backup type was a regular backup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPTYPE() |
Getter for BACKUPTYPE, with configurable default |
ASK_BACKUPTYPE() |
Getter for BACKUPTYPE w/ exceptions if field has no value |
HAS_BACKUPTYPE() |
Determine if BACKUPTYPE has a value |
ParentJobId¶
This returns the parent (composite) resource backup job ID.
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 |
IsParent¶
This returns the boolean value that a backup job is a parent (composite) job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISPARENT() |
Getter for ISPARENT |
NumberOfChildJobs¶
This returns the number of child (nested) backup jobs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBEROFCHILDJOBS() |
Getter for NUMBEROFCHILDJOBS, with configurable default |
ASK_NUMBEROFCHILDJOBS() |
Getter for NUMBEROFCHILDJOBS w/ exceptions if field has no v |
HAS_NUMBEROFCHILDJOBS() |
Determine if NUMBEROFCHILDJOBS has a value |
ChildJobsInState¶
This returns the statistics of the included child (nested) backup jobs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHILDJOBSINSTATE() |
Getter for CHILDJOBSINSTATE, with configurable default |
ASK_CHILDJOBSINSTATE() |
Getter for CHILDJOBSINSTATE w/ exceptions if field has no va |
HAS_CHILDJOBSINSTATE() |
Determine if CHILDJOBSINSTATE has a value |
ResourceName¶
The non-unique name of the resource that belongs to the specified backup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCENAME() |
Getter for RESOURCENAME, with configurable default |
ASK_RESOURCENAME() |
Getter for RESOURCENAME w/ exceptions if field has no value |
HAS_RESOURCENAME() |
Determine if RESOURCENAME has a value |
InitiationDate¶
The date a backup job was initiated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INITIATIONDATE() |
Getter for INITIATIONDATE, with configurable default |
ASK_INITIATIONDATE() |
Getter for INITIATIONDATE w/ exceptions if field has no valu |
HAS_INITIATIONDATE() |
Determine if INITIATIONDATE has a value |
MessageCategory¶
The job count for the specified message category.
Example strings may include
AccessDenied,SUCCESS,AGGREGATE_ALL, andINVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGECATEGORY() |
Getter for MESSAGECATEGORY, with configurable default |
ASK_MESSAGECATEGORY() |
Getter for MESSAGECATEGORY w/ exceptions if field has no val |
HAS_MESSAGECATEGORY() |
Determine if MESSAGECATEGORY has a value |