Struct aws_sdk_securityhub::client::fluent_builders::BatchUpdateFindings

pub struct BatchUpdateFindings<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to BatchUpdateFindings.

Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.

Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

• Confidence

• Criticality

• Note

• RelatedFindings

• Severity

• Types

• UserDefinedFields

• VerificationState

• Workflow

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. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.

Implementations

impl<C, M, R> BatchUpdateFindings<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<BatchUpdateFindingsOutput, SdkError<BatchUpdateFindingsError>> where
    R::Policy: SmithyRetryPolicy<BatchUpdateFindingsInputOperationOutputAlias, BatchUpdateFindingsOutput, BatchUpdateFindingsError, BatchUpdateFindingsInputOperationRetryAlias>, 

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, which can be set when configuring the client.

pub fn finding_identifiers(self, input: AwsSecurityFindingIdentifier) -> Self

Appends an item to FindingIdentifiers.

To override the contents of this collection use set_finding_identifiers.

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

pub fn set_finding_identifiers(
    self,
    input: Option<Vec<AwsSecurityFindingIdentifier>>
) -> Self

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

pub fn note(self, input: NoteUpdate) -> Self

The updated note.

pub fn set_note(self, input: Option<NoteUpdate>) -> Self

The updated note.

pub fn severity(self, input: SeverityUpdate) -> Self

Used to update the finding severity.

pub fn set_severity(self, input: Option<SeverityUpdate>) -> Self

Used to update the finding severity.

pub fn verification_state(self, input: VerificationState) -> Self

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

pub fn set_verification_state(self, input: Option<VerificationState>) -> Self

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

pub fn confidence(self, input: i32) -> Self

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.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

pub fn set_confidence(self, input: Option<i32>) -> Self

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.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

pub fn criticality(self, input: i32) -> Self

The updated value for the level of importance assigned to the resources associated with the findings.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

pub fn set_criticality(self, input: Option<i32>) -> Self

The updated value for the level of importance assigned to the resources associated with the findings.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

pub fn types(self, input: impl Into<String>) -> Self

Appends an item to Types.

To override the contents of this collection use set_types.

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

pub fn set_types(self, input: Option<Vec<String>>) -> Self

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

pub fn user_defined_fields(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to UserDefinedFields.

To override the contents of this collection use set_user_defined_fields.

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

pub fn set_user_defined_fields(
    self,
    input: Option<HashMap<String, String>>
) -> Self

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

pub fn workflow(self, input: WorkflowUpdate) -> Self

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

pub fn set_workflow(self, input: Option<WorkflowUpdate>) -> Self

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

pub fn related_findings(self, input: RelatedFinding) -> Self

Appends an item to RelatedFindings.

To override the contents of this collection use set_related_findings.

A list of findings that are related to the updated findings.

pub fn set_related_findings(self, input: Option<Vec<RelatedFinding>>) -> Self

A list of findings that are related to the updated findings.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for BatchUpdateFindings<C, M, R>

fn clone(&self) -> BatchUpdateFindings<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for BatchUpdateFindings<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.