AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetTraceSummaries operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.XRay.AmazonXRayRequest
      Amazon.XRay.Model.GetTraceSummariesRequest

Namespace: Amazon.XRay.Model
Assembly: AWSSDK.XRay.dll
Version: 3.x.y.z

Syntax

C#
public class GetTraceSummariesRequest : AmazonXRayRequest
         IAmazonWebServiceRequest

The GetTraceSummariesRequest type exposes the following members

Constructors

NameDescription
Public Method GetTraceSummariesRequest()

Properties

NameTypeDescription
Public Property EndTime System.DateTime

Gets and sets the property EndTime.

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

Public Property FilterExpression System.String

Gets and sets the property FilterExpression.

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

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property Sampling System.Boolean

Gets and sets the property Sampling.

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

Public Property SamplingStrategy Amazon.XRay.Model.SamplingStrategy

Gets and sets the property SamplingStrategy.

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

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

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

Public Property TimeRangeType Amazon.XRay.TimeRangeType

Gets and sets the property TimeRangeType.

A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5