get_insight_impact_graph `async` ¶

get_insight_impact_graph(
    insight_id: InsightId,
    start_time: Timestamp,
    end_time: Timestamp,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    next_token: Optional[Token] = None,
) -> GetInsightImpactGraphResult

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Parameters:

insight_id (InsightId) –

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
start_time (Timestamp) –

The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.
end_time (Timestamp) –

The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours.
next_token (Optional[Token], default: None ) –

Specify the pagination token returned by a previous request to retrieve the next page of results.

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/async_x_ray.py

async def get_insight_impact_graph(
    self,
    insight_id: "capo_xray.types.insight_id.InsightId",
    start_time: "capo_xray.types.timestamp.Timestamp",
    end_time: "capo_xray.types.timestamp.Timestamp",
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    next_token: Optional["capo_xray.types.token.Token"] = None,
) -> "capo_xray.types.get_insight_impact_graph_result.GetInsightImpactGraphResult":
    """<p>Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.</p>

    Args:
        insight_id: <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
        start_time: <p>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.</p>
        end_time: <p>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours. </p>
        next_token: <p>Specify the pagination token returned by a previous request to retrieve the next page of results. </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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_xray.types.get_insight_impact_graph_request.GetInsightImpactGraphRequest]",
    ) -> AsyncOperationResponse[
        "capo_xray.types.get_insight_impact_graph_result.GetInsightImpactGraphResult"
    ]:
        import capo_xray._operations.awsx_ray.get_insight_impact_graph

        (
            output,
            http_response,
        ) = await capo_xray._operations.awsx_ray.get_insight_impact_graph.async_get_insight_impact_graph(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInsightImpactGraph")
    )
    input_: capo_xray.types.get_insight_impact_graph_request.GetInsightImpactGraphRequest = {
        "insight_id": insight_id,
        "start_time": start_time,
        "end_time": end_time,
    }
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_insight_impact_graph async ¶

get_insight_impact_graph `async` ¶