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.

Implementation for accessing XRay AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.XRay.AmazonXRayClient

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

Syntax

C#
public class AmazonXRayClient : AmazonServiceClient
         IAmazonService, IAmazonXRay, IDisposable

The AmazonXRayClient type exposes the following members

Constructors

NameDescription
Public Method AmazonXRayClient()

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonXRayClient(RegionEndpoint)

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonXRayClient(AmazonXRayConfig)

Constructs AmazonXRayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonXRayClient(AWSCredentials)

Constructs AmazonXRayClient with AWS Credentials

Public Method AmazonXRayClient(AWSCredentials, RegionEndpoint)

Constructs AmazonXRayClient with AWS Credentials

Public Method AmazonXRayClient(AWSCredentials, AmazonXRayConfig)

Constructs AmazonXRayClient with AWS Credentials and an AmazonXRayClient Configuration object.

Public Method AmazonXRayClient(string, string)

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonXRayClient(string, string, RegionEndpoint)

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonXRayClient(string, string, AmazonXRayConfig)

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.

Public Method AmazonXRayClient(string, string, string)

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonXRayClient(string, string, string, RegionEndpoint)

Constructs AmazonXRayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonXRayClient(string, string, string, AmazonXRayConfig)

Constructs AmazonXRayClient with AWS Access Key ID, AWS Secret Key and an AmazonXRayClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchGetTraces(BatchGetTracesRequest)

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Public Method BatchGetTracesAsync(BatchGetTracesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetTraces operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetServiceGraph(GetServiceGraphRequest)

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Public Method GetServiceGraphAsync(GetServiceGraphRequest, CancellationToken)

Initiates the asynchronous execution of the GetServiceGraph operation.

Public Method GetTraceGraph(GetTraceGraphRequest)

Retrieves a service graph for one or more specific trace IDs.

Public Method GetTraceGraphAsync(GetTraceGraphRequest, CancellationToken)

Initiates the asynchronous execution of the GetTraceGraph operation.

Public Method GetTraceSummaries(GetTraceSummariesRequest)

Retrieves IDs and metadata 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 AWS X-Ray Developer Guide.

Public Method GetTraceSummariesAsync(GetTraceSummariesRequest, CancellationToken)

Initiates the asynchronous execution of the GetTraceSummaries operation.

Public Method PutTelemetryRecords(PutTelemetryRecordsRequest)

Used by the AWS X-Ray daemon to upload telemetry.

Public Method PutTelemetryRecordsAsync(PutTelemetryRecordsRequest, CancellationToken)

Initiates the asynchronous execution of the PutTelemetryRecords operation.

Public Method PutTraceSegments(PutTraceSegmentsRequest)
Public Method PutTraceSegmentsAsync(PutTraceSegmentsRequest, CancellationToken)

Initiates the asynchronous execution of the PutTraceSegments operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms