/AWS1/CL_BUPDESCRSCANJOBOUTPUT¶
DescribeScanJobOutput
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_accountid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
Returns the account ID that owns the scan job.
Pattern:
^[0-9]{12}$
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.
Pattern:
^[a-zA-Z0-9-_.]{2,50}$
io_createdby TYPE REF TO /AWS1/CL_BUPSCANJOBCREATOR /AWS1/CL_BUPSCANJOBCREATOR¶
Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.
iv_creationdate TYPE /AWS1/BUPTIMESTAMP00 /AWS1/BUPTIMESTAMP00¶
The date and time that a backup index finished creation, 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_iamrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:iam::123456789012:role/S3Access.
iv_malwarescanner TYPE /AWS1/BUPMALWARESCANNER /AWS1/BUPMALWARESCANNER¶
The scanning engine used for the corresponding scan job. Currently only
GUARDUTYis supported.
iv_recoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
An ARN that uniquely identifies the target recovery point for scanning.; 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 corresponding recovery point ARN.
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 to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.
Pattern:
^[a-zA-Z0-9-_.]{1,50}$
iv_scanjobid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
The scan job ID that uniquely identified the request to Backup.
iv_scanmode TYPE /AWS1/BUPSCANMODE /AWS1/BUPSCANMODE¶
Specifies the scan type used for the scan job.
iv_scannerrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
Specifies the scanner IAM role ARN used to for the scan job.
iv_state TYPE /AWS1/BUPSCANSTATE /AWS1/BUPSCANSTATE¶
The current state of a scan job.
Optional arguments:¶
iv_completiondate TYPE /AWS1/BUPTIMESTAMP00 /AWS1/BUPTIMESTAMP00¶
The date and time that a backup index finished creation, 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_scanbaserecoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
An ARN that uniquely identifies the base recovery point for scanning. This field will only be populated when an incremental scan job has taken place.
iv_scanid TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.
io_scanresult TYPE REF TO /AWS1/CL_BUPSCANRESULTINFO /AWS1/CL_BUPSCANRESULTINFO¶
Contains the
ScanResultsStatusfor the scanning job and returnsTHREATS_FOUNDorNO_THREATS_FOUNDfor completed jobs.
iv_statusmessage TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00¶
A detailed message explaining the status of the job to back up a resource.
Queryable Attributes¶
AccountId¶
Returns the account ID that owns the scan job.
Pattern:
^[0-9]{12}$
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.
Pattern:
^[a-zA-Z0-9-_.]{2,50}$
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 backup index finished creation, 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 |
CreatedBy¶
Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDBY() |
Getter for CREATEDBY |
CreationDate¶
The date and time that a backup index finished creation, 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 |
IamRoleArn¶
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; 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 corresponding scan job. Currently only
GUARDUTYis 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 target recovery point for scanning.; 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 corresponding recovery point ARN.
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 to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.
Pattern:
^[a-zA-Z0-9-_.]{1,50}$
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 will only be 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 Amazon GuardDuty for the corresponding Scan Job ID request from Backup.
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 scan job ID that uniquely identified the 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 used for the scan job.
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
ScanResultsStatusfor the scanning job and returnsTHREATS_FOUNDorNO_THREATS_FOUNDfor completed jobs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCANRESULT() |
Getter for SCANRESULT |
ScannerRoleArn¶
Specifies the scanner IAM role ARN used to 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 a scan 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 |