list_kx_volumes ¶

def list_kx_volumes(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    max_results: Optional["capo_finspace.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_finspace.types.pagination_token.PaginationToken"
    ] = None,
    volume_type: Optional["capo_finspace.types.kx_volume_type.KxVolumeType"] = None,
) -> "capo_finspace.types.list_kx_volumes_response.ListKxVolumesResponse":
    """<p> Lists all the volumes in a kdb environment. </p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
        max_results: <p>The maximum number of results to return in this request.</p>
        next_token: <p>A token that indicates where a results page should begin.</p>
        volume_type: <p> The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type. </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.list_kx_volumes_request.ListKxVolumesRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.list_kx_volumes_response.ListKxVolumesResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.list_kx_volumes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListKxVolumes")
    )
    input_: capo_finspace.types.list_kx_volumes_request.ListKxVolumesRequest = {
        "environment_id": environment_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if volume_type is not None:
        input_["volume_type"] = volume_type

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