SecurityHub / Client / batch_update_findings

batch_update_findings

SecurityHub.Client.batch_update_findings(**kwargs)

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 don’t 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.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_findings(
    FindingIdentifiers=[
        {
            'Id': 'string',
            'ProductArn': 'string'
        },
    ],
    Note={
        'Text': 'string',
        'UpdatedBy': 'string'
    },
    Severity={
        'Normalized': 123,
        'Product': 123.0,
        'Label': 'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'
    },
    VerificationState='UNKNOWN'|'TRUE_POSITIVE'|'FALSE_POSITIVE'|'BENIGN_POSITIVE',
    Confidence=123,
    Criticality=123,
    Types=[
        'string',
    ],
    UserDefinedFields={
        'string': 'string'
    },
    Workflow={
        'Status': 'NEW'|'NOTIFIED'|'RESOLVED'|'SUPPRESSED'
    },
    RelatedFindings=[
        {
            'ProductArn': 'string',
            'Id': 'string'
        },
    ]
)

Parameters:

• FindingIdentifiers (list) –

  [REQUIRED]

  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.

  • (dict) –

    Identifies which finding to get the finding history for.

    • Id (string) – [REQUIRED]

      The identifier of the finding that was specified by the finding provider.

    • ProductArn (string) – [REQUIRED]

      The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

• Note (dict) –

  The updated note.

  • Text (string) – [REQUIRED]

    The updated note text.

  • UpdatedBy (string) – [REQUIRED]

    The principal that updated the note.

• Severity (dict) –

  Used to update the finding severity.

  • Normalized (integer) –

    The normalized severity for the finding. This attribute is to be deprecated in favor of Label.

    If you provide Normalized and don’t provide Label, Label is set automatically as follows.

    • 0 - INFORMATIONAL

    • 1–39 - LOW

    • 40–69 - MEDIUM

    • 70–89 - HIGH

    • 90–100 - CRITICAL

  • Product (float) –

    The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.

  • Label (string) –

    The severity value of the finding. The allowed values are the following.

    • INFORMATIONAL - No issue was found.

    • LOW - The issue does not require action on its own.

    • MEDIUM - The issue must be addressed but not urgently.

    • HIGH - The issue must be addressed as a priority.

    • CRITICAL - The issue must be remediated immediately to avoid it escalating.

• VerificationState (string) –

  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

• Confidence (integer) –

  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.

• Criticality (integer) –

  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.

• Types (list) –

  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

  • (string) –

• UserDefinedFields (dict) –

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

  • (string) –

    • (string) –

• Workflow (dict) –

  Used to update the workflow status of a finding.

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

  • Status (string) –

    The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

    The allowed values are the following.

    • NEW - The initial state of a finding, before it is reviewed. Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases:

      • The record state changes from ARCHIVED to ACTIVE.

      • The compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

    • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

    • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

    • SUPPRESSED - Indicates that you reviewed the finding and don’t believe that any action is needed. The finding is no longer updated.

• RelatedFindings (list) –

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

  • (dict) –

    Details about a related finding.

    • ProductArn (string) – [REQUIRED]

      The ARN of the product that generated a related finding.

    • Id (string) – [REQUIRED]

      The product-generated identifier for a related finding.

Return type:

dict

Returns:

Response Syntax

{
    'ProcessedFindings': [
        {
            'Id': 'string',
            'ProductArn': 'string'
        },
    ],
    'UnprocessedFindings': [
        {
            'FindingIdentifier': {
                'Id': 'string',
                'ProductArn': 'string'
            },
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • ProcessedFindings (list) –

    The list of findings that were updated successfully.

    • (dict) –

      Identifies which finding to get the finding history for.

      • Id (string) –

        The identifier of the finding that was specified by the finding provider.

      • ProductArn (string) –

        The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

  • UnprocessedFindings (list) –

    The list of findings that were not updated.

    • (dict) –

      A finding from a BatchUpdateFindings request that Security Hub was unable to update.

      • FindingIdentifier (dict) –

        The identifier of the finding that was not updated.

        • Id (string) –

          The identifier of the finding that was specified by the finding provider.

        • ProductArn (string) –

          The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

      • ErrorCode (string) –

        The code associated with the error. Possible values are:

        • ConcurrentUpdateError - Another request attempted to update the finding while this request was being processed. This error may also occur if you call BatchUpdateFindings and BatchImportFindings at the same time.

        • DuplicatedFindingIdentifier - The request included two or more findings with the same FindingIdentifier.

        • FindingNotFound - The FindingIdentifier included in the request did not match an existing finding.

        • FindingSizeExceeded - The finding size was greater than the permissible value of 240 KB.

        • InternalFailure - An internal service failure occurred when updating the finding.

        • InvalidInput - The finding update contained an invalid value that did not satisfy the Amazon Web Services Security Finding Format syntax.

      • ErrorMessage (string) –

        The message associated with the error. Possible values are:

        • Concurrent finding updates detected

        • Finding Identifier is duplicated

        • Finding Not Found

        • Finding size exceeded 240 KB

        • Internal service failure

        • Invalid Input

Exceptions

• SecurityHub.Client.exceptions.InternalException

• SecurityHub.Client.exceptions.InvalidInputException

• SecurityHub.Client.exceptions.LimitExceededException

• SecurityHub.Client.exceptions.InvalidAccessException