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.

Interface for accessing XRay Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Inheritance Hierarchy

Amazon.XRay.IAmazonXRay

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

Syntax

C# 
public interface IAmazonXRay
         IAmazonService, IDisposable

The IAmazonXRay type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.XRay.Model.IXRayPaginatorFactory

Paginators for the service

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)

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 CreateGroup(CreateGroupRequest)

Creates a group resource with a name and a filter expression.

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

Creates a group resource with a name and a filter expression.

Public Method CreateSamplingRule(CreateSamplingRuleRequest)

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Public Method CreateSamplingRuleAsync(CreateSamplingRuleRequest, CancellationToken)

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Public Method DeleteGroup(DeleteGroupRequest)

Deletes a group resource.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Deletes a group resource.

Public Method DeleteResourcePolicy(DeleteResourcePolicyRequest)

Deletes a resource policy from the target Amazon Web Services account.

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

Deletes a resource policy from the target Amazon Web Services account.

Public Method DeleteSamplingRule(DeleteSamplingRuleRequest)

Deletes a sampling rule.

Public Method DeleteSamplingRuleAsync(DeleteSamplingRuleRequest, CancellationToken)

Deletes a sampling rule.

Public Method GetEncryptionConfig(GetEncryptionConfigRequest)

Retrieves the current encryption configuration for X-Ray data.

Public Method GetEncryptionConfigAsync(GetEncryptionConfigRequest, CancellationToken)

Retrieves the current encryption configuration for X-Ray data.

Public Method GetGroup(GetGroupRequest)

Retrieves group resource details.

Public Method GetGroupAsync(GetGroupRequest, CancellationToken)

Retrieves group resource details.

Public Method GetGroups(GetGroupsRequest)

Retrieves all active group details.

Public Method GetGroupsAsync(GetGroupsRequest, CancellationToken)

Retrieves all active group details.

Public Method GetInsight(GetInsightRequest)

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Public Method GetInsightAsync(GetInsightRequest, CancellationToken)

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Public Method GetInsightEvents(GetInsightEventsRequest)

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Public Method GetInsightEventsAsync(GetInsightEventsRequest, CancellationToken)

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Public Method GetInsightImpactGraph(GetInsightImpactGraphRequest)

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Public Method GetInsightImpactGraphAsync(GetInsightImpactGraphRequest, CancellationToken)

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Public Method GetInsightSummaries(GetInsightSummariesRequest)

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Public Method GetInsightSummariesAsync(GetInsightSummariesRequest, CancellationToken)

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Public Method GetSamplingRules(GetSamplingRulesRequest)

Retrieves all sampling rules.

Public Method GetSamplingRulesAsync(GetSamplingRulesRequest, CancellationToken)

Retrieves all sampling rules.

Public Method GetSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest)

Retrieves information about recent sampling results for all sampling rules.

Public Method GetSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest, CancellationToken)

Retrieves information about recent sampling results for all sampling rules.

Public Method GetSamplingTargets(GetSamplingTargetsRequest)

Requests a sampling quota for rules that the service is using to sample requests.

Public Method GetSamplingTargetsAsync(GetSamplingTargetsRequest, CancellationToken)

Requests a sampling quota for rules that the service is using to sample requests.

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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Public Method GetServiceGraphAsync(GetServiceGraphRequest, CancellationToken)

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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Public Method GetTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest)

Get an aggregation of service statistics defined by a specific time range.

Public Method GetTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest, CancellationToken)

Get an aggregation of service statistics defined by a specific time range.

Public Method GetTraceGraph(GetTraceGraphRequest)

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

Public Method GetTraceGraphAsync(GetTraceGraphRequest, CancellationToken)

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

Public Method GetTraceSummaries(GetTraceSummariesRequest)

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.

Public Method GetTraceSummariesAsync(GetTraceSummariesRequest, CancellationToken)

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.

Public Method ListResourcePolicies(ListResourcePoliciesRequest)

Returns the list of resource policies in the target Amazon Web Services account.

Public Method ListResourcePoliciesAsync(ListResourcePoliciesRequest, CancellationToken)

Returns the list of resource policies in the target Amazon Web Services account.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Public Method PutEncryptionConfig(PutEncryptionConfigRequest)

Updates the encryption configuration for X-Ray data.

Public Method PutEncryptionConfigAsync(PutEncryptionConfigRequest, CancellationToken)

Updates the encryption configuration for X-Ray data.

Public Method PutResourcePolicy(PutResourcePolicyRequest)

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Public Method PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken)

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Public Method PutTelemetryRecords(PutTelemetryRecordsRequest)

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

Public Method PutTelemetryRecordsAsync(PutTelemetryRecordsRequest, CancellationToken)

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

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

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Public Method UntagResource(UntagResourceRequest)

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Public Method UpdateGroup(UpdateGroupRequest)

Updates a group resource.

Public Method UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

Updates a group resource.

Public Method UpdateSamplingRule(UpdateSamplingRuleRequest)

Modifies a sampling rule's configuration.

Public Method UpdateSamplingRuleAsync(UpdateSamplingRuleRequest, CancellationToken)

Modifies a sampling rule's configuration.

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