Skip to content

get_kx_volume

get_kx_volume(
    environment_id: KxEnvironmentId,
    volume_name: KxVolumeName,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
) -> GetKxVolumeResponse

Retrieves the information about the volume.

Parameters:

  • environment_id (KxEnvironmentId) –

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

  • volume_name (KxVolumeName) –

    A unique identifier for the volume.

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py
def get_kx_volume(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    volume_name: "capo_finspace.types.kx_volume_name.KxVolumeName",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
) -> "capo_finspace.types.get_kx_volume_response.GetKxVolumeResponse":
    """<p> Retrieves the information about the volume. </p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
        volume_name: <p>A unique identifier for the volume.</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.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.get_kx_volume_request.GetKxVolumeRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.get_kx_volume_response.GetKxVolumeResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.get_kx_volume

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.get_kx_volume.get_kx_volume(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKxVolume")
    )
    input_: capo_finspace.types.get_kx_volume_request.GetKxVolumeRequest = {
        "environment_id": environment_id,
        "volume_name": volume_name,
    }

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