/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the xray-2016-04-12.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.XRay.Model; namespace Amazon.XRay { /// /// 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. /// public partial interface IAmazonXRay : IAmazonService, IDisposable { /// /// Paginators for the service /// IXRayPaginatorFactory Paginators { get; } #region BatchGetTraces /// /// 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. /// /// Container for the necessary parameters to execute the BatchGetTraces service method. /// /// The response from the BatchGetTraces service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for BatchGetTraces Operation BatchGetTracesResponse BatchGetTraces(BatchGetTracesRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the BatchGetTraces service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the BatchGetTraces service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for BatchGetTraces Operation Task BatchGetTracesAsync(BatchGetTracesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateGroup /// /// Creates a group resource with a name and a filter expression. /// /// Container for the necessary parameters to execute the CreateGroup service method. /// /// The response from the CreateGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for CreateGroup Operation CreateGroupResponse CreateGroup(CreateGroupRequest request); /// /// Creates a group resource with a name and a filter expression. /// /// Container for the necessary parameters to execute the CreateGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for CreateGroup Operation Task CreateGroupAsync(CreateGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateSamplingRule /// /// 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. /// /// Container for the necessary parameters to execute the CreateSamplingRule service method. /// /// The response from the CreateSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// You have reached the maximum number of sampling rules. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for CreateSamplingRule Operation CreateSamplingRuleResponse CreateSamplingRule(CreateSamplingRuleRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the CreateSamplingRule service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// You have reached the maximum number of sampling rules. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for CreateSamplingRule Operation Task CreateSamplingRuleAsync(CreateSamplingRuleRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteGroup /// /// Deletes a group resource. /// /// Container for the necessary parameters to execute the DeleteGroup service method. /// /// The response from the DeleteGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteGroup Operation DeleteGroupResponse DeleteGroup(DeleteGroupRequest request); /// /// Deletes a group resource. /// /// Container for the necessary parameters to execute the DeleteGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteGroup Operation Task DeleteGroupAsync(DeleteGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteResourcePolicy /// /// Deletes a resource policy from the target Amazon Web Services account. /// /// Container for the necessary parameters to execute the DeleteResourcePolicy service method. /// /// The response from the DeleteResourcePolicy service method, as returned by XRay. /// /// A policy revision id was provided which does not match the latest policy revision. /// This exception is also if a policy revision id of 0 is provided via PutResourcePolicy /// and a policy with the same name already exists. /// /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteResourcePolicy Operation DeleteResourcePolicyResponse DeleteResourcePolicy(DeleteResourcePolicyRequest request); /// /// Deletes a resource policy from the target Amazon Web Services account. /// /// Container for the necessary parameters to execute the DeleteResourcePolicy service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteResourcePolicy service method, as returned by XRay. /// /// A policy revision id was provided which does not match the latest policy revision. /// This exception is also if a policy revision id of 0 is provided via PutResourcePolicy /// and a policy with the same name already exists. /// /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteResourcePolicy Operation Task DeleteResourcePolicyAsync(DeleteResourcePolicyRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteSamplingRule /// /// Deletes a sampling rule. /// /// Container for the necessary parameters to execute the DeleteSamplingRule service method. /// /// The response from the DeleteSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteSamplingRule Operation DeleteSamplingRuleResponse DeleteSamplingRule(DeleteSamplingRuleRequest request); /// /// Deletes a sampling rule. /// /// Container for the necessary parameters to execute the DeleteSamplingRule service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for DeleteSamplingRule Operation Task DeleteSamplingRuleAsync(DeleteSamplingRuleRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetEncryptionConfig /// /// Retrieves the current encryption configuration for X-Ray data. /// /// Container for the necessary parameters to execute the GetEncryptionConfig service method. /// /// The response from the GetEncryptionConfig service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetEncryptionConfig Operation GetEncryptionConfigResponse GetEncryptionConfig(GetEncryptionConfigRequest request); /// /// Retrieves the current encryption configuration for X-Ray data. /// /// Container for the necessary parameters to execute the GetEncryptionConfig service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetEncryptionConfig service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetEncryptionConfig Operation Task GetEncryptionConfigAsync(GetEncryptionConfigRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroup /// /// Retrieves group resource details. /// /// Container for the necessary parameters to execute the GetGroup service method. /// /// The response from the GetGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetGroup Operation GetGroupResponse GetGroup(GetGroupRequest request); /// /// Retrieves group resource details. /// /// Container for the necessary parameters to execute the GetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetGroup Operation Task GetGroupAsync(GetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroups /// /// Retrieves all active group details. /// /// Container for the necessary parameters to execute the GetGroups service method. /// /// The response from the GetGroups service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetGroups Operation GetGroupsResponse GetGroups(GetGroupsRequest request); /// /// Retrieves all active group details. /// /// Container for the necessary parameters to execute the GetGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroups service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetGroups Operation Task GetGroupsAsync(GetGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetInsight /// /// 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. /// /// Container for the necessary parameters to execute the GetInsight service method. /// /// The response from the GetInsight service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsight Operation GetInsightResponse GetInsight(GetInsightRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the GetInsight service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetInsight service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsight Operation Task GetInsightAsync(GetInsightRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetInsightEvents /// /// 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. /// /// Container for the necessary parameters to execute the GetInsightEvents service method. /// /// The response from the GetInsightEvents service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightEvents Operation GetInsightEventsResponse GetInsightEvents(GetInsightEventsRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the GetInsightEvents service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetInsightEvents service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightEvents Operation Task GetInsightEventsAsync(GetInsightEventsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetInsightImpactGraph /// /// 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. /// /// Container for the necessary parameters to execute the GetInsightImpactGraph service method. /// /// The response from the GetInsightImpactGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightImpactGraph Operation GetInsightImpactGraphResponse GetInsightImpactGraph(GetInsightImpactGraphRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the GetInsightImpactGraph service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetInsightImpactGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightImpactGraph Operation Task GetInsightImpactGraphAsync(GetInsightImpactGraphRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetInsightSummaries /// /// Retrieves the summaries of all insights in the specified group matching the provided /// filter values. /// /// Container for the necessary parameters to execute the GetInsightSummaries service method. /// /// The response from the GetInsightSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightSummaries Operation GetInsightSummariesResponse GetInsightSummaries(GetInsightSummariesRequest request); /// /// Retrieves the summaries of all insights in the specified group matching the provided /// filter values. /// /// Container for the necessary parameters to execute the GetInsightSummaries service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetInsightSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetInsightSummaries Operation Task GetInsightSummariesAsync(GetInsightSummariesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetSamplingRules /// /// Retrieves all sampling rules. /// /// Container for the necessary parameters to execute the GetSamplingRules service method. /// /// The response from the GetSamplingRules service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingRules Operation GetSamplingRulesResponse GetSamplingRules(GetSamplingRulesRequest request); /// /// Retrieves all sampling rules. /// /// Container for the necessary parameters to execute the GetSamplingRules service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetSamplingRules service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingRules Operation Task GetSamplingRulesAsync(GetSamplingRulesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetSamplingStatisticSummaries /// /// Retrieves information about recent sampling results for all sampling rules. /// /// Container for the necessary parameters to execute the GetSamplingStatisticSummaries service method. /// /// The response from the GetSamplingStatisticSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingStatisticSummaries Operation GetSamplingStatisticSummariesResponse GetSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request); /// /// Retrieves information about recent sampling results for all sampling rules. /// /// Container for the necessary parameters to execute the GetSamplingStatisticSummaries service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetSamplingStatisticSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingStatisticSummaries Operation Task GetSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetSamplingTargets /// /// Requests a sampling quota for rules that the service is using to sample requests. /// /// Container for the necessary parameters to execute the GetSamplingTargets service method. /// /// The response from the GetSamplingTargets service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingTargets Operation GetSamplingTargetsResponse GetSamplingTargets(GetSamplingTargetsRequest request); /// /// Requests a sampling quota for rules that the service is using to sample requests. /// /// Container for the necessary parameters to execute the GetSamplingTargets service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetSamplingTargets service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetSamplingTargets Operation Task GetSamplingTargetsAsync(GetSamplingTargetsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetServiceGraph /// /// 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. /// /// Container for the necessary parameters to execute the GetServiceGraph service method. /// /// The response from the GetServiceGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetServiceGraph Operation GetServiceGraphResponse GetServiceGraph(GetServiceGraphRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the GetServiceGraph service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetServiceGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetServiceGraph Operation Task GetServiceGraphAsync(GetServiceGraphRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetTimeSeriesServiceStatistics /// /// Get an aggregation of service statistics defined by a specific time range. /// /// Container for the necessary parameters to execute the GetTimeSeriesServiceStatistics service method. /// /// The response from the GetTimeSeriesServiceStatistics service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTimeSeriesServiceStatistics Operation GetTimeSeriesServiceStatisticsResponse GetTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest request); /// /// Get an aggregation of service statistics defined by a specific time range. /// /// Container for the necessary parameters to execute the GetTimeSeriesServiceStatistics service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetTimeSeriesServiceStatistics service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTimeSeriesServiceStatistics Operation Task GetTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetTraceGraph /// /// Retrieves a service graph for one or more specific trace IDs. /// /// Container for the necessary parameters to execute the GetTraceGraph service method. /// /// The response from the GetTraceGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTraceGraph Operation GetTraceGraphResponse GetTraceGraph(GetTraceGraphRequest request); /// /// Retrieves a service graph for one or more specific trace IDs. /// /// Container for the necessary parameters to execute the GetTraceGraph service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetTraceGraph service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTraceGraph Operation Task GetTraceGraphAsync(GetTraceGraphRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// Container for the necessary parameters to execute the GetTraceSummaries service method. /// /// The response from the GetTraceSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTraceSummaries Operation GetTraceSummariesResponse GetTraceSummaries(GetTraceSummariesRequest request); /// /// 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. /// /// /// Container for the necessary parameters to execute the GetTraceSummaries service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetTraceSummaries service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for GetTraceSummaries Operation Task GetTraceSummariesAsync(GetTraceSummariesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListResourcePolicies /// /// Returns the list of resource policies in the target Amazon Web Services account. /// /// Container for the necessary parameters to execute the ListResourcePolicies service method. /// /// The response from the ListResourcePolicies service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for ListResourcePolicies Operation ListResourcePoliciesResponse ListResourcePolicies(ListResourcePoliciesRequest request); /// /// Returns the list of resource policies in the target Amazon Web Services account. /// /// Container for the necessary parameters to execute the ListResourcePolicies service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListResourcePolicies service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for ListResourcePolicies Operation Task ListResourcePoliciesAsync(ListResourcePoliciesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Returns a list of tags that are applied to the specified Amazon Web Services X-Ray /// group or sampling rule. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Returns a list of tags that are applied to the specified Amazon Web Services X-Ray /// group or sampling rule. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutEncryptionConfig /// /// Updates the encryption configuration for X-Ray data. /// /// Container for the necessary parameters to execute the PutEncryptionConfig service method. /// /// The response from the PutEncryptionConfig service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutEncryptionConfig Operation PutEncryptionConfigResponse PutEncryptionConfig(PutEncryptionConfigRequest request); /// /// Updates the encryption configuration for X-Ray data. /// /// Container for the necessary parameters to execute the PutEncryptionConfig service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutEncryptionConfig service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutEncryptionConfig Operation Task PutEncryptionConfigAsync(PutEncryptionConfigRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutResourcePolicy /// /// 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. /// /// Container for the necessary parameters to execute the PutResourcePolicy service method. /// /// The response from the PutResourcePolicy service method, as returned by XRay. /// /// A policy revision id was provided which does not match the latest policy revision. /// This exception is also if a policy revision id of 0 is provided via PutResourcePolicy /// and a policy with the same name already exists. /// /// /// The provided resource policy would prevent the caller of this request from calling /// PutResourcePolicy in the future. /// /// /// Invalid policy document provided in request. /// /// /// Exceeded the maximum number of resource policies for a target Amazon Web Services /// account. /// /// /// Exceeded the maximum size for a resource policy. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutResourcePolicy Operation PutResourcePolicyResponse PutResourcePolicy(PutResourcePolicyRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the PutResourcePolicy service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutResourcePolicy service method, as returned by XRay. /// /// A policy revision id was provided which does not match the latest policy revision. /// This exception is also if a policy revision id of 0 is provided via PutResourcePolicy /// and a policy with the same name already exists. /// /// /// The provided resource policy would prevent the caller of this request from calling /// PutResourcePolicy in the future. /// /// /// Invalid policy document provided in request. /// /// /// Exceeded the maximum number of resource policies for a target Amazon Web Services /// account. /// /// /// Exceeded the maximum size for a resource policy. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutResourcePolicy Operation Task PutResourcePolicyAsync(PutResourcePolicyRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutTelemetryRecords /// /// Used by the Amazon Web Services X-Ray daemon to upload telemetry. /// /// Container for the necessary parameters to execute the PutTelemetryRecords service method. /// /// The response from the PutTelemetryRecords service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutTelemetryRecords Operation PutTelemetryRecordsResponse PutTelemetryRecords(PutTelemetryRecordsRequest request); /// /// Used by the Amazon Web Services X-Ray daemon to upload telemetry. /// /// Container for the necessary parameters to execute the PutTelemetryRecords service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutTelemetryRecords service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutTelemetryRecords Operation Task PutTelemetryRecordsAsync(PutTelemetryRecordsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutTraceSegments /// /// Uploads segment documents to Amazon Web Services X-Ray. The X-Ray /// SDK generates segment documents and sends them to the X-Ray daemon, which uploads /// them in batches. A segment document can be a completed segment, an in-progress segment, /// or an array of subsegments. /// /// /// /// Segments must include the following fields. For the full segment document schema, /// see Amazon /// Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer /// Guide. /// ///

Required segment document fields /// ///

  • /// /// name - The name of the service that handled the request. /// ///
  • /// /// id - A 64-bit identifier for the segment, unique among segments in the /// same trace, in 16 hexadecimal digits. /// ///
  • /// /// trace_id - A unique identifier that connects all segments and subsegments /// originating from a single client request. /// ///
  • /// /// start_time - Time the segment or subsegment was created, in floating /// point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 /// or 1.480615200010E9. /// ///
  • /// /// end_time - Time the segment or subsegment was closed. For example, 1480615200.090 /// or 1.480615200090E9. Specify either an end_time or in_progress. /// ///
  • /// /// in_progress - Set to true instead of specifying an end_time /// to record that a segment has been started, but is not complete. Send an in-progress /// segment when your application receives a request that will take a long time to serve, /// to trace that the request was received. When the response is sent, send the complete /// segment to overwrite the in-progress segment. /// ///
/// /// A trace_id consists of three numbers separated by hyphens. For example, /// 1-58406520-a006649127e371903a2de979. This includes: /// ///

Trace ID Format /// ///

  • /// /// The version number, for instance, 1. /// ///
  • /// /// The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For /// example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, /// or 58406520 in hexadecimal. /// ///
  • /// /// A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. /// ///
/// /// Container for the necessary parameters to execute the PutTraceSegments service method. /// /// The response from the PutTraceSegments service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutTraceSegments Operation PutTraceSegmentsResponse PutTraceSegments(PutTraceSegmentsRequest request); /// /// Uploads segment documents to Amazon Web Services X-Ray. The X-Ray /// SDK generates segment documents and sends them to the X-Ray daemon, which uploads /// them in batches. A segment document can be a completed segment, an in-progress segment, /// or an array of subsegments. /// /// /// /// Segments must include the following fields. For the full segment document schema, /// see Amazon /// Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer /// Guide. /// ///

Required segment document fields /// ///

  • /// /// name - The name of the service that handled the request. /// ///
  • /// /// id - A 64-bit identifier for the segment, unique among segments in the /// same trace, in 16 hexadecimal digits. /// ///
  • /// /// trace_id - A unique identifier that connects all segments and subsegments /// originating from a single client request. /// ///
  • /// /// start_time - Time the segment or subsegment was created, in floating /// point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 /// or 1.480615200010E9. /// ///
  • /// /// end_time - Time the segment or subsegment was closed. For example, 1480615200.090 /// or 1.480615200090E9. Specify either an end_time or in_progress. /// ///
  • /// /// in_progress - Set to true instead of specifying an end_time /// to record that a segment has been started, but is not complete. Send an in-progress /// segment when your application receives a request that will take a long time to serve, /// to trace that the request was received. When the response is sent, send the complete /// segment to overwrite the in-progress segment. /// ///
/// /// A trace_id consists of three numbers separated by hyphens. For example, /// 1-58406520-a006649127e371903a2de979. This includes: /// ///

Trace ID Format /// ///

  • /// /// The version number, for instance, 1. /// ///
  • /// /// The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For /// example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, /// or 58406520 in hexadecimal. /// ///
  • /// /// A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. /// ///
/// /// Container for the necessary parameters to execute the PutTraceSegments service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutTraceSegments service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for PutTraceSegments Operation Task PutTraceSegmentsAsync(PutTraceSegmentsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// /// You have exceeded the maximum number of tags you can apply to this resource. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// /// You have exceeded the maximum number of tags you can apply to this resource. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// 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). /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// 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). /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The resource was not found. Verify that the name or Amazon Resource Name (ARN) of /// the resource is correct. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateGroup /// /// Updates a group resource. /// /// Container for the necessary parameters to execute the UpdateGroup service method. /// /// The response from the UpdateGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UpdateGroup Operation UpdateGroupResponse UpdateGroup(UpdateGroupRequest request); /// /// Updates a group resource. /// /// Container for the necessary parameters to execute the UpdateGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateGroup service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UpdateGroup Operation Task UpdateGroupAsync(UpdateGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateSamplingRule /// /// Modifies a sampling rule's configuration. /// /// Container for the necessary parameters to execute the UpdateSamplingRule service method. /// /// The response from the UpdateSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UpdateSamplingRule Operation UpdateSamplingRuleResponse UpdateSamplingRule(UpdateSamplingRuleRequest request); /// /// Modifies a sampling rule's configuration. /// /// Container for the necessary parameters to execute the UpdateSamplingRule service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateSamplingRule service method, as returned by XRay. /// /// The request is missing required parameters or has invalid parameters. /// /// /// The request exceeds the maximum number of requests per second. /// /// REST API Reference for UpdateSamplingRule Operation Task UpdateSamplingRuleAsync(UpdateSamplingRuleRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion } }