Skip to content

GetTraceSummariesRequest

Source code in docs_src/capo_xray/types/get_trace_summaries_request.py
class GetTraceSummariesRequest(TypedDict, closed=True):
    start_time: "capo_xray.types.timestamp.Timestamp"
    """<p>The start of the time frame for which to retrieve traces.</p>"""
    end_time: "capo_xray.types.timestamp.Timestamp"
    """<p>The end of the time frame for which to retrieve traces.</p>"""
    time_range_type: NotRequired["capo_xray.types.time_range_type.TimeRangeType"]
    """<p>Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).</p>"""
    sampling: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>Set to <code>true</code> to get summaries for only a subset of available traces.</p>"""
    sampling_strategy: NotRequired["capo_xray.types.sampling_strategy.SamplingStrategy"]
    """<p>A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.</p>"""
    filter_expression: NotRequired["capo_xray.types.filter_expression.FilterExpression"]
    """<p>Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.</p>"""
    next_token: NotRequired["capo_xray.types.string.String"]
    """<p>Specify the pagination token returned by a previous request to retrieve the next page of results.</p>"""

end_time instance-attribute

end_time: Timestamp

The end of the time frame for which to retrieve traces.

filter_expression instance-attribute

filter_expression: NotRequired[FilterExpression]

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

next_token instance-attribute

next_token: NotRequired[String]

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

sampling instance-attribute

sampling: NotRequired[NullableBoolean]

Set to true to get summaries for only a subset of available traces.

sampling_strategy instance-attribute

sampling_strategy: NotRequired[SamplingStrategy]

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

start_time instance-attribute

start_time: Timestamp

The start of the time frame for which to retrieve traces.

time_range_type instance-attribute

time_range_type: NotRequired[TimeRangeType]

Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).