Retrieves dataset metadata¶

Description¶

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 list_dataset_examples.

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"|"THIRD_PARTY_EVALUATION_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"
)