Skip to content

Insight

Source code in docs_src/capo_xray/types/insight.py
class Insight(TypedDict, closed=True):
    insight_id: NotRequired["capo_xray.types.insight_id.InsightId"]
    """<p>The insights unique identifier. </p>"""
    group_arn: NotRequired["capo_xray.types.group_arn.GroupARN"]
    """<p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>"""
    group_name: NotRequired["capo_xray.types.group_name.GroupName"]
    """<p>The name of the group that the insight belongs to.</p>"""
    root_cause_service_id: NotRequired["capo_xray.types.service_id.ServiceId"]
    categories: NotRequired["capo_xray.types.insight_category_list.InsightCategoryList"]
    """<p>The categories that label and describe the type of insight.</p>"""
    state: NotRequired["capo_xray.types.insight_state.InsightState"]
    """<p>The current state of the insight.</p>"""
    start_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The time, in Unix seconds, at which the insight began.</p>"""
    end_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The time, in Unix seconds, at which the insight ended.</p>"""
    summary: NotRequired["capo_xray.types.insight_summary_text.InsightSummaryText"]
    """<p>A brief description of the insight.</p>"""
    client_request_impact_statistics: NotRequired[
        "capo_xray.types.request_impact_statistics.RequestImpactStatistics"
    ]
    """<p>The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"""
    root_cause_service_request_impact_statistics: NotRequired[
        "capo_xray.types.request_impact_statistics.RequestImpactStatistics"
    ]
    """<p>The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"""
    top_anomalous_services: NotRequired[
        "capo_xray.types.anomalous_service_list.AnomalousServiceList"
    ]
    """<p>The service within the insight that is most impacted by the incident.</p>"""

categories instance-attribute

categories: NotRequired[InsightCategoryList]

The categories that label and describe the type of insight.

client_request_impact_statistics instance-attribute

client_request_impact_statistics: NotRequired[RequestImpactStatistics]

The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time, in Unix seconds, at which the insight ended.

group_arn instance-attribute

group_arn: NotRequired[GroupARN]

The Amazon Resource Name (ARN) of the group that the insight belongs to.

group_name instance-attribute

group_name: NotRequired[GroupName]

The name of the group that the insight belongs to.

insight_id instance-attribute

insight_id: NotRequired[InsightId]

The insights unique identifier.

root_cause_service_id instance-attribute

root_cause_service_id: NotRequired[ServiceId]

root_cause_service_request_impact_statistics instance-attribute

root_cause_service_request_impact_statistics: NotRequired[RequestImpactStatistics]

The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The time, in Unix seconds, at which the insight began.

state instance-attribute

state: NotRequired[InsightState]

The current state of the insight.

summary instance-attribute

summary: NotRequired[InsightSummaryText]

A brief description of the insight.

top_anomalous_services instance-attribute

top_anomalous_services: NotRequired[AnomalousServiceList]

The service within the insight that is most impacted by the incident.