Skip to content

Bedrock Agentcore Control  >  Operations  >  delete_dataset_examples

delete_dataset_examples

Operation

delete_dataset_examples async

delete_dataset_examples(input: DeleteDatasetExamplesInput, plugins: list[Plugin] | None = None) -> DeleteDatasetExamplesOutput

Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).

Parameters:

Name Type Description Default
input DeleteDatasetExamplesInput

An instance of DeleteDatasetExamplesInput.

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
DeleteDatasetExamplesOutput

An instance of DeleteDatasetExamplesOutput.

Input

DeleteDatasetExamplesInput dataclass

Dataclass for DeleteDatasetExamplesInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = None

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.

dataset_id class-attribute instance-attribute
dataset_id: str | None = None

The unique identifier of the dataset.

example_ids class-attribute instance-attribute
example_ids: list[str] | None = None

The IDs of the examples to delete.

Output

DeleteDatasetExamplesOutput dataclass

Dataclass for DeleteDatasetExamplesOutput structure.

Attributes

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.

deleted_count instance-attribute
deleted_count: int

The number of examples deleted.

status instance-attribute
status: DatasetStatus

The current status of the dataset.

updated_at instance-attribute
updated_at: datetime

The timestamp when the examples were deleted.