AWSXRayClient (AWS Java SDK for AWS X-Ray 1.12.124 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.xray.AWSXRayClient

All Implemented Interfaces:

AWSXRay

Direct Known Subclasses:

AWSXRayAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSXRayClient
extends AmazonWebServiceClient
implements AWSXRay
```
Client for accessing AWS X-Ray. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Web Services 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

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.xray.AWSXRay
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AWSXRayClient()` Deprecated. use `AWSXRayClientBuilder.defaultClient()`
`AWSXRayClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSXRayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSXRayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSXRayClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetTracesResult`	`batchGetTraces(BatchGetTracesRequest request)` Retrieves a list of traces specified by ID.
`static AWSXRayClientBuilder`	`builder()`
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates a group resource with a name and a filter expression.
`CreateSamplingRuleResult`	`createSamplingRule(CreateSamplingRuleRequest request)` Creates a rule to control sampling behavior for instrumented applications.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes a group resource.
`DeleteSamplingRuleResult`	`deleteSamplingRule(DeleteSamplingRuleRequest request)` 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 request)` Retrieves the current encryption configuration for X-Ray data.
`GetGroupResult`	`getGroup(GetGroupRequest request)` Retrieves group resource details.
`GetGroupsResult`	`getGroups(GetGroupsRequest request)` Retrieves all active group details.
`GetInsightResult`	`getInsight(GetInsightRequest request)` Retrieves the summary information of an insight.
`GetInsightEventsResult`	`getInsightEvents(GetInsightEventsRequest request)` X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
`GetInsightImpactGraphResult`	`getInsightImpactGraph(GetInsightImpactGraphRequest request)` Retrieves a service graph structure filtered by the specified insight.
`GetInsightSummariesResult`	`getInsightSummaries(GetInsightSummariesRequest request)` Retrieves the summaries of all insights in the specified group matching the provided filter values.
`GetSamplingRulesResult`	`getSamplingRules(GetSamplingRulesRequest request)` Retrieves all sampling rules.
`GetSamplingStatisticSummariesResult`	`getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)` Retrieves information about recent sampling results for all sampling rules.
`GetSamplingTargetsResult`	`getSamplingTargets(GetSamplingTargetsRequest request)` Requests a sampling quota for rules that the service is using to sample requests.
`GetServiceGraphResult`	`getServiceGraph(GetServiceGraphRequest request)` Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
`GetTimeSeriesServiceStatisticsResult`	`getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest request)` Get an aggregation of service statistics defined by a specific time range.
`GetTraceGraphResult`	`getTraceGraph(GetTraceGraphRequest request)` Retrieves a service graph for one or more specific trace IDs.
`GetTraceSummariesResult`	`getTraceSummaries(GetTraceSummariesRequest request)` Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
`PutEncryptionConfigResult`	`putEncryptionConfig(PutEncryptionConfigRequest request)` Updates the encryption configuration for X-Ray data.
`PutTelemetryRecordsResult`	`putTelemetryRecords(PutTelemetryRecordsRequest request)` Used by the Amazon Web Services X-Ray daemon to upload telemetry.
`PutTraceSegmentsResult`	`putTraceSegments(PutTraceSegmentsRequest request)` Uploads segment documents to Amazon Web Services X-Ray.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from an Amazon Web Services X-Ray group or sampling rule.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest request)` Updates a group resource.
`UpdateSamplingRuleResult`	`updateSamplingRule(UpdateSamplingRuleRequest request)` Modifies a sampling rule's configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.xray.AWSXRay
setEndpoint, setRegion

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient()
```
    Deprecated. use AWSXRayClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on AWS X-Ray. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on AWS X-Ray. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSXRayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(AWSCredentials awsCredentials,
                                 ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings, retry counts, etc.).
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
                                 ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings, retry counts, etc.).
  - AWSXRayClient
```
@Deprecated
public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
                                 ClientConfiguration clientConfiguration,
                                 RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSXRayClientBuilder builder()
```
  - batchGetTraces
```
public BatchGetTracesResult 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.
    
    Specified by:
    
    batchGetTraces in interface AWSXRay
    
    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
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Creates a group resource with a name and a filter expression.
    
    Specified by:
    
    createGroup in interface AWSXRay
    
    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
```
public CreateSamplingRuleResult 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.
    
    Specified by:
    
    createSamplingRule in interface AWSXRay
    
    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
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Deletes a group resource.
    
    Specified by:
    
    deleteGroup in interface AWSXRay
    
    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
```
public DeleteSamplingRuleResult deleteSamplingRule(DeleteSamplingRuleRequest request)
```
    Deletes a sampling rule.
    
    Specified by:
    
    deleteSamplingRule in interface AWSXRay
    
    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
```
public GetEncryptionConfigResult getEncryptionConfig(GetEncryptionConfigRequest request)
```
    Retrieves the current encryption configuration for X-Ray data.
    
    Specified by:
    
    getEncryptionConfig in interface AWSXRay
    
    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
```
public GetGroupResult getGroup(GetGroupRequest request)
```
    Retrieves group resource details.
    
    Specified by:
    
    getGroup in interface AWSXRay
    
    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
```
public GetGroupsResult getGroups(GetGroupsRequest request)
```
    Retrieves all active group details.
    
    Specified by:
    
    getGroups in interface AWSXRay
    
    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
  - getInsight
```
public GetInsightResult 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.
    
    Specified by:
    
    getInsight in interface AWSXRay
    
    Parameters:
    
    getInsightRequest -
    
    Returns:
    
    Result of the GetInsight 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
  - getInsightEvents
