Skip to content

list_topics

Operation

list_topics

list_topics(request: ListTopicsInput | ListTopicsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTopicsInputDict]) -> ListTopicsOutput

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

This action is throttled at 30 transactions per second (TPS).

Parameters:

Name Type Description Default
request ListTopicsInput | ListTopicsInputDict | 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[ListTopicsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListTopicsOutput

An instance of ListTopicsOutput.

list_topics async

list_topics(request: ListTopicsInput | ListTopicsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTopicsInputDict]) -> ListTopicsOutput

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

This action is throttled at 30 transactions per second (TPS).

Parameters:

Name Type Description Default
request ListTopicsInput | ListTopicsInputDict | 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[ListTopicsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListTopicsOutput

An instance of ListTopicsOutput.

Input

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

ListTopicsInputDict

Bases: TypedDict

Dictionary form of ListTopicsInput.

Attributes

next_token instance-attribute
next_token: str | None

Token returned by the previous ListTopics request.

ListTopicsInput dataclass

Bases: _SerdeShape

Dataclass for ListTopicsInput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

Token returned by the previous ListTopics request.

Output

ListTopicsOutput dataclass

Bases: _SerdeShape

Response for ListTopics action.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

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.

topics class-attribute instance-attribute
topics: list[Topic] | None = ...

A list of topic ARNs.