/AWS1/CL_BUPSCANJOB

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_accountid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

The account ID that owns the scan job.

iv_backupvaultarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

iv_backupvaultname TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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.

io_createdby TYPE REF TO /AWS1/CL_BUPSCANJOBCREATOR /AWS1/CL_BUPSCANJOBCREATOR

Contains identifying information about the creation of a scan job.

iv_creationdate TYPE /AWS1/BUPTIMESTAMP00 /AWS1/BUPTIMESTAMP00

The date and time that a scan 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_iamrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

iv_malwarescanner TYPE /AWS1/BUPMALWARESCANNER /AWS1/BUPMALWARESCANNER

The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

iv_recoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

iv_resourcearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

An ARN that uniquely identifies the source resource of the recovery point being scanned.

iv_resourcename TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

The non-unique name of the resource that belongs to the specified backup.

iv_resourcetype TYPE /AWS1/BUPSCANRESOURCETYPE /AWS1/BUPSCANRESOURCETYPE

The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

iv_scanjobid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

The unique identifier that identifies the scan job request to Backup.

iv_scanmode TYPE /AWS1/BUPSCANMODE /AWS1/BUPSCANMODE

Specifies the scan type use for the scan job.

Includes:

FULL_SCAN will scan the entire data lineage within the backup.

INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

iv_scannerrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

Specifies the scanner IAM role ARN used for the scan job.

Optional arguments:

iv_completiondate TYPE /AWS1/BUPTIMESTAMP00 /AWS1/BUPTIMESTAMP00

The date and time that a scan job 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_scanbaserecoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

iv_scanid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

The scan ID generated by the malware scanner for the corresponding scan job.

io_scanresult TYPE REF TO /AWS1/CL_BUPSCANRESULTINFO /AWS1/CL_BUPSCANRESULTINFO

Contains the scan results information, including the status of threats found during scanning.

iv_state TYPE /AWS1/BUPSCANSTATE /AWS1/BUPSCANSTATE

The current state of the scan job.

Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

iv_statusmessage TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

A detailed message explaining the status of the scan job.

---

Queryable Attributes

AccountId

The account ID that owns the scan 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

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

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

CompletionDate

The date and time that a scan job 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

CreatedBy

Contains identifying information about the creation of a scan job.

Accessible with the following methods

Method	Description
GET_CREATEDBY()	Getter for CREATEDBY

CreationDate

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

IamRoleArn

Specifies the IAM role ARN used to create the scan job; 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

MalwareScanner

The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

Accessible with the following methods

Method	Description
GET_MALWARESCANNER()	Getter for MALWARESCANNER, with configurable default
ASK_MALWARESCANNER()	Getter for MALWARESCANNER w/ exceptions if field has no valu
HAS_MALWARESCANNER()	Determine if MALWARESCANNER has a value

RecoveryPointArn

An ARN that uniquely identifies the recovery point being scanned; 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 the source resource of the recovery point being scanned.

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

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

ResourceType

The type of Amazon Web Services resource being scanned; 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

ScanBaseRecoveryPointArn

An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

Accessible with the following methods

Method	Description
GET_SCANBASERECOVERYPOINTARN()	Getter for SCANBASERECOVERYPOINTARN, with configurable defau
ASK_SCANBASERECOVERYPOINTARN()	Getter for SCANBASERECOVERYPOINTARN w/ exceptions if field h
HAS_SCANBASERECOVERYPOINTARN()	Determine if SCANBASERECOVERYPOINTARN has a value

ScanId

The scan ID generated by the malware scanner for the corresponding scan job.

Accessible with the following methods

Method	Description
GET_SCANID()	Getter for SCANID, with configurable default
ASK_SCANID()	Getter for SCANID w/ exceptions if field has no value
HAS_SCANID()	Determine if SCANID has a value

ScanJobId

The unique identifier that identifies the scan job request to Backup.

Accessible with the following methods

Method	Description
GET_SCANJOBID()	Getter for SCANJOBID, with configurable default
ASK_SCANJOBID()	Getter for SCANJOBID w/ exceptions if field has no value
HAS_SCANJOBID()	Determine if SCANJOBID has a value

ScanMode

Specifies the scan type use for the scan job.

Includes:

FULL_SCAN will scan the entire data lineage within the backup.

INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

Accessible with the following methods

Method	Description
GET_SCANMODE()	Getter for SCANMODE, with configurable default
ASK_SCANMODE()	Getter for SCANMODE w/ exceptions if field has no value
HAS_SCANMODE()	Determine if SCANMODE has a value

ScanResult

Contains the scan results information, including the status of threats found during scanning.

Accessible with the following methods

Method	Description
GET_SCANRESULT()	Getter for SCANRESULT

ScannerRoleArn

Specifies the scanner IAM role ARN used for the scan job.

Accessible with the following methods

Method	Description
GET_SCANNERROLEARN()	Getter for SCANNERROLEARN, with configurable default
ASK_SCANNERROLEARN()	Getter for SCANNERROLEARN w/ exceptions if field has no valu
HAS_SCANNERROLEARN()	Determine if SCANNERROLEARN has a value

State

The current state of the scan job.

Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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 scan job.

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

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SCANJOBS

TYPES TT_SCANJOBS TYPE STANDARD TABLE OF REF TO /AWS1/CL_BUPSCANJOB WITH DEFAULT KEY
.