aws_sdk_backup/client/

describe_scan_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeScanJob`](crate::operation::describe_scan_job::builders::DescribeScanJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`scan_job_id(impl Into<String>)`](crate::operation::describe_scan_job::builders::DescribeScanJobFluentBuilder::scan_job_id) / [`set_scan_job_id(Option<String>)`](crate::operation::describe_scan_job::builders::DescribeScanJobFluentBuilder::set_scan_job_id):<br>required: **true**<br><p>Uniquely identifies a request to Backup to scan a resource.</p><br>
    /// - On success, responds with [`DescribeScanJobOutput`](crate::operation::describe_scan_job::DescribeScanJobOutput) with field(s):
    ///   - [`account_id(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::account_id): <p>Returns the account ID that owns the scan job.</p> <p>Pattern: <code>^\[0-9\]{12}$</code></p>
    ///   - [`backup_vault_arn(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::backup_vault_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code></p>
    ///   - [`backup_vault_name(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::backup_vault_name): <p>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.</p> <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{2,50}$</code></p>
    ///   - [`completion_date(Option<DateTime>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::completion_date): <p>The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`created_by(Option<ScanJobCreator>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::created_by): <p>Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.</p>
    ///   - [`creation_date(DateTime)`](crate::operation::describe_scan_job::DescribeScanJobOutput::creation_date): <p>The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`iam_role_arn(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::iam_role_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
    ///   - [`malware_scanner(MalwareScanner)`](crate::operation::describe_scan_job::DescribeScanJobOutput::malware_scanner): <p>The scanning engine used for the corresponding scan job. Currently only <code>GUARDUTY</code> is supported.</p>
    ///   - [`recovery_point_arn(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::recovery_point_arn): <p>An ARN that uniquely identifies the target recovery point for scanning.; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
    ///   - [`resource_arn(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::resource_arn): <p>An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.</p>
    ///   - [`resource_name(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::resource_name): <p>The non-unique name of the resource that belongs to the specified backup.</p>
    ///   - [`resource_type(ScanResourceType)`](crate::operation::describe_scan_job::DescribeScanJobOutput::resource_type): <p>The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.</p> <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{1,50}$</code></p>
    ///   - [`scan_base_recovery_point_arn(Option<String>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scan_base_recovery_point_arn): <p>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.</p>
    ///   - [`scan_id(Option<String>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scan_id): <p>The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.</p>
    ///   - [`scan_job_id(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scan_job_id): <p>The scan job ID that uniquely identified the request to Backup.</p>
    ///   - [`scan_mode(ScanMode)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scan_mode): <p>Specifies the scan type used for the scan job.</p>
    ///   - [`scan_result(Option<ScanResultInfo>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scan_result): <p>Contains the <code>ScanResultsStatus</code> for the scanning job and returns <code>THREATS_FOUND</code> or <code>NO_THREATS_FOUND</code> for completed jobs.</p>
    ///   - [`scanner_role_arn(String)`](crate::operation::describe_scan_job::DescribeScanJobOutput::scanner_role_arn): <p>Specifies the scanner IAM role ARN used to for the scan job.</p>
    ///   - [`state(ScanState)`](crate::operation::describe_scan_job::DescribeScanJobOutput::state): <p>The current state of a scan job.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::describe_scan_job::DescribeScanJobOutput::status_message): <p>A detailed message explaining the status of the job to back up a resource.</p>
    /// - On failure, responds with [`SdkError<DescribeScanJobError>`](crate::operation::describe_scan_job::DescribeScanJobError)
    pub fn describe_scan_job(&self) -> crate::operation::describe_scan_job::builders::DescribeScanJobFluentBuilder {
        crate::operation::describe_scan_job::builders::DescribeScanJobFluentBuilder::new(self.handle.clone())
    }
}