Skip to content

list_datasets

Operation

list_datasets

list_datasets(request: ListDatasetsInput | ListDatasetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDatasetsInputDict]) -> ListDatasetsOutput

Lists all datasets in the caller's account, paginated.

Parameters:

Name Type Description Default
request ListDatasetsInput | ListDatasetsInputDict | 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[ListDatasetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDatasetsOutput

An instance of ListDatasetsOutput.

list_datasets async

list_datasets(request: ListDatasetsInput | ListDatasetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDatasetsInputDict]) -> ListDatasetsOutput

Lists all datasets in the caller's account, paginated.

Parameters:

Name Type Description Default
request ListDatasetsInput | ListDatasetsInputDict | 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[ListDatasetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDatasetsOutput

An instance of ListDatasetsOutput.

Input

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

ListDatasetsInputDict

Bases: TypedDict

Dictionary form of ListDatasetsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of datasets to return per page.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

ListDatasetsInput dataclass

Bases: _SerdeShape

Dataclass for ListDatasetsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of datasets to return per page.

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

The token for the next page of results.

Output

ListDatasetsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDatasetsOutput structure.

Attributes

datasets instance-attribute
datasets: list[DatasetSummary]

The list of datasets.

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

The token for the next page of results, or null if there are no more results.

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.