Skip to content

delete_dataset async

delete_dataset(
    dataset_id: DatasetId,
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> DeleteDatasetResponse

Deletes a FinSpace Dataset.

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

  • dataset_id (DatasetId) –

    The unique identifier of the Dataset to be deleted.

Raises:

Source code in docs_src/capo_finspace_data/_services/async_finspacedata.py
async def delete_dataset(
    self,
    dataset_id: "capo_finspace_data.types.dataset_id.DatasetId",
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    client_token: Optional[
        "capo_finspace_data.types.client_token.ClientToken"
    ] = None,
) -> "capo_finspace_data.types.delete_dataset_response.DeleteDatasetResponse":
    """<p>Deletes a FinSpace Dataset.</p>

    Args:
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
        dataset_id: <p>The unique identifier of the Dataset to be deleted.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.limit_exceeded_exception.LimitExceededException: <p>A limit has exceeded.</p>
        capo_finspace_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace_data.types.delete_dataset_request.DeleteDatasetRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace_data.types.delete_dataset_response.DeleteDatasetResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.delete_dataset

        (
            output,
            http_response,
        ) = await capo_finspace_data._operations.aws_habanero_public_api.delete_dataset.async_delete_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDataset")
    )
    input_: capo_finspace_data.types.delete_dataset_request.DeleteDatasetRequest = {
        "dataset_id": dataset_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output