Guardduty  >  Operations  >  list_detectors

list_detectors

Operation

list_detectors async

list_detectors(input: ListDetectorsInput, plugins: list[Plugin] | None = None) -> ListDetectorsOutput

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Parameters:

Name	Type	Description	Default
input	ListDetectorsInput	An instance of ListDetectorsInput.	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
ListDetectorsOutput	An instance of ListDetectorsOutput.

Input

ListDetectorsInput dataclass

Dataclass for ListDetectorsInput structure.

Attributes

max_results class-attribute instance-attribute

max_results: int | None = None

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

next_token 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.

Output

ListDetectorsOutput dataclass

Dataclass for ListDetectorsOutput structure.

Attributes

detector_ids class-attribute instance-attribute

detector_ids: list[str] | None = None

A list of detector IDs.

next_token class-attribute instance-attribute

next_token: str | None = None

The pagination parameter to be used on the next list operation to retrieve more items.