Skip to content

delete_dataset

delete_dataset(
    dataset_id: DatasetId,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    dataset_version: Optional[DatasetVersion] = None,
) -> DeleteDatasetResponse

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:

  • dataset_id (DatasetId) –

    The unique identifier of the dataset to delete.

  • dataset_version (Optional[DatasetVersion], default: None ) –

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

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def delete_dataset(
    self,
    dataset_id: "capo_bedrock_agentcore_control.types.dataset_id.DatasetId",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    dataset_version: Optional[
        "capo_bedrock_agentcore_control.types.dataset_version.DatasetVersion"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.delete_dataset_response.DeleteDatasetResponse":
    """<p> Deletes a dataset version or an entire dataset asynchronously. If <code>datasetVersion</code> is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version. </p>

    Args:
        dataset_id: <p> The unique identifier of the dataset to delete. </p>
        dataset_version: <p> Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version. </p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.delete_dataset_request.DeleteDatasetRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.delete_dataset_response.DeleteDatasetResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_dataset

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_dataset.delete_dataset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDataset")
    )
    input_: capo_bedrock_agentcore_control.types.delete_dataset_request.DeleteDatasetRequest = {
        "dataset_id": dataset_id
    }
    if dataset_version is not None:
        input_["dataset_version"] = dataset_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output