```
public GetInsightEventsResult 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.
    
    Specified by:
    
    getInsightEvents in interface AWSXRay
    
    Parameters:
    
    getInsightEventsRequest -
    
    Returns:
    
    Result of the GetInsightEvents 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
  - getInsightImpactGraph
```
public GetInsightImpactGraphResult 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.
    
    Specified by:
    
    getInsightImpactGraph in interface AWSXRay
    
    Parameters:
    
    getInsightImpactGraphRequest -
    
    Returns:
    
    Result of the GetInsightImpactGraph 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
  - getInsightSummaries
```
public GetInsightSummariesResult getInsightSummaries(GetInsightSummariesRequest request)
```
    Retrieves the summaries of all insights in the specified group matching the provided filter values.
    
    Specified by:
    
    getInsightSummaries in interface AWSXRay
    
    Parameters:
    
    getInsightSummariesRequest -
    
    Returns:
    
    Result of the GetInsightSummaries 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
```
public GetSamplingRulesResult getSamplingRules(GetSamplingRulesRequest request)
```
    Retrieves all sampling rules.
    
    Specified by:
    
    getSamplingRules in interface AWSXRay
    
    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
```
public GetSamplingStatisticSummariesResult getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)
```
    Retrieves information about recent sampling results for all sampling rules.
    
    Specified by:
    
    getSamplingStatisticSummaries in interface AWSXRay
    
    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
```
public GetSamplingTargetsResult getSamplingTargets(GetSamplingTargetsRequest request)
```
    Requests a sampling quota for rules that the service is using to sample requests.
    
    Specified by:
    
    getSamplingTargets in interface AWSXRay
    
    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
```
public GetServiceGraphResult 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.
    
    Specified by:
    
    getServiceGraph in interface AWSXRay
    
    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
```
public GetTimeSeriesServiceStatisticsResult getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest request)
```
    Get an aggregation of service statistics defined by a specific time range.
    
    Specified by:
    
    getTimeSeriesServiceStatistics in interface AWSXRay
    
    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
```
public GetTraceGraphResult getTraceGraph(GetTraceGraphRequest request)
```
    Retrieves a service graph for one or more specific trace IDs.
    
    Specified by:
    
    getTraceGraph in interface AWSXRay
    
    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
```
public GetTraceSummariesResult 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.
    
    Specified by:
    
    getTraceSummaries in interface AWSXRay
    
    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
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
    
    Specified by:
    
    listTagsForResource in interface AWSXRay
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource 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.
    
    ResourceNotFoundException - The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
    
    See Also:
    
    AWS API Documentation
  - putEncryptionConfig
```
public PutEncryptionConfigResult putEncryptionConfig(PutEncryptionConfigRequest request)
```
    Updates the encryption configuration for X-Ray data.
    
    Specified by:
    
    putEncryptionConfig in interface AWSXRay
    
    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
```
public PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)
```
    Used by the Amazon Web Services X-Ray daemon to upload telemetry.
    
    Specified by:
    
    putTelemetryRecords in interface AWSXRay
    
    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
```
public PutTraceSegmentsResult 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.
    Specified by:
    
    putTraceSegments in interface AWSXRay
    
    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
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
    
    Specified by:
    
    tagResource in interface AWSXRay
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource 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.
    
    ResourceNotFoundException - The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
    
    TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult 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).
    
    Specified by:
    
    untagResource in interface AWSXRay
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource 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.
    
    ResourceNotFoundException - The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
```
    Updates a group resource.
    
    Specified by:
    
    updateGroup in interface AWSXRay
    
    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
```
public UpdateSamplingRuleResult updateSamplingRule(UpdateSamplingRuleRequest request)
```
    Modifies a sampling rule's configuration.
    
    Specified by:
    
    updateSamplingRule in interface AWSXRay
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSXRay
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSXRay
    
    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.
    
    Specified by:
    
    shutdown in interface AWSXRay
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSXRayClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.xray.AWSXRay

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.xray.AWSXRay

Field Detail

configFactory

Constructor Detail

AWSXRayClient

AWSXRayClient

AWSXRayClient

AWSXRayClient

AWSXRayClient

AWSXRayClient

AWSXRayClient

Method Detail

builder

batchGetTraces

createGroup

createSamplingRule

deleteGroup

deleteSamplingRule

getEncryptionConfig

getGroup

getGroups

getInsight

getInsightEvents

getInsightImpactGraph

getInsightSummaries

getSamplingRules

getSamplingStatisticSummaries

getSamplingTargets

getServiceGraph

getTimeSeriesServiceStatistics

getTraceGraph

getTraceSummaries

listTagsForResource

putEncryptionConfig

putTelemetryRecords

putTraceSegments

tagResource

untagResource

updateGroup

updateSamplingRule

getCachedResponseMetadata

shutdown