aws_sdk_securityhub/operation/batch_update_findings/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::batch_update_findings::_batch_update_findings_output::BatchUpdateFindingsOutputBuilder;

pub use crate::operation::batch_update_findings::_batch_update_findings_input::BatchUpdateFindingsInputBuilder;

impl crate::operation::batch_update_findings::builders::BatchUpdateFindingsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::batch_update_findings::BatchUpdateFindingsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::batch_update_findings::BatchUpdateFindingsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.batch_update_findings();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `BatchUpdateFindings`.
///
/// <p>Used by Security Hub customers to update information about their investigation into one or more findings. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. A member account can update findings only for their own account. Administrator and member accounts can use this operation to update the following fields and objects for one or more findings:</p>
/// <ul>
/// <li>
/// <p><code>Confidence</code></p></li>
/// <li>
/// <p><code>Criticality</code></p></li>
/// <li>
/// <p><code>Note</code></p></li>
/// <li>
/// <p><code>RelatedFindings</code></p></li>
/// <li>
/// <p><code>Severity</code></p></li>
/// <li>
/// <p><code>Types</code></p></li>
/// <li>
/// <p><code>UserDefinedFields</code></p></li>
/// <li>
/// <p><code>VerificationState</code></p></li>
/// <li>
/// <p><code>Workflow</code></p></li>
/// </ul>
/// <p>If you use this operation to update a finding, your updates don’t affect the value for the <code>UpdatedAt</code> field of the finding. Also note that it can take several minutes for Security Hub to process your request and update each finding specified in the request.</p>
/// <p>You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. For more information see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access">Configuring access to BatchUpdateFindings</a> in the <i>Security Hub User Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct BatchUpdateFindingsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::batch_update_findings::builders::BatchUpdateFindingsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::batch_update_findings::BatchUpdateFindingsOutput,
        crate::operation::batch_update_findings::BatchUpdateFindingsError,
    > for BatchUpdateFindingsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::batch_update_findings::BatchUpdateFindingsOutput,
            crate::operation::batch_update_findings::BatchUpdateFindingsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl BatchUpdateFindingsFluentBuilder {
    /// Creates a new `BatchUpdateFindingsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the BatchUpdateFindings as a reference.
    pub fn as_input(&self) -> &crate::operation::batch_update_findings::builders::BatchUpdateFindingsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::batch_update_findings::BatchUpdateFindingsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::batch_update_findings::BatchUpdateFindingsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::batch_update_findings::BatchUpdateFindings::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::batch_update_findings::BatchUpdateFindings::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::batch_update_findings::BatchUpdateFindingsOutput,
        crate::operation::batch_update_findings::BatchUpdateFindingsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    ///
    /// Appends an item to `FindingIdentifiers`.
    ///
    /// To override the contents of this collection use [`set_finding_identifiers`](Self::set_finding_identifiers).
    ///
    /// <p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update up to 100 findings at a time.</p>
    /// <p>For each finding, the list provides the finding identifier and the ARN of the finding provider.</p>
    pub fn finding_identifiers(mut self, input: crate::types::AwsSecurityFindingIdentifier) -> Self {
        self.inner = self.inner.finding_identifiers(input);
        self
    }
    /// <p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update up to 100 findings at a time.</p>
    /// <p>For each finding, the list provides the finding identifier and the ARN of the finding provider.</p>
    pub fn set_finding_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AwsSecurityFindingIdentifier>>) -> Self {
        self.inner = self.inner.set_finding_identifiers(input);
        self
    }
    /// <p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update up to 100 findings at a time.</p>
    /// <p>For each finding, the list provides the finding identifier and the ARN of the finding provider.</p>
    pub fn get_finding_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AwsSecurityFindingIdentifier>> {
        self.inner.get_finding_identifiers()
    }
    /// <p>The updated note.</p>
    pub fn note(mut self, input: crate::types::NoteUpdate) -> Self {
        self.inner = self.inner.note(input);
        self
    }
    /// <p>The updated note.</p>
    pub fn set_note(mut self, input: ::std::option::Option<crate::types::NoteUpdate>) -> Self {
        self.inner = self.inner.set_note(input);
        self
    }
    /// <p>The updated note.</p>
    pub fn get_note(&self) -> &::std::option::Option<crate::types::NoteUpdate> {
        self.inner.get_note()
    }
    /// <p>Used to update the finding severity.</p>
    pub fn severity(mut self, input: crate::types::SeverityUpdate) -> Self {
        self.inner = self.inner.severity(input);
        self
    }
    /// <p>Used to update the finding severity.</p>
    pub fn set_severity(mut self, input: ::std::option::Option<crate::types::SeverityUpdate>) -> Self {
        self.inner = self.inner.set_severity(input);
        self
    }
    /// <p>Used to update the finding severity.</p>
    pub fn get_severity(&self) -> &::std::option::Option<crate::types::SeverityUpdate> {
        self.inner.get_severity()
    }
    /// <p>Indicates the veracity of a finding.</p>
    /// <p>The available values for <code>VerificationState</code> are as follows.</p>
    /// <ul>
    /// <li>
    /// <p><code>UNKNOWN</code> – The default disposition of a security finding</p></li>
    /// <li>
    /// <p><code>TRUE_POSITIVE</code> – The security finding is confirmed</p></li>
    /// <li>
    /// <p><code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm</p></li>
    /// <li>
    /// <p><code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both</p></li>
    /// </ul>
    pub fn verification_state(mut self, input: crate::types::VerificationState) -> Self {
        self.inner = self.inner.verification_state(input);
        self
    }
    /// <p>Indicates the veracity of a finding.</p>
    /// <p>The available values for <code>VerificationState</code> are as follows.</p>
    /// <ul>
    /// <li>
    /// <p><code>UNKNOWN</code> – The default disposition of a security finding</p></li>
    /// <li>
    /// <p><code>TRUE_POSITIVE</code> – The security finding is confirmed</p></li>
    /// <li>
    /// <p><code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm</p></li>
    /// <li>
    /// <p><code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both</p></li>
    /// </ul>
    pub fn set_verification_state(mut self, input: ::std::option::Option<crate::types::VerificationState>) -> Self {
        self.inner = self.inner.set_verification_state(input);
        self
    }
    /// <p>Indicates the veracity of a finding.</p>
    /// <p>The available values for <code>VerificationState</code> are as follows.</p>
    /// <ul>
    /// <li>
    /// <p><code>UNKNOWN</code> – The default disposition of a security finding</p></li>
    /// <li>
    /// <p><code>TRUE_POSITIVE</code> – The security finding is confirmed</p></li>
    /// <li>
    /// <p><code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm</p></li>
    /// <li>
    /// <p><code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both</p></li>
    /// </ul>
    pub fn get_verification_state(&self) -> &::std::option::Option<crate::types::VerificationState> {
        self.inner.get_verification_state()
    }
    /// <p>The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p>
    /// <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>
    pub fn confidence(mut self, input: i32) -> Self {
        self.inner = self.inner.confidence(input);
        self
    }
    /// <p>The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p>
    /// <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>
    pub fn set_confidence(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_confidence(input);
        self
    }
    /// <p>The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p>
    /// <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>
    pub fn get_confidence(&self) -> &::std::option::Option<i32> {
        self.inner.get_confidence()
    }
    /// <p>The updated value for the level of importance assigned to the resources associated with the findings.</p>
    /// <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>
    pub fn criticality(mut self, input: i32) -> Self {
        self.inner = self.inner.criticality(input);
        self
    }
    /// <p>The updated value for the level of importance assigned to the resources associated with the findings.</p>
    /// <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>
    pub fn set_criticality(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_criticality(input);
        self
    }
    /// <p>The updated value for the level of importance assigned to the resources associated with the findings.</p>
    /// <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>
    pub fn get_criticality(&self) -> &::std::option::Option<i32> {
        self.inner.get_criticality()
    }
    ///
    /// Appends an item to `Types`.
    ///
    /// To override the contents of this collection use [`set_types`](Self::set_types).
    ///
    /// <p>One or more finding types in the format of namespace/category/classifier that classify a finding.</p>
    /// <p>Valid namespace values are as follows.</p>
    /// <ul>
    /// <li>
    /// <p>Software and Configuration Checks</p></li>
    /// <li>
    /// <p>TTPs</p></li>
    /// <li>
    /// <p>Effects</p></li>
    /// <li>
    /// <p>Unusual Behaviors</p></li>
    /// <li>
    /// <p>Sensitive Data Identifications</p></li>
    /// </ul>
    pub fn types(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.types(input.into());
        self
    }
    /// <p>One or more finding types in the format of namespace/category/classifier that classify a finding.</p>
    /// <p>Valid namespace values are as follows.</p>
    /// <ul>
    /// <li>
    /// <p>Software and Configuration Checks</p></li>
    /// <li>
    /// <p>TTPs</p></li>
    /// <li>
    /// <p>Effects</p></li>
    /// <li>
    /// <p>Unusual Behaviors</p></li>
    /// <li>
    /// <p>Sensitive Data Identifications</p></li>
    /// </ul>
    pub fn set_types(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_types(input);
        self
    }
    /// <p>One or more finding types in the format of namespace/category/classifier that classify a finding.</p>
    /// <p>Valid namespace values are as follows.</p>
    /// <ul>
    /// <li>
    /// <p>Software and Configuration Checks</p></li>
    /// <li>
    /// <p>TTPs</p></li>
    /// <li>
    /// <p>Effects</p></li>
    /// <li>
    /// <p>Unusual Behaviors</p></li>
    /// <li>
    /// <p>Sensitive Data Identifications</p></li>
    /// </ul>
    pub fn get_types(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_types()
    }
    ///
    /// Adds a key-value pair to `UserDefinedFields`.
    ///
    /// To override the contents of this collection use [`set_user_defined_fields`](Self::set_user_defined_fields).
    ///
    /// <p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p>
    pub fn user_defined_fields(
        mut self,
        k: impl ::std::convert::Into<::std::string::String>,
        v: impl ::std::convert::Into<::std::string::String>,
    ) -> Self {
        self.inner = self.inner.user_defined_fields(k.into(), v.into());
        self
    }
    /// <p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p>
    pub fn set_user_defined_fields(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    ) -> Self {
        self.inner = self.inner.set_user_defined_fields(input);
        self
    }
    /// <p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p>
    pub fn get_user_defined_fields(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.inner.get_user_defined_fields()
    }
    /// <p>Used to update the workflow status of a finding.</p>
    /// <p>The workflow status indicates the progress of the investigation into the finding.</p>
    pub fn workflow(mut self, input: crate::types::WorkflowUpdate) -> Self {
        self.inner = self.inner.workflow(input);
        self
    }
    /// <p>Used to update the workflow status of a finding.</p>
    /// <p>The workflow status indicates the progress of the investigation into the finding.</p>
    pub fn set_workflow(mut self, input: ::std::option::Option<crate::types::WorkflowUpdate>) -> Self {
        self.inner = self.inner.set_workflow(input);
        self
    }
    /// <p>Used to update the workflow status of a finding.</p>
    /// <p>The workflow status indicates the progress of the investigation into the finding.</p>
    pub fn get_workflow(&self) -> &::std::option::Option<crate::types::WorkflowUpdate> {
        self.inner.get_workflow()
    }
    ///
    /// Appends an item to `RelatedFindings`.
    ///
    /// To override the contents of this collection use [`set_related_findings`](Self::set_related_findings).
    ///
    /// <p>A list of findings that are related to the updated findings.</p>
    pub fn related_findings(mut self, input: crate::types::RelatedFinding) -> Self {
        self.inner = self.inner.related_findings(input);
        self
    }
    /// <p>A list of findings that are related to the updated findings.</p>
    pub fn set_related_findings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RelatedFinding>>) -> Self {
        self.inner = self.inner.set_related_findings(input);
        self
    }
    /// <p>A list of findings that are related to the updated findings.</p>
    pub fn get_related_findings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RelatedFinding>> {
        self.inner.get_related_findings()
    }
}