Skip to content

list_dataset_versions

Operation

list_dataset_versions

list_dataset_versions(request: ListDatasetVersionsInput | ListDatasetVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDatasetVersionsInputDict]) -> ListDatasetVersionsOutput

Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.

Parameters:

Name Type Description Default
request ListDatasetVersionsInput | ListDatasetVersionsInputDict | 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[ListDatasetVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDatasetVersionsOutput

An instance of ListDatasetVersionsOutput.

list_dataset_versions async

list_dataset_versions(request: ListDatasetVersionsInput | ListDatasetVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDatasetVersionsInputDict]) -> ListDatasetVersionsOutput

Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.

Parameters:

Name Type Description Default
request ListDatasetVersionsInput | ListDatasetVersionsInputDict | 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[ListDatasetVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDatasetVersionsOutput

An instance of ListDatasetVersionsOutput.

Input

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

ListDatasetVersionsInputDict

Bases: TypedDict

Dictionary form of ListDatasetVersionsInput.

Attributes

dataset_id instance-attribute
dataset_id: Required[str]

The unique identifier of the dataset.

max_results instance-attribute
max_results: int | None

The maximum number of versions to return per page.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

ListDatasetVersionsInput dataclass

Bases: _SerdeShape

Dataclass for ListDatasetVersionsInput structure.

Attributes

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

The unique identifier of the dataset.

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

The maximum number of versions to return per page.

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

The token for the next page of results.

Output

ListDatasetVersionsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDatasetVersionsOutput structure.

Attributes

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.

versions instance-attribute

The list of published dataset versions.