Skip to content

ListInvestigationsRequest

Source code in docs_src/capo_guardduty/types/list_investigations_request.py 
14
15
16
17
18
19
20
21
22
23
24
class ListInvestigationsRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The unique ID of the GuardDuty detector whose investigations you want to list.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    sort_criteria: NotRequired[
        "capo_guardduty.types.investigation_sort_criteria.InvestigationSortCriteria"
    ]
    """<p>Represents the criteria used for sorting investigations.</p>"""
    max_results: NotRequired["capo_guardduty.types.max_results.MaxResults"]
    """<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.</p>"""
    next_token: NotRequired["capo_guardduty.types.next_token.NextToken"]
    """<p>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.</p>"""

detector_id instance-attribute 

detector_id: DetectorId

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.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

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: NotRequired[NextToken]

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: NotRequired[InvestigationSortCriteria]

Represents the criteria used for sorting investigations.