aws_sdk_codegurusecurity/client/get_scan.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetScan`](crate::operation::get_scan::builders::GetScanFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`scan_name(impl Into<String>)`](crate::operation::get_scan::builders::GetScanFluentBuilder::scan_name) / [`set_scan_name(Option<String>)`](crate::operation::get_scan::builders::GetScanFluentBuilder::set_scan_name):<br>required: **true**<br><p>The name of the scan you want to view details about.</p><br>
7 /// - [`run_id(impl Into<String>)`](crate::operation::get_scan::builders::GetScanFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::get_scan::builders::GetScanFluentBuilder::set_run_id):<br>required: **false**<br><p>UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</p><br>
8 /// - On success, responds with [`GetScanOutput`](crate::operation::get_scan::GetScanOutput) with field(s):
9 /// - [`scan_name(String)`](crate::operation::get_scan::GetScanOutput::scan_name): <p>The name of the scan.</p>
10 /// - [`run_id(String)`](crate::operation::get_scan::GetScanOutput::run_id): <p>UUID that identifies the individual scan run.</p>
11 /// - [`scan_state(ScanState)`](crate::operation::get_scan::GetScanOutput::scan_state): <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
12 /// - [`created_at(DateTime)`](crate::operation::get_scan::GetScanOutput::created_at): <p>The time the scan was created.</p>
13 /// - [`analysis_type(AnalysisType)`](crate::operation::get_scan::GetScanOutput::analysis_type): <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
14 /// - [`updated_at(Option<DateTime>)`](crate::operation::get_scan::GetScanOutput::updated_at): <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
15 /// - [`number_of_revisions(Option<i64>)`](crate::operation::get_scan::GetScanOutput::number_of_revisions): <p>The number of times a scan has been re-run on a revised resource.</p>
16 /// - [`scan_name_arn(Option<String>)`](crate::operation::get_scan::GetScanOutput::scan_name_arn): <p>The ARN for the scan name.</p>
17 /// - [`error_message(Option<String>)`](crate::operation::get_scan::GetScanOutput::error_message): <p>Details about the error that causes a scan to fail to be retrieved.</p>
18 /// - On failure, responds with [`SdkError<GetScanError>`](crate::operation::get_scan::GetScanError)
19 pub fn get_scan(&self) -> crate::operation::get_scan::builders::GetScanFluentBuilder {
20 crate::operation::get_scan::builders::GetScanFluentBuilder::new(self.handle.clone())
21 }
22}