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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetTraceSummaries and EndGetTraceSummaries.

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

Syntax

C#
public virtual Task<GetTraceSummariesResponse> GetTraceSummariesAsync(
         GetTraceSummariesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.XRay.Model.GetTraceSummariesRequest

Container for the necessary parameters to execute the GetTraceSummaries service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetTraceSummaries service method, as returned by XRay.

Exceptions

ExceptionCondition
InvalidRequestException The request is missing required parameters or has invalid parameters.
ThrottledException The request exceeds the maximum number of requests per second.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also