Bedrock Agentcore Control  >  Operations  >  get_dataset

get_dataset

Operation

get_dataset async

get_dataset(input: GetDatasetInput, plugins: list[Plugin] | None = None) -> 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
input	GetDatasetInput	An instance of GetDatasetInput.	required
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

Returns:

Type	Description
GetDatasetOutput	An instance of GetDatasetOutput.

Input

GetDatasetInput dataclass

Dataclass for GetDatasetInput structure.

Attributes

dataset_id class-attribute instance-attribute

dataset_id: str | None = None

The unique identifier of the dataset to retrieve.

dataset_version class-attribute instance-attribute

dataset_version: str | None = None

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

Output

GetDatasetOutput dataclass

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 = None

The description of the dataset.

download_url class-attribute instance-attribute

download_url: str | None = field(repr=False, default=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 = None

Expiry timestamp for the download URL.

draft_status class-attribute instance-attribute

draft_status: DraftStatus | None = 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 = 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 = None

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

schema_type instance-attribute

schema_type: DatasetSchemaType

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

status instance-attribute

status: DatasetStatus

The current status of the dataset.

tags class-attribute instance-attribute

tags: dict[str, str] | None = None

The tags associated with the dataset.

updated_at instance-attribute

updated_at: datetime

The timestamp when the dataset was last updated.