Skip to content

Investigation

Structure Class

Investigation dataclass

Bases: _SerdeShape

Contains the details and results of a GuardDuty investigation.

Attributes

cloud class-attribute instance-attribute
cloud: CloudDetails | None = ...

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

confidence class-attribute instance-attribute
confidence: str | None = ...

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

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The timestamp at which the investigation completed.

error class-attribute instance-attribute
error: str | None = ...

Details about the error if the investigation status is FAILED.

investigation_id class-attribute instance-attribute
investigation_id: str | None = ...

The unique identifier of the investigation.

metadata class-attribute instance-attribute
metadata: InvestigationMetadata | None = ...

Metadata about the product and version that produced the investigation.

risk class-attribute instance-attribute
risk: str | None = ...

A human-readable description of the assessed risk.

risk_level class-attribute instance-attribute
risk_level: str | None = ...

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

scope class-attribute instance-attribute
scope: InvestigationScope | None = ...

Information about what the investigation analyzed, including the investigation type, the finding, account, or organization that was analyzed, and, for ACCOUNT and ORGANIZATION investigations, the time window over which the investigation queried data. Returned only when the investigation status is COMPLETED.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The timestamp at which the investigation started.

status class-attribute instance-attribute
status: str | None = ...

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

summary class-attribute instance-attribute
summary: str | None = ...

A summary of the investigation results as text, up to 262,144 characters. Returned only when the investigation status is COMPLETED. When you set SummaryFormat to STRUCTURED, the summary is returned in SummaryData instead, unless it isn't available in a structured form, in which case it's returned in this field.

summary_data class-attribute instance-attribute
summary_data: InvestigationSummaryData | None = ...

A structured summary of the investigation results. GuardDuty returns this field only when you set SummaryFormat to STRUCTURED, the investigation status is COMPLETED, and the summary is available in a structured form. When this field is returned, Summary isn't returned.

trigger_prompt class-attribute instance-attribute
trigger_prompt: str | None = ...

The natural-language prompt that initiated this investigation.

triggered_by class-attribute instance-attribute
triggered_by: str | None = ...

The account that initiated the investigation.