Skip to content

Finding

Source code in docs_src/capo_resiliencehubv2/types/finding.py
class Finding(TypedDict, closed=True):
    finding_id: NotRequired["capo_resiliencehubv2.types.uuid.Uuid"]
    """<p>The unique identifier of the finding.</p>"""
    name: NotRequired["str"]
    """<p>The name of the finding.</p>"""
    description: NotRequired[
        "capo_resiliencehubv2.types.entity_description.EntityDescription"
    ]
    failure_category: NotRequired[
        "capo_resiliencehubv2.types.failure_category.FailureCategory"
    ]
    """<p>The failure category of the finding.</p>"""
    status: NotRequired["capo_resiliencehubv2.types.finding_status.FindingStatus"]
    """<p>The current status of the finding.</p>"""
    reasoning: NotRequired["str"]
    """<p>The reasoning behind the finding.</p>"""
    comment: NotRequired["str"]
    """<p>A user-provided comment about the finding.</p>"""
    severity: NotRequired["capo_resiliencehubv2.types.finding_severity.FindingSeverity"]
    """<p>The severity of the finding.</p>"""
    service_functions: NotRequired[
        "capo_resiliencehubv2.types.functions_list.FunctionsList"
    ]
    """<p>The service functions associated with the finding.</p>"""
    policy_component: NotRequired[
        "capo_resiliencehubv2.types.policy_component.PolicyComponent"
    ]
    """<p>The policy component associated with the finding.</p>"""
    infrastructure_and_code_recommendations: NotRequired[
        "capo_resiliencehubv2.types.infrastructure_and_code_recommendations_list.InfrastructureAndCodeRecommendationsList"
    ]
    """<p>Infrastructure and code recommendations to address the finding.</p>"""
    observability_recommendations: NotRequired[
        "capo_resiliencehubv2.types.observability_recommendations_list.ObservabilityRecommendationsList"
    ]
    """<p>Observability recommendations to address the finding.</p>"""
    testing_recommendations: NotRequired[
        "capo_resiliencehubv2.types.testing_recommendations_list.TestingRecommendationsList"
    ]
    """<p>Testing recommendations to address the finding.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the finding was last updated.</p>"""
    investigation_deep_link: NotRequired["str"]
    """<p>A deep link to an interactive DevOps Agent investigation seeded with this finding. This value is null until DevOps Agent creates an investigation.</p>"""

comment instance-attribute

comment: NotRequired[str]

A user-provided comment about the finding.

description instance-attribute

description: NotRequired[EntityDescription]

failure_category instance-attribute

failure_category: NotRequired[FailureCategory]

The failure category of the finding.

finding_id instance-attribute

finding_id: NotRequired[Uuid]

The unique identifier of the finding.

infrastructure_and_code_recommendations instance-attribute

infrastructure_and_code_recommendations: NotRequired[
    InfrastructureAndCodeRecommendationsList
]

Infrastructure and code recommendations to address the finding.

investigation_deep_link: NotRequired[str]

A deep link to an interactive DevOps Agent investigation seeded with this finding. This value is null until DevOps Agent creates an investigation.

name instance-attribute

name: NotRequired[str]

The name of the finding.

observability_recommendations instance-attribute

observability_recommendations: NotRequired[ObservabilityRecommendationsList]

Observability recommendations to address the finding.

policy_component instance-attribute

policy_component: NotRequired[PolicyComponent]

The policy component associated with the finding.

reasoning instance-attribute

reasoning: NotRequired[str]

The reasoning behind the finding.

service_functions instance-attribute

service_functions: NotRequired[FunctionsList]

The service functions associated with the finding.

severity instance-attribute

severity: NotRequired[FindingSeverity]

The severity of the finding.

status instance-attribute

status: NotRequired[FindingStatus]

The current status of the finding.

testing_recommendations instance-attribute

testing_recommendations: NotRequired[TestingRecommendationsList]

Testing recommendations to address the finding.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The timestamp when the finding was last updated.