Skip to content

delete_dataset 

delete_dataset(
    dataset_id: DatasetId,
    *,
    config_overrides: Optional[finspacedataClientConfig] = 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/finspacedata.py 
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
def delete_dataset(
    self,
    dataset_id: "capo_finspace_data.types.dataset_id.DatasetId",
    *,
    config_overrides: Optional[finspacedataClientConfig] = 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.
    """

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

        output, http_response = (
            capo_finspace_data._operations.aws_habanero_public_api.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_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output