list_investigations¶
Operation¶
list_investigations
¶
list_investigations(request: ListInvestigationsInput | ListInvestigationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvestigationsInputDict]) -> 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. You can filter the investigations by status, risk level, confidence, finding ID, and investigation type, and sort them by start time, end time, status, risk level, or confidence.
An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListInvestigationsInput | ListInvestigationsInputDict | 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[ListInvestigationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListInvestigationsOutput
|
An instance of |
list_investigations
async
¶
list_investigations(request: ListInvestigationsInput | ListInvestigationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvestigationsInputDict]) -> 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. You can filter the investigations by status, risk level, confidence, finding ID, and investigation type, and sort them by start time, end time, status, risk level, or confidence.
An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListInvestigationsInput | ListInvestigationsInputDict | 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[ListInvestigationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListInvestigationsOutput
|
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.
ListInvestigationsInputDict
¶
Bases: TypedDict
Dictionary form of ListInvestigationsInput.
Attributes¶
detector_id
instance-attribute
¶
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.
filter_criteria
instance-attribute
¶
filter_criteria: InvestigationFilterCriteria | InvestigationFilterCriteriaDict | None
The criteria used to filter investigations. GuardDuty returns only the investigations that match all of the specified criteria.
max_results
instance-attribute
¶
max_results: int | None
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
next_token
instance-attribute
¶
next_token: str | 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.
sort_criteria
instance-attribute
¶
sort_criteria: InvestigationSortCriteria | InvestigationSortCriteriaDict | None
Represents the criteria used for sorting investigations.
ListInvestigationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListInvestigationsInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria: InvestigationFilterCriteria | None = ...
The criteria used to filter investigations. GuardDuty returns only the investigations that match all of the specified criteria.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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.
sort_criteria
class-attribute
instance-attribute
¶
sort_criteria: InvestigationSortCriteria | None = ...
Represents the criteria used for sorting investigations.
Output¶
ListInvestigationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListInvestigationsOutput structure.
Attributes¶
investigations
class-attribute
instance-attribute
¶
investigations: list[InvestigationSummary] | None = ...
A list of investigation summaries associated with the specified detector.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination parameter to be used on the next list operation to retrieve more items.
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.