AWSXRay (AWS Java SDK for AWS X-Ray 1.11.799 API)

All Known Subinterfaces:

AWSXRayAsync

All Known Implementing Classes:

AbstractAWSXRay, AbstractAWSXRayAsync, AWSXRayAsyncClient, AWSXRayClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSXRay
```
Interface for accessing AWS X-Ray.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSXRay instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BatchGetTracesResult`	`batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)` Retrieves a list of traces specified by ID.
`CreateGroupResult`	`createGroup(CreateGroupRequest createGroupRequest)` Creates a group resource with a name and a filter expression.
`CreateSamplingRuleResult`	`createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest)` Creates a rule to control sampling behavior for instrumented applications.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)` Deletes a group resource.
`DeleteSamplingRuleResult`	`deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)` Deletes a sampling rule.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetEncryptionConfigResult`	`getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)` Retrieves the current encryption configuration for X-Ray data.
`GetGroupResult`	`getGroup(GetGroupRequest getGroupRequest)` Retrieves group resource details.
`GetGroupsResult`	`getGroups(GetGroupsRequest getGroupsRequest)` Retrieves all active group details.
`GetSamplingRulesResult`	`getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)` Retrieves all sampling rules.
`GetSamplingStatisticSummariesResult`	`getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)` Retrieves information about recent sampling results for all sampling rules.
`GetSamplingTargetsResult`	`getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)` Requests a sampling quota for rules that the service is using to sample requests.
`GetServiceGraphResult`	`getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)` Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
`GetTimeSeriesServiceStatisticsResult`	`getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)` Get an aggregation of service statistics defined by a specific time range.
`GetTraceGraphResult`	`getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)` Retrieves a service graph for one or more specific trace IDs.
`GetTraceSummariesResult`	`getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)` Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
`PutEncryptionConfigResult`	`putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)` Updates the encryption configuration for X-Ray data.
`PutTelemetryRecordsResult`	`putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)` Used by the AWS X-Ray daemon to upload telemetry.
`PutTraceSegmentsResult`	`putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)` Uploads segment documents to AWS X-Ray.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest updateGroupRequest)` Updates a group resource.
`UpdateSamplingRuleResult`	`updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)` Modifies a sampling rule's configuration.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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 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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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 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.
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - batchGetTraces
```
BatchGetTracesResult batchGetTraces(BatchGetTracesRequest 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.
    
    Parameters:
    
    batchGetTracesRequest -
    
    Returns:
    
    Result of the BatchGetTraces operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    Creates a group resource with a name and a filter expression.
    
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - createSamplingRule
```
CreateSamplingRuleResult createSamplingRule(CreateSamplingRuleRequest 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.
    
    Parameters:
    
    createSamplingRuleRequest -
    
    Returns:
    
    Result of the CreateSamplingRule operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    RuleLimitExceededException - You have reached the maximum number of sampling rules.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Deletes a group resource.
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - deleteSamplingRule
```
DeleteSamplingRuleResult deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
```
    Deletes a sampling rule.
    
    Parameters:
    
    deleteSamplingRuleRequest -
    
    Returns:
    
    Result of the DeleteSamplingRule operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getEncryptionConfig
```
GetEncryptionConfigResult getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)
```
    Retrieves the current encryption configuration for X-Ray data.
    
    Parameters:
    
    getEncryptionConfigRequest -
    
    Returns:
    
    Result of the GetEncryptionConfig operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
GetGroupResult getGroup(GetGroupRequest getGroupRequest)
```
    Retrieves group resource details.
    
    Parameters:
    
    getGroupRequest -
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getGroups
```
GetGroupsResult getGroups(GetGroupsRequest getGroupsRequest)
```
    Retrieves all active group details.
    
    Parameters:
    
    getGroupsRequest -
    
    Returns:
    
    Result of the GetGroups operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getSamplingRules
```
GetSamplingRulesResult getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)
```
    Retrieves all sampling rules.
    
    Parameters:
    
    getSamplingRulesRequest -
    
    Returns:
    
    Result of the GetSamplingRules operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getSamplingStatisticSummaries
```
GetSamplingStatisticSummariesResult getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
```
    Retrieves information about recent sampling results for all sampling rules.
    
    Parameters:
    
    getSamplingStatisticSummariesRequest -
    
    Returns:
    
    Result of the GetSamplingStatisticSummaries operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getSamplingTargets
```
GetSamplingTargetsResult getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)
```
    Requests a sampling quota for rules that the service is using to sample requests.
    
    Parameters:
    
    getSamplingTargetsRequest -
    
    Returns:
    
    Result of the GetSamplingTargets operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getServiceGraph
```
GetServiceGraphResult getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
```
    Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
    
    Parameters:
    
    getServiceGraphRequest -
    
    Returns:
    
    Result of the GetServiceGraph operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getTimeSeriesServiceStatistics
```
GetTimeSeriesServiceStatisticsResult getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
```
    Get an aggregation of service statistics defined by a specific time range.
    
    Parameters:
    
    getTimeSeriesServiceStatisticsRequest -
    
    Returns:
    
    Result of the GetTimeSeriesServiceStatistics operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getTraceGraph
```
GetTraceGraphResult getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
```
    Retrieves a service graph for one or more specific trace IDs.
    
    Parameters:
    
    getTraceGraphRequest -
    
    Returns:
    
    Result of the GetTraceGraph operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - getTraceSummaries
```
GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest 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 AWS X-Ray Developer Guide.
    
    Parameters:
    
    getTraceSummariesRequest -
    
    Returns:
    
    Result of the GetTraceSummaries operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - putEncryptionConfig
```
PutEncryptionConfigResult putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)
```
    Updates the encryption configuration for X-Ray data.
    
    Parameters:
    
    putEncryptionConfigRequest -
    
    Returns:
    
    Result of the PutEncryptionConfig operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - putTelemetryRecords
```
PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
```
    Used by the AWS X-Ray daemon to upload telemetry.
    
    Parameters:
    
    putTelemetryRecordsRequest -
    
    Returns:
    
    Result of the PutTelemetryRecords operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - putTraceSegments
```
PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
```
    Uploads segment documents to AWS 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 AWS X-Ray Segment Documents in the AWS 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 the fact 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, i.e. 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.
    Parameters:
    
    putTraceSegmentsRequest -
    
    Returns:
    
    Result of the PutTraceSegments operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
```
    Updates a group resource.
    
    Parameters:
    
    updateGroupRequest -
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - updateSamplingRule
```
UpdateSamplingRuleResult updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)
```
    Modifies a sampling rule's configuration.
    
    Parameters:
    
    updateSamplingRuleRequest -
    
    Returns:
    
    Result of the UpdateSamplingRule operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is missing required parameters or has invalid parameters.
    
    ThrottledException - The request exceeds the maximum number of requests per second.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSXRay

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

batchGetTraces

createGroup

createSamplingRule

deleteGroup

deleteSamplingRule

getEncryptionConfig

getGroup

getGroups

getSamplingRules

getSamplingStatisticSummaries

getSamplingTargets

getServiceGraph

getTimeSeriesServiceStatistics

getTraceGraph

getTraceSummaries

putEncryptionConfig

putTelemetryRecords

putTraceSegments

updateGroup

updateSamplingRule

shutdown

getCachedResponseMetadata