Skip to main content

aws_sdk_securityhub/operation/batch_update_findings_v2/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_update_findings_v2::_batch_update_findings_v2_input::BatchUpdateFindingsV2InputBuilder;
3
4pub use crate::operation::batch_update_findings_v2::_batch_update_findings_v2_output::BatchUpdateFindingsV2OutputBuilder;
5
6impl crate::operation::batch_update_findings_v2::builders::BatchUpdateFindingsV2InputBuilder {
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_update_findings_v2::BatchUpdateFindingsV2Output,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Error,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_update_findings_v2();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchUpdateFindingsV2`.
24///
25/// <p>Updates information about a customer's investigation into a finding. Delegated administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their own account.</p>
26/// <p><code>BatchUpdateFindings</code> and <code>BatchUpdateFindingsV2</code> both use <code>securityhub:BatchUpdateFindings</code> in the <code>Action</code> element of an IAM policy statement. You must have permission to perform the <code>securityhub:BatchUpdateFindings</code> action. You can configure IAM policies to restrict access to specific finding fields or field values by using the <code>securityhub:OCSFSyntaxPath/<fieldname></fieldname></code> condition key, where <code><fieldname></fieldname></code> is one of the following supported fields: <code>SeverityId</code>, <code>StatusId</code>, or <code>Comment</code>.</p>
27/// <p>To prevent a user from updating a specific field, use a <code>Null</code> condition with <code>securityhub:OCSFSyntaxPath/<fieldname></fieldname></code> set to <code>"false"</code>. To prevent a user from setting a field to a specific value, use a <code>StringEquals</code> condition with <code>securityhub:OCSFSyntaxPath/<fieldname></fieldname></code> set to the disallowed value or list of values.</p>
28/// <p>Updates from <code>BatchUpdateFindingsV2</code> don't affect the value of <code>finding_info.modified_time</code>, <code>finding_info.modified_time_dt</code>, <code>time</code>, or <code>time_dt</code> for a finding.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct BatchUpdateFindingsV2FluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::batch_update_findings_v2::builders::BatchUpdateFindingsV2InputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Output,
38        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Error,
39    > for BatchUpdateFindingsV2FluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Output,
47            crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Error,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl BatchUpdateFindingsV2FluentBuilder {
54    /// Creates a new `BatchUpdateFindingsV2FluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the BatchUpdateFindingsV2 as a reference.
63    pub fn as_input(&self) -> &crate::operation::batch_update_findings_v2::builders::BatchUpdateFindingsV2InputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Output,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Error,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Output,
100        crate::operation::batch_update_findings_v2::BatchUpdateFindingsV2Error,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    ///
115    /// Appends an item to `MetadataUids`.
116    ///
117    /// To override the contents of this collection use [`set_metadata_uids`](Self::set_metadata_uids).
118    ///
119    /// <p>The list of finding <code>metadata.uid</code> to indicate findings to update. Finding <code>metadata.uid</code> is a globally unique identifier associated with the finding. Customers cannot use <code>MetadataUids</code> together with <code>FindingIdentifiers</code>.</p>
120    pub fn metadata_uids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.metadata_uids(input.into());
122        self
123    }
124    /// <p>The list of finding <code>metadata.uid</code> to indicate findings to update. Finding <code>metadata.uid</code> is a globally unique identifier associated with the finding. Customers cannot use <code>MetadataUids</code> together with <code>FindingIdentifiers</code>.</p>
125    pub fn set_metadata_uids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
126        self.inner = self.inner.set_metadata_uids(input);
127        self
128    }
129    /// <p>The list of finding <code>metadata.uid</code> to indicate findings to update. Finding <code>metadata.uid</code> is a globally unique identifier associated with the finding. Customers cannot use <code>MetadataUids</code> together with <code>FindingIdentifiers</code>.</p>
130    pub fn get_metadata_uids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
131        self.inner.get_metadata_uids()
132    }
133    ///
134    /// Appends an item to `FindingIdentifiers`.
135    ///
136    /// To override the contents of this collection use [`set_finding_identifiers`](Self::set_finding_identifiers).
137    ///
138    /// <p>Provides information to identify a specific V2 finding.</p>
139    pub fn finding_identifiers(mut self, input: crate::types::OcsfFindingIdentifier) -> Self {
140        self.inner = self.inner.finding_identifiers(input);
141        self
142    }
143    /// <p>Provides information to identify a specific V2 finding.</p>
144    pub fn set_finding_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OcsfFindingIdentifier>>) -> Self {
145        self.inner = self.inner.set_finding_identifiers(input);
146        self
147    }
148    /// <p>Provides information to identify a specific V2 finding.</p>
149    pub fn get_finding_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OcsfFindingIdentifier>> {
150        self.inner.get_finding_identifiers()
151    }
152    /// <p>The updated value for a user provided comment about the finding. Minimum character length 1. Maximum character length 512.</p>
153    pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.inner = self.inner.comment(input.into());
155        self
156    }
157    /// <p>The updated value for a user provided comment about the finding. Minimum character length 1. Maximum character length 512.</p>
158    pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159        self.inner = self.inner.set_comment(input);
160        self
161    }
162    /// <p>The updated value for a user provided comment about the finding. Minimum character length 1. Maximum character length 512.</p>
163    pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_comment()
165    }
166    /// <p>The updated value for the normalized severity identifier. The severity ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 6, 99\]. When customer provides the updated severity ID, the string sibling severity will automatically be updated in the finding.</p>
167    pub fn severity_id(mut self, input: i32) -> Self {
168        self.inner = self.inner.severity_id(input);
169        self
170    }
171    /// <p>The updated value for the normalized severity identifier. The severity ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 6, 99\]. When customer provides the updated severity ID, the string sibling severity will automatically be updated in the finding.</p>
172    pub fn set_severity_id(mut self, input: ::std::option::Option<i32>) -> Self {
173        self.inner = self.inner.set_severity_id(input);
174        self
175    }
176    /// <p>The updated value for the normalized severity identifier. The severity ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 6, 99\]. When customer provides the updated severity ID, the string sibling severity will automatically be updated in the finding.</p>
177    pub fn get_severity_id(&self) -> &::std::option::Option<i32> {
178        self.inner.get_severity_id()
179    }
180    /// <p>The updated value for the normalized status identifier. The status ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 99\]. When customer provides the updated status ID, the string sibling status will automatically be updated in the finding.</p>
181    pub fn status_id(mut self, input: i32) -> Self {
182        self.inner = self.inner.status_id(input);
183        self
184    }
185    /// <p>The updated value for the normalized status identifier. The status ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 99\]. When customer provides the updated status ID, the string sibling status will automatically be updated in the finding.</p>
186    pub fn set_status_id(mut self, input: ::std::option::Option<i32>) -> Self {
187        self.inner = self.inner.set_status_id(input);
188        self
189    }
190    /// <p>The updated value for the normalized status identifier. The status ID is an integer with the allowed enum values \[0, 1, 2, 3, 4, 5, 99\]. When customer provides the updated status ID, the string sibling status will automatically be updated in the finding.</p>
191    pub fn get_status_id(&self) -> &::std::option::Option<i32> {
192        self.inner.get_status_id()
193    }
194}