Skip to content

get_dataset

Operation

get_dataset

get_dataset(request: GetDatasetInput | GetDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDatasetInputDict]) -> GetDatasetOutput

Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.

Parameters:

Name Type Description Default
request GetDatasetInput | GetDatasetInputDict | 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[GetDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDatasetOutput

An instance of GetDatasetOutput.

get_dataset async

get_dataset(request: GetDatasetInput | GetDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDatasetInputDict]) -> GetDatasetOutput

Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.

Parameters:

Name Type Description Default
request GetDatasetInput | GetDatasetInputDict | 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[GetDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDatasetOutput

An instance of GetDatasetOutput.

Input

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

GetDatasetInputDict

Bases: TypedDict

Dictionary form of GetDatasetInput.

Attributes

dataset_id instance-attribute
dataset_id: Required[str]

The unique identifier of the dataset to retrieve.

dataset_version instance-attribute
dataset_version: str | None

Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.

GetDatasetInput dataclass

Bases: _SerdeShape

Dataclass for GetDatasetInput structure.

Attributes

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

The unique identifier of the dataset to retrieve.

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

Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.

Output

GetDatasetOutput dataclass

Bases: _SerdeShape

Dataclass for GetDatasetOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the dataset was created.

dataset_arn instance-attribute
dataset_arn: str

The Amazon Resource Name (ARN) of the dataset.

dataset_id instance-attribute
dataset_id: str

The unique identifier of the dataset.

dataset_name instance-attribute
dataset_name: str

The name of the dataset.

dataset_version instance-attribute
dataset_version: str

The resolved version: "DRAFT" (default) or the requested version number.

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

The description of the dataset.

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

Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.

download_url_expires_at class-attribute instance-attribute
download_url_expires_at: datetime | None = ...

Expiry timestamp for the download URL.

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

Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.

example_count instance-attribute
example_count: int

The number of examples in the DRAFT.

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

Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.

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

KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.

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.

schema_type instance-attribute
schema_type: str

The schema type declared at create time. Immutable after creation.

status instance-attribute
status: str

The current status of the dataset.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The tags associated with the dataset.

updated_at instance-attribute
updated_at: datetime

The timestamp when the dataset was last updated.