# ScanJob
<a name="API_ScanJob"></a>

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

## Contents
<a name="API_ScanJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-ScanJob-AccountId"></a>
The account ID that owns the scan job.  
Type: String  
Required: Yes

 ** BackupVaultArn **   <a name="Backup-Type-ScanJob-BackupVaultArn"></a>
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 **   <a name="Backup-Type-ScanJob-BackupVaultName"></a>
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 Region where they are created.  
Type: String  
Required: Yes

 ** CreatedBy **   <a name="Backup-Type-ScanJob-CreatedBy"></a>
Contains identifying information about the creation of a scan job.  
Type: [ScanJobCreator](API_ScanJobCreator.md) object  
Required: Yes

 ** CreationDate **   <a name="Backup-Type-ScanJob-CreationDate"></a>
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.  
Type: Timestamp  
Required: Yes

 ** IamRoleArn **   <a name="Backup-Type-ScanJob-IamRoleArn"></a>
Specifies the IAM role ARN used to create the scan job; for example, `arn:aws:iam::123456789012:role/S3Access`.  
Type: String  
Required: Yes

 ** MalwareScanner **   <a name="Backup-Type-ScanJob-MalwareScanner"></a>
The scanning engine used for the scan job. Currently only `GUARDDUTY` is supported.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: Yes

 ** RecoveryPointArn **   <a name="Backup-Type-ScanJob-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-ScanJob-ResourceArn"></a>
An ARN that uniquely identifies the source resource of the recovery point being scanned.  
Type: String  
Required: Yes

 ** ResourceName **   <a name="Backup-Type-ScanJob-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: Yes

 ** ResourceType **   <a name="Backup-Type-ScanJob-ResourceType"></a>
The type of Amazon 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 | S3`   
Required: Yes

 ** ScanJobId **   <a name="Backup-Type-ScanJob-ScanJobId"></a>
The unique identifier that identifies the scan job request to Amazon Backup.  
Type: String  
Required: Yes

 ** ScanMode **   <a name="Backup-Type-ScanJob-ScanMode"></a>
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.  
Type: String  
Valid Values: `FULL_SCAN | INCREMENTAL_SCAN`   
Required: Yes

 ** ScannerRoleArn **   <a name="Backup-Type-ScanJob-ScannerRoleArn"></a>
Specifies the scanner IAM role ARN used for the scan job.  
Type: String  
Required: Yes

 ** CompletionDate **   <a name="Backup-Type-ScanJob-CompletionDate"></a>
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.  
Type: Timestamp  
Required: No

 ** ScanBaseRecoveryPointArn **   <a name="Backup-Type-ScanJob-ScanBaseRecoveryPointArn"></a>
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 **   <a name="Backup-Type-ScanJob-ScanId"></a>
The scan ID generated by the malware scanner for the corresponding scan job.  
Type: String  
Required: No

 ** ScanResult **   <a name="Backup-Type-ScanJob-ScanResult"></a>
Contains the scan results information, including the status of threats found during scanning.  
Type: [ScanResultInfo](API_ScanResultInfo.md) object  
Required: No

 ** State **   <a name="Backup-Type-ScanJob-State"></a>
The current state of the scan job.  
Valid values: `CREATED` \$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1 `CANCELED`.  
Type: String  
Valid Values: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-ScanJob-StatusMessage"></a>
A detailed message explaining the status of the scan job.  
Type: String  
Required: No

## See Also
<a name="API_ScanJob_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/backup-2018-11-15/ScanJob) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/backup-2018-11-15/ScanJob) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/backup-2018-11-15/ScanJob)