aws_sdk_codegurusecurity/client/get_findings.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 [`GetFindings`](crate::operation::get_findings::builders::GetFindingsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`scan_name(impl Into<String>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::scan_name) / [`set_scan_name(Option<String>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::set_scan_name):<br>required: **true**<br><p>The name of the scan you want to retrieve findings from.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p><br>
9 /// - [`max_results(i32)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 1000 results.</p><br>
10 /// - [`status(Status)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::status) / [`set_status(Option<Status>)`](crate::operation::get_findings::builders::GetFindingsFluentBuilder::set_status):<br>required: **false**<br><p>The status of the findings you want to get. Pass either <code>Open</code>, <code>Closed</code>, or <code>All</code>.</p><br>
11 /// - On success, responds with [`GetFindingsOutput`](crate::operation::get_findings::GetFindingsOutput) with field(s):
12 /// - [`findings(Option<Vec::<Finding>>)`](crate::operation::get_findings::GetFindingsOutput::findings): <p>A list of findings generated by the specified scan.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::get_findings::GetFindingsOutput::next_token): <p>A pagination token. You can use this in future calls to <code>GetFindings</code> to continue listing results after the current page.</p>
14 /// - On failure, responds with [`SdkError<GetFindingsError>`](crate::operation::get_findings::GetFindingsError)
15 pub fn get_findings(&self) -> crate::operation::get_findings::builders::GetFindingsFluentBuilder {
16 crate::operation::get_findings::builders::GetFindingsFluentBuilder::new(self.handle.clone())
17 }
18}