get_graph_summary ¶

def get_graph_summary(
    self,
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier",
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    mode: Optional[
        "capo_neptune_graph.types.graph_summary_mode.GraphSummaryMode"
    ] = None,
) -> "capo_neptune_graph.types.get_graph_summary_output.GetGraphSummaryOutput":
    """<p>Gets a graph summary for a property graph.</p>

    Args:
        graph_identifier: <p>The unique identifier of the Neptune Analytics graph.</p>
        mode: <p>The summary mode can take one of two values: <code>basic</code> (the default), and <code>detailed</code>.</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.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource could not be located.</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.get_graph_summary_input.GetGraphSummaryInput]",
    ) -> OperationResponse[
        "capo_neptune_graph.types.get_graph_summary_output.GetGraphSummaryOutput"
    ]:
        import capo_neptune_graph._operations.amazon_neptune_graph.get_graph_summary

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetGraphSummary")
    )
    input_: capo_neptune_graph.types.get_graph_summary_input.GetGraphSummaryInput = {
        "graph_identifier": graph_identifier
    }
    if mode is not None:
        input_["mode"] = mode

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