Delete Dataset Examples

bedrockagentcorecontrol_delete_dataset_examples

R Documentation

Deletes specific examples by ID from DRAFT¶

Description¶

Deletes specific examples by ID from DRAFT.

Validation: All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected with ResourceNotFoundException — no examples are deleted (all-or-nothing semantics).

Asynchronous: Operates in-place on DRAFT. No version bump occurs. Use CreateDatasetVersion to publish DRAFT as a new numbered version.

State guard: Returns ConflictException (DATASET_NOT_READY) if the dataset status is not in {DRAFT, ACTIVE}.

Usage¶

bedrockagentcorecontrol_delete_dataset_examples(datasetId, clientToken,
  exampleIds)

Arguments¶

datasetId

[required] The unique identifier of the dataset.

clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

exampleIds

[required] The IDs of the examples to delete.

Value¶

A list with the following syntax:

list(
  datasetArn = "string",
  datasetId = "string",
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
  deletedCount = 123,
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$delete_dataset_examples(
  datasetId = "string",
  clientToken = "string",
  exampleIds = list(
    "string"
  )
)