get_investigation¶
Operation¶
async
¶
get_investigation(input: GetInvestigationInput, plugins: list[Plugin] | None = None) -> GetInvestigationOutput
This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Retrieves the results and status of a specific GuardDuty investigation.
An administrator account can retrieve any investigation within the organization. Member accounts can only retrieve investigations that belong to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetInvestigationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetInvestigationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetInvestigationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the GuardDuty detector associated with the investigation.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
class-attribute
instance-attribute
¶
investigation_id: str | None = None
The unique identifier of the investigation to retrieve.
Output¶
dataclass
¶
Dataclass for GetInvestigationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
investigation: Investigation | None = None
The details and results of the requested investigation.