list_queries ¶

list_queries(
    graph_identifier: GraphIdentifier,
    max_results: int,
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    state: Optional[QueryStateInput] = None,
) -> ListQueriesOutput

Lists active openCypher queries.

Parameters:

graph_identifier (GraphIdentifier) –

The unique identifier of the Neptune Analytics graph.
max_results (int) –

The maximum number of results to be fetched by the API.
state (Optional[QueryStateInput], default: None ) –

Filtered list of queries based on state.

Raises:

AccessDeniedException –

Raised in case of an authentication or authorization failure.
InternalServerException –

A failure occurred on the server.
ThrottlingException –

The exception was interrupted by throttling.
ValidationException –

A resource could not be validated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_neptune_graph/_services/neptune_graph.py

def list_queries(
    self,
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier",
    max_results: int,
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    state: Optional[
        "capo_neptune_graph.types.query_state_input.QueryStateInput"
    ] = None,
) -> "capo_neptune_graph.types.list_queries_output.ListQueriesOutput":
    """<p>Lists active openCypher queries.</p>

    Args:
        graph_identifier: <p>The unique identifier of the Neptune Analytics graph.</p>
        max_results: <p>The maximum number of results to be fetched by the API.</p>
        state: <p>Filtered list of queries based on state.</p>

    Raises:
        capo_neptune_graph.errors.access_denied_exception.AccessDeniedException: <p>Raised in case of an authentication or authorization failure.</p>
        capo_neptune_graph.errors.internal_server_exception.InternalServerException: <p>A failure occurred on the server.</p>
        capo_neptune_graph.errors.throttling_exception.ThrottlingException: <p>The exception was interrupted by throttling.</p>
        capo_neptune_graph.errors.validation_exception.ValidationException: <p>A resource could not be validated.</p>
        capo_neptune_graph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune_graph.types.list_queries_input.ListQueriesInput]",
    ) -> OperationResponse[
        "capo_neptune_graph.types.list_queries_output.ListQueriesOutput"
    ]:
        import capo_neptune_graph._operations.amazon_neptune_graph.list_queries

        output, http_response = (
            capo_neptune_graph._operations.amazon_neptune_graph.list_queries.list_queries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListQueries")
    )
    input_: capo_neptune_graph.types.list_queries_input.ListQueriesInput = {
        "graph_identifier": graph_identifier,
        "max_results": max_results,
    }
    if state is not None:
        input_["state"] = state

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