Skip to content

Finding

Source code in docs_src/capo_codeguru_security/types/finding.py
class Finding(TypedDict, closed=True):
    created_at: NotRequired["datetime.datetime"]
    """<p>The time when the finding was created.</p>"""
    description: NotRequired["str"]
    """<p>A description of the finding.</p>"""
    generator_id: NotRequired["str"]
    """<p>The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.</p>"""
    id: NotRequired["str"]
    """<p>The identifier for a finding.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes. </p>"""
    type: NotRequired["str"]
    """<p>The type of finding. </p>"""
    status: NotRequired["capo_codeguru_security.types.status.Status"]
    """<p>The status of the finding. A finding status can be open or closed. </p>"""
    resource: NotRequired["capo_codeguru_security.types.resource.Resource"]
    """<p>The resource where Amazon CodeGuru Security detected a finding.</p>"""
    vulnerability: NotRequired[
        "capo_codeguru_security.types.vulnerability.Vulnerability"
    ]
    """<p>An object that describes the detected security vulnerability.</p>"""
    severity: NotRequired["capo_codeguru_security.types.severity.Severity"]
    """<p>The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution">Finding severity</a> in the <i>Amazon CodeGuru Security User Guide</i>.</p>"""
    remediation: NotRequired["capo_codeguru_security.types.remediation.Remediation"]
    """<p>An object that contains the details about how to remediate a finding.</p>"""
    title: NotRequired["str"]
    """<p>The title of the finding.</p>"""
    detector_tags: NotRequired[
        "capo_codeguru_security.types.detector_tags.DetectorTags"
    ]
    """<p>One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.</p>"""
    detector_id: NotRequired["str"]
    """<p>The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices. </p>"""
    detector_name: NotRequired["str"]
    """<p>The name of the detector that identified the security vulnerability in your code. </p>"""
    rule_id: NotRequired["str"]
    """<p>The identifier for the rule that generated the finding.</p>"""

created_at instance-attribute

created_at: NotRequired[datetime]

The time when the finding was created.

description instance-attribute

description: NotRequired[str]

A description of the finding.

detector_id instance-attribute

detector_id: NotRequired[str]

The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.

detector_name instance-attribute

detector_name: NotRequired[str]

The name of the detector that identified the security vulnerability in your code.

detector_tags instance-attribute

detector_tags: NotRequired[DetectorTags]

One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.

generator_id instance-attribute

generator_id: NotRequired[str]

The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

id instance-attribute

id: NotRequired[str]

The identifier for a finding.

remediation instance-attribute

remediation: NotRequired[Remediation]

An object that contains the details about how to remediate a finding.

resource instance-attribute

resource: NotRequired[Resource]

The resource where Amazon CodeGuru Security detected a finding.

rule_id instance-attribute

rule_id: NotRequired[str]

The identifier for the rule that generated the finding.

severity instance-attribute

severity: NotRequired[Severity]

The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.

status instance-attribute

status: NotRequired[Status]

The status of the finding. A finding status can be open or closed.

title instance-attribute

title: NotRequired[str]

The title of the finding.

type instance-attribute

type: NotRequired[str]

The type of finding.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

vulnerability instance-attribute

vulnerability: NotRequired[Vulnerability]

An object that describes the detected security vulnerability.