Skip to content

Investigation

Source code in docs_src/capo_guardduty/types/investigation.py
class Investigation(TypedDict, closed=True):
    investigation_id: NotRequired[
        "capo_guardduty.types.investigation_id.InvestigationId"
    ]
    """<p>The unique identifier of the investigation.</p>"""
    status: NotRequired["capo_guardduty.types.investigation_status.InvestigationStatus"]
    """<p>The current status of the investigation. Possible values are <code>RUNNING</code>, <code>COMPLETED</code>, and <code>FAILED</code>.</p>"""
    trigger_prompt: NotRequired["capo_guardduty.types.trigger_prompt.TriggerPrompt"]
    """<p>The natural-language prompt that initiated this investigation.</p>"""
    triggered_by: NotRequired["capo_guardduty.types.triggered_by.TriggeredBy"]
    """<p>The account that initiated the investigation.</p>"""
    metadata: NotRequired[
        "capo_guardduty.types.investigation_metadata.InvestigationMetadata"
    ]
    """<p>Metadata about the product and version that produced the investigation.</p>"""
    cloud: NotRequired["capo_guardduty.types.cloud_details.CloudDetails"]
    """<p>Details about the cloud environment in which the investigation was performed, including the provider, region, and account.</p>"""
    risk_level: NotRequired["capo_guardduty.types.risk_level.RiskLevel"]
    """<p>The assessed risk level of the investigated threat. Possible values are <code>Info</code>, <code>Low</code>, <code>Medium</code>, <code>High</code>, and <code>Critical</code>.</p>"""
    risk: NotRequired["capo_guardduty.types.risk_details.RiskDetails"]
    """<p>A human-readable description of the assessed risk.</p>"""
    confidence: NotRequired["capo_guardduty.types.confidence.Confidence"]
    """<p>The confidence level of the investigation's assessment. Possible values are <code>Unknown</code>, <code>Low</code>, <code>Medium</code>, and <code>High</code>.</p>"""
    summary: NotRequired["capo_guardduty.types.string.String"]
    """<p>A structured summary of the investigation findings, including affected resources, threat assessment, and recommended remediation steps.</p>"""
    start_time: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp at which the investigation started.</p>"""
    end_time: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp at which the investigation completed.</p>"""
    error: NotRequired[
        "capo_guardduty.types.investigation_error_details.InvestigationErrorDetails"
    ]
    """<p>Details about the error if the investigation status is <code>FAILED</code>.</p>"""

cloud instance-attribute

cloud: NotRequired[CloudDetails]

Details about the cloud environment in which the investigation was performed, including the provider, region, and account.

confidence instance-attribute

confidence: NotRequired[Confidence]

The confidence level of the investigation's assessment. Possible values are Unknown, Low, Medium, and High.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The timestamp at which the investigation completed.

error instance-attribute

error: NotRequired[InvestigationErrorDetails]

Details about the error if the investigation status is FAILED.

investigation_id instance-attribute

investigation_id: NotRequired[InvestigationId]

The unique identifier of the investigation.

metadata instance-attribute

metadata: NotRequired[InvestigationMetadata]

Metadata about the product and version that produced the investigation.

risk instance-attribute

risk: NotRequired[RiskDetails]

A human-readable description of the assessed risk.

risk_level instance-attribute

risk_level: NotRequired[RiskLevel]

The assessed risk level of the investigated threat. Possible values are Info, Low, Medium, High, and Critical.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The timestamp at which the investigation started.

status instance-attribute

status: NotRequired[InvestigationStatus]

The current status of the investigation. Possible values are RUNNING, COMPLETED, and FAILED.

summary instance-attribute

summary: NotRequired[String]

A structured summary of the investigation findings, including affected resources, threat assessment, and recommended remediation steps.

trigger_prompt instance-attribute

trigger_prompt: NotRequired[TriggerPrompt]

The natural-language prompt that initiated this investigation.

triggered_by instance-attribute

triggered_by: NotRequired[TriggeredBy]

The account that initiated the investigation.