aws_sdk_securityhub/client/

batch_update_findings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchUpdateFindings`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`finding_identifiers(AwsSecurityFindingIdentifier)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::finding_identifiers) / [`set_finding_identifiers(Option<Vec::<AwsSecurityFindingIdentifier>>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_finding_identifiers):<br>required: **true**<br><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><br>
    ///   - [`note(NoteUpdate)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::note) / [`set_note(Option<NoteUpdate>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_note):<br>required: **false**<br><p>The updated note.</p><br>
    ///   - [`severity(SeverityUpdate)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::severity) / [`set_severity(Option<SeverityUpdate>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_severity):<br>required: **false**<br><p>Used to update the finding severity.</p><br>
    ///   - [`verification_state(VerificationState)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::verification_state) / [`set_verification_state(Option<VerificationState>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_verification_state):<br>required: **false**<br><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><br>
    ///   - [`confidence(i32)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::confidence) / [`set_confidence(Option<i32>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_confidence):<br>required: **false**<br><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><br>
    ///   - [`criticality(i32)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::criticality) / [`set_criticality(Option<i32>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_criticality):<br>required: **false**<br><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><br>
    ///   - [`types(impl Into<String>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::types) / [`set_types(Option<Vec::<String>>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_types):<br>required: **false**<br><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><br>
    ///   - [`user_defined_fields(impl Into<String>, impl Into<String>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::user_defined_fields) / [`set_user_defined_fields(Option<HashMap::<String, String>>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_user_defined_fields):<br>required: **false**<br><p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p><br>
    ///   - [`workflow(WorkflowUpdate)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::workflow) / [`set_workflow(Option<WorkflowUpdate>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_workflow):<br>required: **false**<br><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><br>
    ///   - [`related_findings(RelatedFinding)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::related_findings) / [`set_related_findings(Option<Vec::<RelatedFinding>>)`](crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::set_related_findings):<br>required: **false**<br><p>A list of findings that are related to the updated findings.</p><br>
    /// - On success, responds with [`BatchUpdateFindingsOutput`](crate::operation::batch_update_findings::BatchUpdateFindingsOutput) with field(s):
    ///   - [`processed_findings(Option<Vec::<AwsSecurityFindingIdentifier>>)`](crate::operation::batch_update_findings::BatchUpdateFindingsOutput::processed_findings): <p>The list of findings that were updated successfully.</p>
    ///   - [`unprocessed_findings(Option<Vec::<BatchUpdateFindingsUnprocessedFinding>>)`](crate::operation::batch_update_findings::BatchUpdateFindingsOutput::unprocessed_findings): <p>The list of findings that were not updated.</p>
    /// - On failure, responds with [`SdkError<BatchUpdateFindingsError>`](crate::operation::batch_update_findings::BatchUpdateFindingsError)
    pub fn batch_update_findings(&self) -> crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder {
        crate::operation::batch_update_findings::builders::BatchUpdateFindingsFluentBuilder::new(self.handle.clone())
    }
}