Skip to content

Finding

Source code in docs_src/capo_inspector/types/finding.py
class Finding(TypedDict, closed=True):
    arn: "capo_inspector.types.arn.Arn"
    """<p>The ARN that specifies the finding.</p>"""
    schema_version: "capo_inspector.types.numeric_version.NumericVersion"
    """<p>The schema version of this data type.</p>"""
    service: NotRequired["capo_inspector.types.service_name.ServiceName"]
    """<p>The data element is set to "Inspector".</p>"""
    service_attributes: NotRequired[
        "capo_inspector.types.inspector_service_attributes.InspectorServiceAttributes"
    ]
    """<p>This data type is used in the <a>Finding</a> data type.</p>"""
    asset_type: NotRequired["capo_inspector.types.asset_type.AssetType"]
    """<p>The type of the host from which the finding is generated.</p>"""
    asset_attributes: NotRequired[
        "capo_inspector.types.asset_attributes.AssetAttributes"
    ]
    """<p>A collection of attributes of the host from which the finding is generated.</p>"""
    id: NotRequired["capo_inspector.types.finding_id.FindingId"]
    """<p>The ID of the finding.</p>"""
    title: NotRequired["capo_inspector.types.text.Text"]
    """<p>The name of the finding.</p>"""
    description: NotRequired["capo_inspector.types.text.Text"]
    """<p>The description of the finding.</p>"""
    recommendation: NotRequired["capo_inspector.types.text.Text"]
    """<p>The recommendation for the finding.</p>"""
    severity: NotRequired["capo_inspector.types.severity.Severity"]
    """<p>The finding severity. Values can be set to High, Medium, Low, and Informational.</p>"""
    numeric_severity: "capo_inspector.types.numeric_severity.NumericSeverity"
    """<p>The numeric value of the finding severity.</p>"""
    confidence: "capo_inspector.types.ioc_confidence.IocConfidence"
    """<p>This data element is currently not used.</p>"""
    indicator_of_compromise: NotRequired["capo_inspector.types.bool.Bool"]
    """<p>This data element is currently not used.</p>"""
    attributes: "capo_inspector.types.attribute_list.AttributeList"
    """<p>The system-defined attributes for the finding.</p>"""
    user_attributes: "capo_inspector.types.user_attribute_list.UserAttributeList"
    """<p>The user-defined attributes that are assigned to the finding.</p>"""
    created_at: "capo_inspector.types.timestamp.Timestamp"
    """<p>The time when the finding was generated.</p>"""
    updated_at: "capo_inspector.types.timestamp.Timestamp"
    """<p>The time when <a>AddAttributesToFindings</a> is called.</p>"""

arn instance-attribute

arn: Arn

The ARN that specifies the finding.

asset_attributes instance-attribute

asset_attributes: NotRequired[AssetAttributes]

A collection of attributes of the host from which the finding is generated.

asset_type instance-attribute

asset_type: NotRequired[AssetType]

The type of the host from which the finding is generated.

attributes instance-attribute

attributes: AttributeList

The system-defined attributes for the finding.

confidence instance-attribute

confidence: IocConfidence

This data element is currently not used.

created_at instance-attribute

created_at: Timestamp

The time when the finding was generated.

description instance-attribute

description: NotRequired[Text]

The description of the finding.

id instance-attribute

id: NotRequired[FindingId]

The ID of the finding.

indicator_of_compromise instance-attribute

indicator_of_compromise: NotRequired[Bool]

This data element is currently not used.

numeric_severity instance-attribute

numeric_severity: NumericSeverity

The numeric value of the finding severity.

recommendation instance-attribute

recommendation: NotRequired[Text]

The recommendation for the finding.

schema_version instance-attribute

schema_version: NumericVersion

The schema version of this data type.

service instance-attribute

service: NotRequired[ServiceName]

The data element is set to "Inspector".

service_attributes instance-attribute

service_attributes: NotRequired[InspectorServiceAttributes]

This data type is used in the Finding data type.

severity instance-attribute

severity: NotRequired[Severity]

The finding severity. Values can be set to High, Medium, Low, and Informational.

title instance-attribute

title: NotRequired[Text]

The name of the finding.

updated_at instance-attribute

updated_at: Timestamp

The time when AddAttributesToFindings is called.

user_attributes instance-attribute

user_attributes: UserAttributeList

The user-defined attributes that are assigned to the finding.