Skip to content

delete_dataset

Operation

delete_dataset

delete_dataset(request: DeleteDatasetInput | DeleteDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDatasetInputDict]) -> DeleteDatasetOutput

Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version.

Parameters:

Name Type Description Default
request DeleteDatasetInput | DeleteDatasetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDatasetOutput

An instance of DeleteDatasetOutput.

delete_dataset async

delete_dataset(request: DeleteDatasetInput | DeleteDatasetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDatasetInputDict]) -> DeleteDatasetOutput

Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version.

Parameters:

Name Type Description Default
request DeleteDatasetInput | DeleteDatasetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDatasetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDatasetOutput

An instance of DeleteDatasetOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteDatasetInputDict

Bases: TypedDict

Dictionary form of DeleteDatasetInput.

Attributes

dataset_id instance-attribute
dataset_id: Required[str]

The unique identifier of the dataset to delete.

dataset_version instance-attribute
dataset_version: str | None

Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.

DeleteDatasetInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDatasetInput structure.

Attributes

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

The unique identifier of the dataset to delete.

dataset_version class-attribute instance-attribute
dataset_version: str | None = ...

Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.

Output

DeleteDatasetOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDatasetOutput 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.

dataset_version instance-attribute
dataset_version: str

The version that was deleted.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

The current status of the dataset after the delete request.

updated_at instance-attribute
updated_at: datetime

The timestamp when the delete was initiated.