aws_sdk_securityhub/operation/batch_import_findings/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_import_findings::_batch_import_findings_output::BatchImportFindingsOutputBuilder;
3
4pub use crate::operation::batch_import_findings::_batch_import_findings_input::BatchImportFindingsInputBuilder;
5
6impl crate::operation::batch_import_findings::builders::BatchImportFindingsInputBuilder {
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::batch_import_findings::BatchImportFindingsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_import_findings::BatchImportFindingsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_import_findings();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchImportFindings`.
24///
25/// <p>Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.</p>
26/// <p><code>BatchImportFindings</code> must be called by one of the following:</p>
27/// <ul>
28/// <li>
29/// <p>The Amazon Web Services account that is associated with a finding if you are using the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs">default product ARN</a> or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling <code>BatchImportFindings</code> from needs to be the same as the <code>AwsAccountId</code> attribute for the finding.</p></li>
30/// <li>
31/// <p>An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call <code>BatchImportFindings</code> from the allow-listed account and send findings from different customer accounts in the same batch.</p></li>
32/// </ul>
33/// <p>The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p>
34/// <p>After a finding is created, <code>BatchImportFindings</code> cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.</p>
35/// <ul>
36/// <li>
37/// <p><code>Note</code></p></li>
38/// <li>
39/// <p><code>UserDefinedFields</code></p></li>
40/// <li>
41/// <p><code>VerificationState</code></p></li>
42/// <li>
43/// <p><code>Workflow</code></p></li>
44/// </ul>
45/// <p>Finding providers also should not use <code>BatchImportFindings</code> to update the following attributes.</p>
46/// <ul>
47/// <li>
48/// <p><code>Confidence</code></p></li>
49/// <li>
50/// <p><code>Criticality</code></p></li>
51/// <li>
52/// <p><code>RelatedFindings</code></p></li>
53/// <li>
54/// <p><code>Severity</code></p></li>
55/// <li>
56/// <p><code>Types</code></p></li>
57/// </ul>
58/// <p>Instead, finding providers use <code>FindingProviderFields</code> to provide values for these attributes.</p>
59#[derive(::std::clone::Clone, ::std::fmt::Debug)]
60pub struct BatchImportFindingsFluentBuilder {
61    handle: ::std::sync::Arc<crate::client::Handle>,
62    inner: crate::operation::batch_import_findings::builders::BatchImportFindingsInputBuilder,
63    config_override: ::std::option::Option<crate::config::Builder>,
64}
65impl
66    crate::client::customize::internal::CustomizableSend<
67        crate::operation::batch_import_findings::BatchImportFindingsOutput,
68        crate::operation::batch_import_findings::BatchImportFindingsError,
69    > for BatchImportFindingsFluentBuilder
70{
71    fn send(
72        self,
73        config_override: crate::config::Builder,
74    ) -> crate::client::customize::internal::BoxFuture<
75        crate::client::customize::internal::SendResult<
76            crate::operation::batch_import_findings::BatchImportFindingsOutput,
77            crate::operation::batch_import_findings::BatchImportFindingsError,
78        >,
79    > {
80        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
81    }
82}
83impl BatchImportFindingsFluentBuilder {
84    /// Creates a new `BatchImportFindingsFluentBuilder`.
85    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
86        Self {
87            handle,
88            inner: ::std::default::Default::default(),
89            config_override: ::std::option::Option::None,
90        }
91    }
92    /// Access the BatchImportFindings as a reference.
93    pub fn as_input(&self) -> &crate::operation::batch_import_findings::builders::BatchImportFindingsInputBuilder {
94        &self.inner
95    }
96    /// Sends the request and returns the response.
97    ///
98    /// If an error occurs, an `SdkError` will be returned with additional details that
99    /// can be matched against.
100    ///
101    /// By default, any retryable failures will be retried twice. Retry behavior
102    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
103    /// set when configuring the client.
104    pub async fn send(
105        self,
106    ) -> ::std::result::Result<
107        crate::operation::batch_import_findings::BatchImportFindingsOutput,
108        ::aws_smithy_runtime_api::client::result::SdkError<
109            crate::operation::batch_import_findings::BatchImportFindingsError,
110            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
111        >,
112    > {
113        let input = self
114            .inner
115            .build()
116            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
117        let runtime_plugins = crate::operation::batch_import_findings::BatchImportFindings::operation_runtime_plugins(
118            self.handle.runtime_plugins.clone(),
119            &self.handle.conf,
120            self.config_override,
121        );
122        crate::operation::batch_import_findings::BatchImportFindings::orchestrate(&runtime_plugins, input).await
123    }
124
125    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
126    pub fn customize(
127        self,
128    ) -> crate::client::customize::CustomizableOperation<
129        crate::operation::batch_import_findings::BatchImportFindingsOutput,
130        crate::operation::batch_import_findings::BatchImportFindingsError,
131        Self,
132    > {
133        crate::client::customize::CustomizableOperation::new(self)
134    }
135    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
136        self.set_config_override(::std::option::Option::Some(config_override.into()));
137        self
138    }
139
140    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
141        self.config_override = config_override;
142        self
143    }
144    ///
145    /// Appends an item to `Findings`.
146    ///
147    /// To override the contents of this collection use [`set_findings`](Self::set_findings).
148    ///
149    /// <p>A list of findings to import. To successfully import a finding, it must follow the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a>. Maximum of 100 findings per request.</p>
150    pub fn findings(mut self, input: crate::types::AwsSecurityFinding) -> Self {
151        self.inner = self.inner.findings(input);
152        self
153    }
154    /// <p>A list of findings to import. To successfully import a finding, it must follow the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a>. Maximum of 100 findings per request.</p>
155    pub fn set_findings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AwsSecurityFinding>>) -> Self {
156        self.inner = self.inner.set_findings(input);
157        self
158    }
159    /// <p>A list of findings to import. To successfully import a finding, it must follow the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a>. Maximum of 100 findings per request.</p>
160    pub fn get_findings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AwsSecurityFinding>> {
161        self.inner.get_findings()
162    }
163}
aws_sdk_securityhub/operation/batch_import_findings/builders.rs

aws_sdk_securityhub/operation/batch_import_findings/
builders.rs
