Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

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

get/datasets/{datasetId}

Path parameters

datasetIdstring required

The unique identifier of the dataset to retrieve.

Query parameters

datasetVersionstring

Dataset version identifier. Accepts "DRAFT" or a non-negative integer string representing a published version number.

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

Response

Success

datasetArnstring required

The Amazon Resource Name (ARN) of the dataset.

datasetIdstring required

The unique identifier of the dataset.

datasetVersionstring required

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

datasetNamestring required

The name of the dataset.

descriptionstring

The description of the dataset.

status'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED' required

The current status of the dataset.

draftStatus'MODIFIED' | 'UNMODIFIED'

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

failureReasonstring

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

schemaType'AGENTCORE_EVALUATION_PREDEFINED_V1' | 'AGENTCORE_EVALUATION_SIMULATED_V1' required

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

kmsKeyArnstring

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

exampleCountinteger required

The number of examples in the DRAFT.

downloadUrlstring password

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.

downloadUrlExpiresAtstring date-time

Expiry timestamp for the download URL.

createdAtstring date-time required

The timestamp when the dataset was created.

updatedAtstring date-time required

The timestamp when the dataset was last updated.

tagsobject

The tags associated with the dataset.