get_investigation¶
Operation¶
get_investigation
¶
get_investigation(request: GetInvestigationInput | GetInvestigationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInvestigationInputDict]) -> 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.
GuardDuty returns the results, including the summary and the scope of
the investigation, only when the investigation status is COMPLETED. By
default, GuardDuty returns the summary as text in Summary. To return a
typed summary in SummaryData instead, set SummaryFormat to
STRUCTURED.
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 |
|---|---|---|---|
request
|
GetInvestigationInput | GetInvestigationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetInvestigationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetInvestigationOutput
|
An instance of |
get_investigation
async
¶
get_investigation(request: GetInvestigationInput | GetInvestigationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInvestigationInputDict]) -> 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.
GuardDuty returns the results, including the summary and the scope of
the investigation, only when the investigation status is COMPLETED. By
default, GuardDuty returns the summary as text in Summary. To return a
typed summary in SummaryData instead, set SummaryFormat to
STRUCTURED.
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 |
|---|---|---|---|
request
|
GetInvestigationInput | GetInvestigationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetInvestigationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetInvestigationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetInvestigationInputDict
¶
Bases: TypedDict
Dictionary form of GetInvestigationInput.
Attributes¶
detector_id
instance-attribute
¶
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.
investigation_id
instance-attribute
¶
The unique identifier of the investigation to retrieve.
summary_format
instance-attribute
¶
summary_format: str | None
The format in which to return the investigation summary. Possible values:
-
STRING-- (Default) Returns the summary as text inSummary. -
STRUCTURED-- Returns a typed summary inSummaryData.
GuardDuty returns a summary only when the investigation status is
COMPLETED.
GetInvestigationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetInvestigationInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
investigation_id
class-attribute
instance-attribute
¶
investigation_id: str | None = ...
The unique identifier of the investigation to retrieve.
summary_format
class-attribute
instance-attribute
¶
summary_format: str | None = ...
The format in which to return the investigation summary. Possible values:
-
STRING-- (Default) Returns the summary as text inSummary. -
STRUCTURED-- Returns a typed summary inSummaryData.
GuardDuty returns a summary only when the investigation status is
COMPLETED.
Output¶
GetInvestigationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetInvestigationOutput structure.
Attributes¶
investigation
class-attribute
instance-attribute
¶
investigation: Investigation | None = ...
The details and results of the requested investigation.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.