aws_sdk_guardduty/client/

get_malware_scan.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetMalwareScan`](crate::operation::get_malware_scan::builders::GetMalwareScanFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`scan_id(impl Into<String>)`](crate::operation::get_malware_scan::builders::GetMalwareScanFluentBuilder::scan_id) / [`set_scan_id(Option<String>)`](crate::operation::get_malware_scan::builders::GetMalwareScanFluentBuilder::set_scan_id):<br>required: **true**<br><p>A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.</p><br>
    /// - On success, responds with [`GetMalwareScanOutput`](crate::operation::get_malware_scan::GetMalwareScanOutput) with field(s):
    ///   - [`scan_id(Option<String>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_id): <p>A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.</p>
    ///   - [`detector_id(Option<String>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::detector_id): <p>The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
    ///   - [`admin_detector_id(Option<String>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::admin_detector_id): <p>The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the <code>AdminDetectorId</code> will be the same as the one used for <code>DetectorId. If the customer is not a GuardDuty customer, this field will not be present.</code>.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
    ///   - [`resource_arn(Option<String>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::resource_arn): <p>Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.</p>
    ///   - [`resource_type(Option<MalwareProtectionResourceType>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::resource_type): <p>The type of resource that was scanned for malware.</p>
    ///   - [`scanned_resources_count(Option<i32>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scanned_resources_count): <p>The total number of resources that were successfully scanned. This is dependent on the resource type.</p>
    ///   - [`skipped_resources_count(Option<i32>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::skipped_resources_count): <p>The total number of resources that were skipped during the scan.</p>
    ///   - [`failed_resources_count(Option<i32>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::failed_resources_count): <p>The total number of resources that failed to be scanned.</p>
    ///   - [`scanned_resources(Option<Vec::<ScannedResource>>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scanned_resources): <p>A list of resources along with their metadata that were scanned as part of the malware scan operation.</p>
    ///   - [`scan_configuration(Option<ScanConfiguration>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_configuration): <p>Information about the scan configuration used for the malware scan.</p>
    ///   - [`scan_category(Option<ScanCategory>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_category): <p>The category of the malware scan, indicating the type of scan performed.</p>
    ///   - [`scan_status(Option<MalwareProtectionScanStatus>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_status): <p>A value representing the current status of the malware scan.</p>
    ///   - [`scan_status_reason(Option<ScanStatusReason>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_status_reason): <p>Represents the reason for the current scan status, if applicable.</p>
    ///   - [`scan_type(Option<MalwareProtectionScanType>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_type): <p>A value representing the initiator of the scan.</p>
    ///   - [`scan_started_at(Option<DateTime>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_started_at): <p>The timestamp representing when the malware scan was started.</p>
    ///   - [`scan_completed_at(Option<DateTime>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_completed_at): <p>The timestamp representing when the malware scan was completed.</p>
    ///   - [`scan_result_details(Option<GetMalwareScanResultDetails>)`](crate::operation::get_malware_scan::GetMalwareScanOutput::scan_result_details): <p>Detailed information about the results of the malware scan, if the scan completed.</p>
    /// - On failure, responds with [`SdkError<GetMalwareScanError>`](crate::operation::get_malware_scan::GetMalwareScanError)
    pub fn get_malware_scan(&self) -> crate::operation::get_malware_scan::builders::GetMalwareScanFluentBuilder {
        crate::operation::get_malware_scan::builders::GetMalwareScanFluentBuilder::new(self.handle.clone())
    }
}