All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.xray.AWSXRay Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWS X-Ray module holds the client classes that are used for communicating with AWS X-Ray Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2018-2023 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.
 */
package com.amazonaws.services.xray;

import javax.annotation.Generated;

import com.amazonaws.*;
import com.amazonaws.regions.*;

import com.amazonaws.services.xray.model.*;

/**
 * Interface for accessing AWS X-Ray.
 * 

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.xray.AbstractAWSXRay} instead. *

*

*

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSXRay { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "xray"; /** * Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com"). Callers can use this method to * control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol * (ex: "xray.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this * client's {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *

* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "xray.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AWSXRay#setEndpoint(String)}, sets the regional endpoint for this client's service * calls. Callers can use this method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *

* This method is not threadsafe. A region should be configured when the client is created and before any service * requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit * or retrying. * * @param region * The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)} * for accessing a given region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *

* 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. *

* * @param batchGetTracesRequest * @return Result of the BatchGetTraces operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.BatchGetTraces * @see AWS API * Documentation */ BatchGetTracesResult batchGetTraces(BatchGetTracesRequest batchGetTracesRequest); /** *

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

* * @param createGroupRequest * @return Result of the CreateGroup operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.CreateGroup * @see AWS API * Documentation */ CreateGroupResult createGroup(CreateGroupRequest createGroupRequest); /** *

* 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. *

* * @param createSamplingRuleRequest * @return Result of the CreateSamplingRule operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @throws RuleLimitExceededException * You have reached the maximum number of sampling rules. * @sample AWSXRay.CreateSamplingRule * @see AWS API * Documentation */ CreateSamplingRuleResult createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest); /** *

* Deletes a group resource. *

* * @param deleteGroupRequest * @return Result of the DeleteGroup operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.DeleteGroup * @see AWS API * Documentation */ DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest); /** *

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

* * @param deleteResourcePolicyRequest * @return Result of the DeleteResourcePolicy operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws InvalidPolicyRevisionIdException * 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. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.DeleteResourcePolicy * @see AWS API * Documentation */ DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest); /** *

* Deletes a sampling rule. *

* * @param deleteSamplingRuleRequest * @return Result of the DeleteSamplingRule operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.DeleteSamplingRule * @see AWS API * Documentation */ DeleteSamplingRuleResult deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest); /** *

* Retrieves the current encryption configuration for X-Ray data. *

* * @param getEncryptionConfigRequest * @return Result of the GetEncryptionConfig operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetEncryptionConfig * @see AWS API * Documentation */ GetEncryptionConfigResult getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest); /** *

* Retrieves group resource details. *

* * @param getGroupRequest * @return Result of the GetGroup operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetGroup * @see AWS API * Documentation */ GetGroupResult getGroup(GetGroupRequest getGroupRequest); /** *

* Retrieves all active group details. *

* * @param getGroupsRequest * @return Result of the GetGroups operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetGroups * @see AWS API * Documentation */ GetGroupsResult getGroups(GetGroupsRequest getGroupsRequest); /** *

* 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. *

* * @param getInsightRequest * @return Result of the GetInsight operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetInsight * @see AWS API * Documentation */ GetInsightResult getInsight(GetInsightRequest getInsightRequest); /** *

* 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. *

* * @param getInsightEventsRequest * @return Result of the GetInsightEvents operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetInsightEvents * @see AWS API * Documentation */ GetInsightEventsResult getInsightEvents(GetInsightEventsRequest getInsightEventsRequest); /** *

* 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. *

* * @param getInsightImpactGraphRequest * @return Result of the GetInsightImpactGraph operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetInsightImpactGraph * @see AWS API * Documentation */ GetInsightImpactGraphResult getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest); /** *

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

* * @param getInsightSummariesRequest * @return Result of the GetInsightSummaries operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetInsightSummaries * @see AWS API * Documentation */ GetInsightSummariesResult getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest); /** *

* Retrieves all sampling rules. *

* * @param getSamplingRulesRequest * @return Result of the GetSamplingRules operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetSamplingRules * @see AWS API * Documentation */ GetSamplingRulesResult getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest); /** *

* Retrieves information about recent sampling results for all sampling rules. *

* * @param getSamplingStatisticSummariesRequest * @return Result of the GetSamplingStatisticSummaries operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetSamplingStatisticSummaries * @see AWS API Documentation */ GetSamplingStatisticSummariesResult getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest); /** *

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

* * @param getSamplingTargetsRequest * @return Result of the GetSamplingTargets operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetSamplingTargets * @see AWS API * Documentation */ GetSamplingTargetsResult getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest); /** *

* 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. *

* * @param getServiceGraphRequest * @return Result of the GetServiceGraph operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetServiceGraph * @see AWS API * Documentation */ GetServiceGraphResult getServiceGraph(GetServiceGraphRequest getServiceGraphRequest); /** *

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

* * @param getTimeSeriesServiceStatisticsRequest * @return Result of the GetTimeSeriesServiceStatistics operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetTimeSeriesServiceStatistics * @see AWS API Documentation */ GetTimeSeriesServiceStatisticsResult getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest); /** *

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

* * @param getTraceGraphRequest * @return Result of the GetTraceGraph operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetTraceGraph * @see AWS API * Documentation */ GetTraceGraphResult getTraceGraph(GetTraceGraphRequest getTraceGraphRequest); /** *

* 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. *

* * @param getTraceSummariesRequest * @return Result of the GetTraceSummaries operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.GetTraceSummaries * @see AWS API * Documentation */ GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest); /** *

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

* * @param listResourcePoliciesRequest * @return Result of the ListResourcePolicies operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.ListResourcePolicies * @see AWS API * Documentation */ ListResourcePoliciesResult listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest); /** *

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

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @throws ResourceNotFoundException * The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is * correct. * @sample AWSXRay.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Updates the encryption configuration for X-Ray data. *

* * @param putEncryptionConfigRequest * @return Result of the PutEncryptionConfig operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.PutEncryptionConfig * @see AWS API * Documentation */ PutEncryptionConfigResult putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest); /** *

* 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. *

* * @param putResourcePolicyRequest * @return Result of the PutResourcePolicy operation returned by the service. * @throws MalformedPolicyDocumentException * Invalid policy document provided in request. * @throws LockoutPreventionException * The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in * the future. * @throws InvalidPolicyRevisionIdException * 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. * @throws PolicySizeLimitExceededException * Exceeded the maximum size for a resource policy. * @throws PolicyCountLimitExceededException * Exceeded the maximum number of resource policies for a target Amazon Web Services account. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.PutResourcePolicy * @see AWS API * Documentation */ PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest); /** *

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

* * @param putTelemetryRecordsRequest * @return Result of the PutTelemetryRecords operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.PutTelemetryRecords * @see AWS API * Documentation */ PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest); /** *

* 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. *

    *
  • *
* * @param putTraceSegmentsRequest * @return Result of the PutTraceSegments operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.PutTraceSegments * @see AWS API * Documentation */ PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest); /** *

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

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @throws ResourceNotFoundException * The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is * correct. * @throws TooManyTagsException * You have exceeded the maximum number of tags you can apply to this resource. * @sample AWSXRay.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* 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). *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @throws ResourceNotFoundException * The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is * correct. * @sample AWSXRay.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates a group resource. *

* * @param updateGroupRequest * @return Result of the UpdateGroup operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.UpdateGroup * @see AWS API * Documentation */ UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest); /** *

* Modifies a sampling rule's configuration. *

* * @param updateSamplingRuleRequest * @return Result of the UpdateSamplingRule operation returned by the service. * @throws InvalidRequestException * The request is missing required parameters or has invalid parameters. * @throws ThrottledException * The request exceeds the maximum number of requests per second. * @sample AWSXRay.UpdateSamplingRule * @see AWS API * Documentation */ UpdateSamplingRuleResult updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy