Get Dataset

bedrockagentcorecontrol_get_dataset

R Documentation

Retrieves dataset metadata only¶

Description¶

Retrieves dataset metadata only.

Use ?datasetVersion=DRAFT or ?datasetVersion=N to retrieve a specific version's metadata. If absent, defaults to DRAFT (the mutable working copy). Returns ResourceNotFoundException if the specified version is not found.

Initial state after CreateDataset: When CreateDataset completes successfully (status transitions to ACTIVE), only a DRAFT working copy exists. No published versions exist until CreateDatasetVersion is called. At this point draftStatus is MODIFIED because the DRAFT has content that has never been published.

Default version behavior: When datasetVersion is omitted, the operation returns the DRAFT working copy. To retrieve a specific published version, pass the version number as a string (e.g. ?datasetVersion=1).

State guard: Allowed for all statuses including DELETING. Returns the dataset record with its current status so callers can observe the deletion in progress.

For paginated example IDs use ListDatasetExamples.

Usage¶

bedrockagentcorecontrol_get_dataset(datasetId, datasetVersion)

Arguments¶

datasetId

[required] The unique identifier of the dataset to retrieve.

datasetVersion

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

Value¶

A list with the following syntax:

list(
  datasetArn = "string",
  datasetId = "string",
  datasetVersion = "string",
  datasetName = "string",
  description = "string",
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
  draftStatus = "MODIFIED"|"UNMODIFIED",
  failureReason = "string",
  schemaType = "AGENTCORE_EVALUATION_PREDEFINED_V1"|"AGENTCORE_EVALUATION_SIMULATED_V1",
  kmsKeyArn = "string",
  exampleCount = 123,
  downloadUrl = "string",
  downloadUrlExpiresAt = as.POSIXct(
    "2015-01-01"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  tags = list(
    "string"
  )
)

Request syntax¶

svc$get_dataset(
  datasetId = "string",
  datasetVersion = "string"
)