@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface XRayClient extends AwsClient
builder() method.
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGetTracesResponse |
batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesResponse |
batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesIterable |
batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesIterable |
batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
static XRayClientBuilder |
builder()
Create a builder that can be used to configure and create a
XRayClient. |
static XRayClient |
create()
Create a
XRayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CreateSamplingRuleResponse |
createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default CreateSamplingRuleResponse |
createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group resource.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group resource.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a resource policy from the target Amazon Web Services account.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy from the target Amazon Web Services account.
|
default DeleteSamplingRuleResponse |
deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default DeleteSamplingRuleResponse |
deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default GetEncryptionConfigResponse |
getEncryptionConfig()
Retrieves the current encryption configuration for X-Ray data.
|
default GetEncryptionConfigResponse |
getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default GetEncryptionConfigResponse |
getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default GetGroupResponse |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Retrieves group resource details.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest)
Retrieves group resource details.
|
default GetGroupsResponse |
getGroups()
Retrieves all active group details.
|
default GetGroupsResponse |
getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsResponse |
getGroups(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsIterable |
getGroupsPaginator()
Retrieves all active group details.
|
default GetGroupsIterable |
getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsIterable |
getGroupsPaginator(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
|
default GetInsightResponse |
getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest)
Retrieves the summary information of an insight.
|
default GetInsightResponse |
getInsight(GetInsightRequest getInsightRequest)
Retrieves the summary information of an insight.
|
default GetInsightEventsResponse |
getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightEventsResponse |
getInsightEvents(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightEventsIterable |
getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightEventsIterable |
getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightImpactGraphResponse |
getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight.
|
default GetInsightImpactGraphResponse |
getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight.
|
default GetInsightSummariesResponse |
getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetInsightSummariesResponse |
getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetInsightSummariesIterable |
getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetInsightSummariesIterable |
getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetSamplingRulesResponse |
getSamplingRules()
Retrieves all sampling rules.
|
default GetSamplingRulesResponse |
getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesResponse |
getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesIterable |
getSamplingRulesPaginator()
Retrieves all sampling rules.
|
default GetSamplingRulesIterable |
getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesIterable |
getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries()
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesResponse |
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesIterable |
getSamplingStatisticSummariesPaginator()
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesIterable |
getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesIterable |
getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingTargetsResponse |
getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default GetSamplingTargetsResponse |
getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default GetServiceGraphResponse |
getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphResponse |
getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphIterable |
getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphIterable |
getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetTimeSeriesServiceStatisticsResponse |
getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTimeSeriesServiceStatisticsResponse |
getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTimeSeriesServiceStatisticsIterable |
getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTimeSeriesServiceStatisticsIterable |
getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTraceGraphResponse |
getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphResponse |
getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphIterable |
getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphIterable |
getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceSummariesResponse |
getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesResponse |
getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesIterable |
getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesIterable |
getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default ListResourcePoliciesResponse |
listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest)
Returns the list of resource policies in the target Amazon Web Services account.
|
default ListResourcePoliciesResponse |
listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest)
Returns the list of resource policies in the target Amazon Web Services account.
|
default ListResourcePoliciesIterable |
listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest)
Returns the list of resource policies in the target Amazon Web Services account.
|
default ListResourcePoliciesIterable |
listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest)
Returns the list of resource policies in the target Amazon Web Services account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
|
default PutEncryptionConfigResponse |
putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default PutEncryptionConfigResponse |
putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access
X-Ray.
|
default PutResourcePolicyResponse |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access
X-Ray.
|
default PutTelemetryRecordsResponse |
putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
|
default PutTelemetryRecordsResponse |
putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
|
default PutTraceSegmentsResponse |
putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)
Uploads segment documents to Amazon Web Services X-Ray.
|
default PutTraceSegmentsResponse |
putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
Uploads segment documents to Amazon Web Services X-Ray.
|
default XRayServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services X-Ray group or sampling rule.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services X-Ray group or sampling rule.
|
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates a group resource.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates a group resource.
|
default UpdateSamplingRuleResponse |
updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
default UpdateSamplingRuleResponse |
updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default BatchGetTracesResponse batchGetTraces(BatchGetTracesRequest batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
batchGetTracesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetTracesResponse batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest - A Consumer that will call methods on BatchGetTracesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetTracesIterable batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
for (software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation.
batchGetTracesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetTracesIterable batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
for (software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.BatchGetTracesIterable responses = client.batchGetTracesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest - A Consumer that will call methods on BatchGetTracesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Creates a group resource with a name and a filter expression.
createGroupRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Creates a group resource with a name and a filter expression.
This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSamplingRuleResponse createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest) throws InvalidRequestException, ThrottledException, RuleLimitExceededException, AwsServiceException, SdkClientException, XRayException
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.
createSamplingRuleRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSamplingRuleResponse createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest) throws InvalidRequestException, ThrottledException, RuleLimitExceededException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the CreateSamplingRuleRequest.Builder avoiding the
need to create one manually via CreateSamplingRuleRequest.builder()
createSamplingRuleRequest - A Consumer that will call methods on CreateSamplingRuleRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a group resource.
deleteGroupRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a group resource.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InvalidRequestException, InvalidPolicyRevisionIdException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a resource policy from the target Amazon Web Services account.
deleteResourcePolicyRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.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.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InvalidRequestException, InvalidPolicyRevisionIdException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a resource policy from the target Amazon Web Services account.
This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the
need to create one manually via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.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.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSamplingRuleResponse deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a sampling rule.
deleteSamplingRuleRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSamplingRuleResponse deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Deletes a sampling rule.
This is a convenience which creates an instance of the DeleteSamplingRuleRequest.Builder avoiding the
need to create one manually via DeleteSamplingRuleRequest.builder()
deleteSamplingRuleRequest - A Consumer that will call methods on DeleteSamplingRuleRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEncryptionConfigResponse getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEncryptionConfigResponse getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
This is a convenience which creates an instance of the GetEncryptionConfigRequest.Builder avoiding the
need to create one manually via GetEncryptionConfigRequest.builder()
getEncryptionConfigRequest - A Consumer that will call methods on GetEncryptionConfigRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEncryptionConfigResponse getEncryptionConfig() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the current encryption configuration for X-Ray data.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetEncryptionConfig(GetEncryptionConfigRequest),
AWS API
Documentationdefault GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves group resource details.
getGroupRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves group resource details.
This is a convenience which creates an instance of the GetGroupRequest.Builder avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupsResponse getGroups(GetGroupsRequest getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
getGroupsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupsResponse getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
This is a convenience which creates an instance of the GetGroupsRequest.Builder avoiding the need to
create one manually via GetGroupsRequest.builder()
getGroupsRequest - A Consumer that will call methods on GetGroupsRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupsResponse getGroups() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetGroups(GetGroupsRequest),
AWS API
Documentationdefault GetGroupsIterable getGroupsPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetGroupsPaginator(GetGroupsRequest),
AWS API
Documentationdefault GetGroupsIterable getGroupsPaginator(GetGroupsRequest getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
getGroupsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupsIterable getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetGroupsIterable responses = client.getGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.
This is a convenience which creates an instance of the GetGroupsRequest.Builder avoiding the need to
create one manually via GetGroupsRequest.builder()
getGroupsRequest - A Consumer that will call methods on GetGroupsRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightResponse getInsight(GetInsightRequest getInsightRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getInsightRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightResponse getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetInsightRequest.Builder avoiding the need to
create one manually via GetInsightRequest.builder()
getInsightRequest - A Consumer that will call methods on GetInsightRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightEventsResponse getInsightEvents(GetInsightEventsRequest getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getInsightEventsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightEventsResponse getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetInsightEventsRequest.Builder avoiding the need
to create one manually via GetInsightEventsRequest.builder()
getInsightEventsRequest - A Consumer that will call methods on GetInsightEventsRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightEventsIterable getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client
.getInsightEventsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation.
getInsightEventsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightEventsIterable getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client
.getInsightEventsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetInsightEventsIterable responses = client.getInsightEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation.
This is a convenience which creates an instance of the GetInsightEventsRequest.Builder avoiding the need
to create one manually via GetInsightEventsRequest.builder()
getInsightEventsRequest - A Consumer that will call methods on GetInsightEventsRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightImpactGraphResponse getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getInsightImpactGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightImpactGraphResponse getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetInsightImpactGraphRequest.Builder avoiding the
need to create one manually via GetInsightImpactGraphRequest.builder()
getInsightImpactGraphRequest - A Consumer that will call methods on GetInsightImpactGraphRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSummariesResponse getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the summaries of all insights in the specified group matching the provided filter values.
getInsightSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSummariesResponse getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder avoiding the
need to create one manually via GetInsightSummariesRequest.builder()
getInsightSummariesRequest - A Consumer that will call methods on GetInsightSummariesRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSummariesIterable getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client
.getInsightSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
getInsightSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSummariesIterable getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client
.getInsightSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesIterable responses = client.getInsightSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder avoiding the
need to create one manually via GetInsightSummariesRequest.builder()
getInsightSummariesRequest - A Consumer that will call methods on GetInsightSummariesRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingRulesResponse getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
getSamplingRulesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingRulesResponse getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder avoiding the need
to create one manually via GetSamplingRulesRequest.builder()
getSamplingRulesRequest - A Consumer that will call methods on GetSamplingRulesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingRulesResponse getSamplingRules() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetSamplingRules(GetSamplingRulesRequest),
AWS API
Documentationdefault GetSamplingRulesIterable getSamplingRulesPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client
.getSamplingRulesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetSamplingRulesPaginator(GetSamplingRulesRequest),
AWS API
Documentationdefault GetSamplingRulesIterable getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client
.getSamplingRulesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.
getSamplingRulesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingRulesIterable getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client
.getSamplingRulesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesIterable responses = client.getSamplingRulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.
This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder avoiding the need
to create one manually via GetSamplingRulesRequest.builder()
getSamplingRulesRequest - A Consumer that will call methods on GetSamplingRulesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()
getSamplingStatisticSummariesRequest - A Consumer that will call methods on GetSamplingStatisticSummariesRequest.Builder to
create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingStatisticSummariesResponse getSamplingStatisticSummaries() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest),
AWS API Documentationdefault GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator() throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client
.getSamplingStatisticSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest),
AWS API Documentationdefault GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client
.getSamplingStatisticSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
getSamplingStatisticSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingStatisticSummariesIterable getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client
.getSamplingStatisticSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesIterable responses = client.getSamplingStatisticSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()
getSamplingStatisticSummariesRequest - A Consumer that will call methods on GetSamplingStatisticSummariesRequest.Builder to
create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingTargetsResponse getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSamplingTargetsResponse getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Requests a sampling quota for rules that the service is using to sample requests.
This is a convenience which creates an instance of the GetSamplingTargetsRequest.Builder avoiding the
need to create one manually via GetSamplingTargetsRequest.builder()
getSamplingTargetsRequest - A Consumer that will call methods on GetSamplingTargetsRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceGraphResponse getServiceGraph(GetServiceGraphRequest getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getServiceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceGraphResponse getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest - A Consumer that will call methods on GetServiceGraphRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceGraphIterable getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation.
getServiceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceGraphIterable getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetServiceGraphIterable responses = client.getServiceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest - A Consumer that will call methods on GetServiceGraphRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTimeSeriesServiceStatisticsResponse getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTimeSeriesServiceStatisticsResponse getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Get an aggregation of service statistics defined by a specific time range.
This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()
getTimeSeriesServiceStatisticsRequest - A Consumer that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder to
create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTimeSeriesServiceStatisticsIterable getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Get an aggregation of service statistics defined by a specific time range.
This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client
.getTimeSeriesServiceStatisticsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.
getTimeSeriesServiceStatisticsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTimeSeriesServiceStatisticsIterable getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Get an aggregation of service statistics defined by a specific time range.
This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client
.getTimeSeriesServiceStatisticsPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsIterable responses = client.getTimeSeriesServiceStatisticsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.
This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()
getTimeSeriesServiceStatisticsRequest - A Consumer that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder to
create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceGraphResponse getTraceGraph(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceGraphResponse getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest - A Consumer that will call methods on GetTraceGraphRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceGraphIterable getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation.
getTraceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceGraphIterable getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceGraphIterable responses = client.getTraceGraphPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest - A Consumer that will call methods on GetTraceGraphRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceSummariesResponse getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
getTraceSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceSummariesResponse getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest - A Consumer that will call methods on GetTraceSummariesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceSummariesIterable getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client
.getTraceSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation.
getTraceSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTraceSummariesIterable getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client
.getTraceSummariesPaginator(request);
for (software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesIterable responses = client.getTraceSummariesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest - A Consumer that will call methods on GetTraceSummariesRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcePoliciesResponse listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Returns the list of resource policies in the target Amazon Web Services account.
listResourcePoliciesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcePoliciesResponse listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Returns the list of resource policies in the target Amazon Web Services account.
This is a convenience which creates an instance of the ListResourcePoliciesRequest.Builder avoiding the
need to create one manually via ListResourcePoliciesRequest.builder()
listResourcePoliciesRequest - A Consumer that will call methods on ListResourcePoliciesRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcePoliciesIterable listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Returns the list of resource policies in the target Amazon Web Services account.
This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client
.listResourcePoliciesPaginator(request);
for (software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.
listResourcePoliciesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcePoliciesIterable listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Returns the list of resource policies in the target Amazon Web Services account.
This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client
.listResourcePoliciesPaginator(request);
for (software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesIterable responses = client.listResourcePoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the ListResourcePoliciesRequest.Builder avoiding the
need to create one manually via ListResourcePoliciesRequest.builder()
listResourcePoliciesRequest - A Consumer that will call methods on ListResourcePoliciesRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.xray.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEncryptionConfigResponse putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates the encryption configuration for X-Ray data.
putEncryptionConfigRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEncryptionConfigResponse putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates the encryption configuration for X-Ray data.
This is a convenience which creates an instance of the PutEncryptionConfigRequest.Builder avoiding the
need to create one manually via PutEncryptionConfigRequest.builder()
putEncryptionConfigRequest - A Consumer that will call methods on PutEncryptionConfigRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws MalformedPolicyDocumentException, LockoutPreventionException, InvalidPolicyRevisionIdException, PolicySizeLimitExceededException, PolicyCountLimitExceededException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
putResourcePolicyRequest - MalformedPolicyDocumentException - Invalid policy document provided in request.LockoutPreventionException - The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in
the future.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.PolicySizeLimitExceededException - Exceeded the maximum size for a resource policy.PolicyCountLimitExceededException - Exceeded the maximum number of resource policies for a target Amazon Web Services account.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws MalformedPolicyDocumentException, LockoutPreventionException, InvalidPolicyRevisionIdException, PolicySizeLimitExceededException, PolicyCountLimitExceededException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need
to create one manually via PutResourcePolicyRequest.builder()
putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.MalformedPolicyDocumentException - Invalid policy document provided in request.LockoutPreventionException - The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in
the future.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.PolicySizeLimitExceededException - Exceeded the maximum size for a resource policy.PolicyCountLimitExceededException - Exceeded the maximum number of resource policies for a target Amazon Web Services account.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTelemetryRecordsResponse putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTelemetryRecordsResponse putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
This is a convenience which creates an instance of the PutTelemetryRecordsRequest.Builder avoiding the
need to create one manually via PutTelemetryRecordsRequest.builder()
putTelemetryRecordsRequest - A Consumer that will call methods on PutTelemetryRecordsRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTraceSegmentsResponse putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
putTraceSegmentsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTraceSegmentsResponse putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
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.
This is a convenience which creates an instance of the PutTraceSegmentsRequest.Builder avoiding the need
to create one manually via PutTraceSegmentsRequest.builder()
putTraceSegmentsRequest - A Consumer that will call methods on PutTraceSegmentsRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, XRayException
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, XRayException
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
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).
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, ThrottledException, ResourceNotFoundException, AwsServiceException, SdkClientException, XRayException
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).
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates a group resource.
updateGroupRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Updates a group resource.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSamplingRuleResponse updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Modifies a sampling rule's configuration.
updateSamplingRuleRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSamplingRuleResponse updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest) throws InvalidRequestException, ThrottledException, AwsServiceException, SdkClientException, XRayException
Modifies a sampling rule's configuration.
This is a convenience which creates an instance of the UpdateSamplingRuleRequest.Builder avoiding the
need to create one manually via UpdateSamplingRuleRequest.builder()
updateSamplingRuleRequest - A Consumer that will call methods on UpdateSamplingRuleRequest.Builder to create a
request.InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.XRayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic XRayClient create()
XRayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static XRayClientBuilder builder()
XRayClient.static ServiceMetadata serviceMetadata()
default XRayServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.