Skip to content

BatchUpdateFindingsRequest

Source code in docs_src/capo_securityhub/types/batch_update_findings_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class BatchUpdateFindingsRequest(TypedDict, closed=True):
    finding_identifiers: NotRequired[
        "capo_securityhub.types.aws_security_finding_identifier_list.AwsSecurityFindingIdentifierList"
    ]
    """<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>"""
    note: NotRequired["capo_securityhub.types.note_update.NoteUpdate"]
    severity: NotRequired["capo_securityhub.types.severity_update.SeverityUpdate"]
    """<p>Used to update the finding severity.</p>"""
    verification_state: NotRequired[
        "capo_securityhub.types.verification_state.VerificationState"
    ]
    """<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>"""
    confidence: NotRequired["capo_securityhub.types.ratio_scale.RatioScale"]
    """<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>"""
    criticality: NotRequired["capo_securityhub.types.ratio_scale.RatioScale"]
    """<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>"""
    types: NotRequired["capo_securityhub.types.type_list.TypeList"]
    """<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>"""
    user_defined_fields: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p>"""
    workflow: NotRequired["capo_securityhub.types.workflow_update.WorkflowUpdate"]
    """<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>"""
    related_findings: NotRequired[
        "capo_securityhub.types.related_finding_list.RelatedFindingList"
    ]
    """<p>A list of findings that are related to the updated findings.</p>"""

confidence instance-attribute 

confidence: NotRequired[RatioScale]

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 instance-attribute 

criticality: NotRequired[RatioScale]

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.

finding_identifiers instance-attribute 

finding_identifiers: NotRequired[AwsSecurityFindingIdentifierList]

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.

note instance-attribute 

note: NotRequired[NoteUpdate]

related_findings instance-attribute 

related_findings: NotRequired[RelatedFindingList]

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

severity instance-attribute 

severity: NotRequired[SeverityUpdate]

Used to update the finding severity.

types instance-attribute 

types: NotRequired[TypeList]

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

user_defined_fields instance-attribute 

user_defined_fields: NotRequired[FieldMap]

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

verification_state instance-attribute 

verification_state: NotRequired[VerificationState]

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

workflow instance-attribute 

workflow: NotRequired[WorkflowUpdate]

Used to update the workflow status of a finding.

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