aws_sdk_securityhub/operation/get_findings/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_findings::_get_findings_output::GetFindingsOutputBuilder;
3
4pub use crate::operation::get_findings::_get_findings_input::GetFindingsInputBuilder;
5
6impl crate::operation::get_findings::builders::GetFindingsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_findings::GetFindingsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_findings::GetFindingsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_findings();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetFindings`.
24///
25/// <p>Returns a list of findings that match the specified criteria.</p>
26/// <p>If cross-Region aggregation is enabled, then when you call <code>GetFindings</code> from the home Region, the results include all of the matching findings from both the home Region and linked Regions.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct GetFindingsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::get_findings::builders::GetFindingsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::get_findings::GetFindingsOutput,
36        crate::operation::get_findings::GetFindingsError,
37    > for GetFindingsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::get_findings::GetFindingsOutput,
45            crate::operation::get_findings::GetFindingsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl GetFindingsFluentBuilder {
52    /// Creates a new `GetFindingsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the GetFindings as a reference.
61    pub fn as_input(&self) -> &crate::operation::get_findings::builders::GetFindingsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::get_findings::GetFindingsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::get_findings::GetFindingsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::get_findings::GetFindings::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::get_findings::GetFindings::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::get_findings::GetFindingsOutput,
98        crate::operation::get_findings::GetFindingsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::get_findings::paginator::GetFindingsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::get_findings::paginator::GetFindingsPaginator {
116        crate::operation::get_findings::paginator::GetFindingsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The finding attributes used to define a condition to filter the returned findings.</p>
119    /// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
120    /// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
121    pub fn filters(mut self, input: crate::types::AwsSecurityFindingFilters) -> Self {
122        self.inner = self.inner.filters(input);
123        self
124    }
125    /// <p>The finding attributes used to define a condition to filter the returned findings.</p>
126    /// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
127    /// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
128    pub fn set_filters(mut self, input: ::std::option::Option<crate::types::AwsSecurityFindingFilters>) -> Self {
129        self.inner = self.inner.set_filters(input);
130        self
131    }
132    /// <p>The finding attributes used to define a condition to filter the returned findings.</p>
133    /// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
134    /// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
135    pub fn get_filters(&self) -> &::std::option::Option<crate::types::AwsSecurityFindingFilters> {
136        self.inner.get_filters()
137    }
138    ///
139    /// Appends an item to `SortCriteria`.
140    ///
141    /// To override the contents of this collection use [`set_sort_criteria`](Self::set_sort_criteria).
142    ///
143    /// <p>The finding attributes used to sort the list of returned findings.</p>
144    pub fn sort_criteria(mut self, input: crate::types::SortCriterion) -> Self {
145        self.inner = self.inner.sort_criteria(input);
146        self
147    }
148    /// <p>The finding attributes used to sort the list of returned findings.</p>
149    pub fn set_sort_criteria(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>>) -> Self {
150        self.inner = self.inner.set_sort_criteria(input);
151        self
152    }
153    /// <p>The finding attributes used to sort the list of returned findings.</p>
154    pub fn get_sort_criteria(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>> {
155        self.inner.get_sort_criteria()
156    }
157    /// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
158    /// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
159    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
160        self.inner = self.inner.next_token(input.into());
161        self
162    }
163    /// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
164    /// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
165    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166        self.inner = self.inner.set_next_token(input);
167        self
168    }
169    /// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
170    /// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
171    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
172        self.inner.get_next_token()
173    }
174    /// <p>The maximum number of findings to return.</p>
175    pub fn max_results(mut self, input: i32) -> Self {
176        self.inner = self.inner.max_results(input);
177        self
178    }
179    /// <p>The maximum number of findings to return.</p>
180    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
181        self.inner = self.inner.set_max_results(input);
182        self
183    }
184    /// <p>The maximum number of findings to return.</p>
185    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
186        self.inner.get_max_results()
187    }
188}
aws_sdk_securityhub/operation/get_findings/builders.rs

aws_sdk_securityhub/operation/get_findings/
builders.rs
