list_investigations¶
Operation¶
async
¶
list_investigations(input: ListInvestigationsInput, plugins: list[Plugin] | None = None) -> ListInvestigationsOutput
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).
Returns a list of investigations associated with the specified GuardDuty detector.
An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListInvestigationsInput
|
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 |
|---|---|
ListInvestigationsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListInvestigationsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the GuardDuty detector whose investigations you want to list.
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
¶
max_results: int | None = None
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
class-attribute
instance-attribute
¶
next_token: str | None = None
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
class-attribute
instance-attribute
¶
sort_criteria: InvestigationSortCriteria | None = None
Represents the criteria used for sorting investigations.
Output¶
dataclass
¶
Dataclass for ListInvestigationsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
investigations: list[InvestigationSummary] | None = None
A list of investigation summaries associated with the specified detector.