Skip to content

delete_kx_volume async

delete_kx_volume(
    environment_id: KxEnvironmentId,
    volume_name: KxVolumeName,
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    client_token: Optional[ClientTokenString] = None,
) -> DeleteKxVolumeResponse

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

Parameters:

  • environment_id (KxEnvironmentId) –

    A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volume_name (KxVolumeName) –

    The name of the volume that you want to delete.

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

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

Raises:

Source code in docs_src/capo_finspace/_services/async_finspace.py
async def delete_kx_volume(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    volume_name: "capo_finspace.types.kx_volume_name.KxVolumeName",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    client_token: Optional[
        "capo_finspace.types.client_token_string.ClientTokenString"
    ] = None,
) -> "capo_finspace.types.delete_kx_volume_response.DeleteKxVolumeResponse":
    """<p> Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible. </p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
        volume_name: <p> The name of the volume that you want to delete. </p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.delete_kx_volume_request.DeleteKxVolumeRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.delete_kx_volume_response.DeleteKxVolumeResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.delete_kx_volume

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.delete_kx_volume.async_delete_kx_volume(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteKxVolume")
    )
    input_: capo_finspace.types.delete_kx_volume_request.DeleteKxVolumeRequest = {
        "environment_id": environment_id,
        "volume_name": volume_name,
    }
    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