TraceSummary ¶

class TraceSummary(TypedDict, closed=True):
    id: NotRequired["capo_xray.types.trace_id.TraceId"]
    """<p>The unique identifier for the request that generated the trace's segments and subsegments.</p>"""
    start_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The start time of a trace, based on the earliest trace segment start time.</p>"""
    duration: NotRequired["capo_xray.types.nullable_double.NullableDouble"]
    """<p> The length of time in seconds between the start time of the earliest segment that started and the end time of the last segment that completed.</p>"""
    response_time: NotRequired["capo_xray.types.nullable_double.NullableDouble"]
    """<p>The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.</p>"""
    has_fault: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>The root segment document has a 500 series error.</p>"""
    has_error: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>The root segment document has a 400 series error.</p>"""
    has_throttle: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>One or more of the segment documents has a 429 throttling error.</p>"""
    is_partial: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>One or more of the segment documents is in progress.</p>"""
    http: NotRequired["capo_xray.types.http.Http"]
    """<p>Information about the HTTP request served by the trace.</p>"""
    annotations: NotRequired["capo_xray.types.annotations.Annotations"]
    """<p>Annotations from the trace's segment documents.</p>"""
    users: NotRequired["capo_xray.types.trace_users.TraceUsers"]
    """<p>Users from the trace's segment documents.</p>"""
    service_ids: NotRequired["capo_xray.types.service_ids.ServiceIds"]
    """<p>Service IDs from the trace's segment documents.</p>"""
    resource_ar_ns: NotRequired[
        "capo_xray.types.trace_resource_ar_ns.TraceResourceARNs"
    ]
    """<p>A list of resource ARNs for any resource corresponding to the trace segments.</p>"""
    instance_ids: NotRequired["capo_xray.types.trace_instance_ids.TraceInstanceIds"]
    """<p>A list of EC2 instance IDs for any instance corresponding to the trace segments.</p>"""
    availability_zones: NotRequired[
        "capo_xray.types.trace_availability_zones.TraceAvailabilityZones"
    ]
    """<p>A list of Availability Zones for any zone corresponding to the trace segments.</p>"""
    entry_point: NotRequired["capo_xray.types.service_id.ServiceId"]
    """<p>The root of a trace.</p>"""
    fault_root_causes: NotRequired["capo_xray.types.fault_root_causes.FaultRootCauses"]
    """<p>A collection of FaultRootCause structures corresponding to the trace segments.</p>"""
    error_root_causes: NotRequired["capo_xray.types.error_root_causes.ErrorRootCauses"]
    """<p>A collection of ErrorRootCause structures corresponding to the trace segments.</p>"""
    response_time_root_causes: NotRequired[
        "capo_xray.types.response_time_root_causes.ResponseTimeRootCauses"
    ]
    """<p>A collection of ResponseTimeRootCause structures corresponding to the trace segments.</p>"""
    revision: "capo_xray.types.integer.Integer"
    """<p>The revision number of a trace.</p>"""
    matched_event_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The matched time stamp of a defined event.</p>"""