get_trace_graph ¶

get_trace_graph(
    trace_ids: TraceIdList,
    *,
    config_overrides: Optional[XRayClientConfig] = None,
    next_token: Optional[String] = None,
) -> GetTraceGraphResult

Retrieves a service graph for one or more specific trace IDs.

Parameters:

trace_ids (TraceIdList) –

Trace IDs of requests for which to generate a service graph.
next_token (Optional[String], default: None ) –

Pagination token.

Raises:

InvalidRequestException –

The request is missing required parameters or has invalid parameters.
ThrottledException –

The request exceeds the maximum number of requests per second.
UnknownServiceError –

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

Source code in docs_src/capo_xray/_services/x_ray.py

def get_trace_graph(
    self,
    trace_ids: "capo_xray.types.trace_id_list.TraceIdList",
    *,
    config_overrides: Optional[XRayClientConfig] = None,
    next_token: Optional["capo_xray.types.string.String"] = None,
) -> "capo_xray.types.get_trace_graph_result.GetTraceGraphResult":
    """<p>Retrieves a service graph for one or more specific trace IDs.</p>

    Args:
        trace_ids: <p>Trace IDs of requests for which to generate a service graph.</p>
        next_token: <p>Pagination token.</p>

    Raises:
        capo_xray.errors.invalid_request_exception.InvalidRequestException: <p>The request is missing required parameters or has invalid parameters.</p>
        capo_xray.errors.throttled_exception.ThrottledException: <p>The request exceeds the maximum number of requests per second.</p>
        capo_xray.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_xray.types.get_trace_graph_request.GetTraceGraphRequest]",
    ) -> OperationResponse[
        "capo_xray.types.get_trace_graph_result.GetTraceGraphResult"
    ]:
        import capo_xray._operations.awsx_ray.get_trace_graph

        output, http_response = (
            capo_xray._operations.awsx_ray.get_trace_graph.get_trace_graph(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTraceGraph")
    )
    input_: capo_xray.types.get_trace_graph_request.GetTraceGraphRequest = {
        "trace_ids": trace_ids
    }
    if next_token is not None:
        input_["next_token"] = next_token

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