ScanJob
Contains metadata about a scan job, including information about the scanning process, results, and associated resources.
Contents
- AccountId
-
The account ID that owns the scan job.
Type: String
Required: Yes
- BackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.Type: String
Required: Yes
- 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 AWS Region where they are created.
Type: String
Required: Yes
- CreatedBy
-
Contains identifying information about the creation of a scan job.
Type: ScanJobCreator object
Required: Yes
- CreationDate
-
The date and time that a scan 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.Type: Timestamp
Required: Yes
- IamRoleArn
-
Specifies the IAM role ARN used to create the scan job; for example,
arn:aws:iam::123456789012:role/S3Access.Type: String
Required: Yes
- MalwareScanner
-
The scanning engine used for the scan job. Currently only
GUARDDUTYis supported.Type: String
Valid Values:
GUARDDUTYRequired: Yes
- 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.Type: String
Required: Yes
- ResourceArn
-
An ARN that uniquely identifies the source resource of the recovery point being scanned.
Type: String
Required: Yes
- ResourceName
-
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: Yes
- ResourceType
-
The type of AWS resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Valid Values:
EBS | EC2 | S3Required: Yes
- ScanJobId
-
The unique identifier that identifies the scan job request to AWS Backup.
Type: String
Required: Yes
- ScanMode
-
Specifies the scan type use for the scan job.
Includes:
FULL_SCANwill scan the entire data lineage within the backup.INCREMENTAL_SCANwill scan the data difference between the target recovery point and base recovery point ARN.Type: String
Valid Values:
FULL_SCAN | INCREMENTAL_SCANRequired: Yes
- ScannerRoleArn
-
Specifies the scanner IAM role ARN used for the scan job.
Type: String
Required: Yes
- CompletionDate
-
The date and time that a scan 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.Type: Timestamp
Required: No
- ScanBaseRecoveryPointArn
-
An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
Type: String
Required: No
- ScanId
-
The scan ID generated by the malware scanner for the corresponding scan job.
Type: String
Required: No
- ScanResult
-
Contains the scan results information, including the status of threats found during scanning.
Type: ScanResultInfo object
Required: No
- State
-
The current state of the scan job.
Valid values:
CREATED|RUNNING|COMPLETED|COMPLETED_WITH_ISSUES|FAILED|CANCELED.Type: String
Valid Values:
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNINGRequired: No
- StatusMessage
-
A detailed message explaining the status of the scan job.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
