Skip to content

list_detectors

Operation

list_detectors

list_detectors(request: ListDetectorsInput | ListDetectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDetectorsInputDict]) -> ListDetectorsOutput

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Parameters:

Name Type Description Default
request ListDetectorsInput | ListDetectorsInputDict | 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[ListDetectorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDetectorsOutput

An instance of ListDetectorsOutput.

list_detectors async

list_detectors(request: ListDetectorsInput | ListDetectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDetectorsInputDict]) -> ListDetectorsOutput

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Parameters:

Name Type Description Default
request ListDetectorsInput | ListDetectorsInputDict | 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[ListDetectorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDetectorsOutput

An instance of ListDetectorsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListDetectorsInputDict

Bases: TypedDict

Dictionary form of ListDetectorsInput.

Attributes

max_results instance-attribute
max_results: int | 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 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.

ListDetectorsInput dataclass

Bases: _SerdeShape

Dataclass for ListDetectorsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | 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 = ...

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

Bases: _SerdeShape

Dataclass for ListDetectorsOutput structure.

Attributes

detector_ids class-attribute instance-attribute
detector_ids: list[str] | None = ...

A list of detector IDs.

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
response_metadata: ResponseMetadata = ...

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.