Struct aws_sdk_xray::client::fluent_builders::GetTraceSummaries

pub struct GetTraceSummaries<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to GetTraceSummaries.

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

service("api.example.com")

This filter expression finds traces that have an annotation named account with the value 12345:

annotation.account = "12345"

For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.

Implementations

impl<C, M, R> GetTraceSummaries<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetTraceSummariesOutput, SdkError<GetTraceSummariesError>> where
    R::Policy: SmithyRetryPolicy<GetTraceSummariesInputOperationOutputAlias, GetTraceSummariesOutput, GetTraceSummariesError, GetTraceSummariesInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetTraceSummariesPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn start_time(self, input: DateTime) -> Self

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

pub fn set_start_time(self, input: Option<DateTime>) -> Self

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

pub fn end_time(self, input: DateTime) -> Self

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

pub fn set_end_time(self, input: Option<DateTime>) -> Self

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

pub fn time_range_type(self, input: TimeRangeType) -> Self

A parameter to indicate whether to query trace summaries by TraceId or Event time.

pub fn set_time_range_type(self, input: Option<TimeRangeType>) -> Self

A parameter to indicate whether to query trace summaries by TraceId or Event time.

pub fn sampling(self, input: bool) -> Self

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

pub fn set_sampling(self, input: Option<bool>) -> Self

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

pub fn sampling_strategy(self, input: SamplingStrategy) -> Self

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

pub fn set_sampling_strategy(self, input: Option<SamplingStrategy>) -> Self

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

pub fn filter_expression(self, input: impl Into<String>) -> Self

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

pub fn set_filter_expression(self, input: Option<String>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for GetTraceSummaries<C, M, R>

fn clone(&self) -> GetTraceSummaries<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for GetTraceSummaries<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.