# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [BatchGetTraces](API_BatchGetTraces.md) 
+  [CancelTraceRetrieval](API_CancelTraceRetrieval.md) 
+  [CreateGroup](API_CreateGroup.md) 
+  [CreateSamplingRule](API_CreateSamplingRule.md) 
+  [DeleteGroup](API_DeleteGroup.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteSamplingRule](API_DeleteSamplingRule.md) 
+  [GetEncryptionConfig](API_GetEncryptionConfig.md) 
+  [GetGroup](API_GetGroup.md) 
+  [GetGroups](API_GetGroups.md) 
+  [GetIndexingRules](API_GetIndexingRules.md) 
+  [GetInsight](API_GetInsight.md) 
+  [GetInsightEvents](API_GetInsightEvents.md) 
+  [GetInsightImpactGraph](API_GetInsightImpactGraph.md) 
+  [GetInsightSummaries](API_GetInsightSummaries.md) 
+  [GetRetrievedTracesGraph](API_GetRetrievedTracesGraph.md) 
+  [GetSamplingRules](API_GetSamplingRules.md) 
+  [GetSamplingStatisticSummaries](API_GetSamplingStatisticSummaries.md) 
+  [GetSamplingTargets](API_GetSamplingTargets.md) 
+  [GetServiceGraph](API_GetServiceGraph.md) 
+  [GetTimeSeriesServiceStatistics](API_GetTimeSeriesServiceStatistics.md) 
+  [GetTraceGraph](API_GetTraceGraph.md) 
+  [GetTraceSegmentDestination](API_GetTraceSegmentDestination.md) 
+  [GetTraceSummaries](API_GetTraceSummaries.md) 
+  [ListResourcePolicies](API_ListResourcePolicies.md) 
+  [ListRetrievedTraces](API_ListRetrievedTraces.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutEncryptionConfig](API_PutEncryptionConfig.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [PutTelemetryRecords](API_PutTelemetryRecords.md) 
+  [PutTraceSegments](API_PutTraceSegments.md) 
+  [StartTraceRetrieval](API_StartTraceRetrieval.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateGroup](API_UpdateGroup.md) 
+  [UpdateIndexingRule](API_UpdateIndexingRule.md) 
+  [UpdateSamplingRule](API_UpdateSamplingRule.md) 
+  [UpdateTraceSegmentDestination](API_UpdateTraceSegmentDestination.md) 

# BatchGetTraces
<a name="API_BatchGetTraces"></a>

**Note**  
You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.

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.

## Request Syntax
<a name="API_BatchGetTraces_RequestSyntax"></a>

```
POST /Traces HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "TraceIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_BatchGetTraces_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchGetTraces_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_BatchGetTraces_RequestSyntax) **   <a name="xray-BatchGetTraces-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

 ** [TraceIds](#API_BatchGetTraces_RequestSyntax) **   <a name="xray-BatchGetTraces-request-TraceIds"></a>
Specify the trace IDs of requests for which to retrieve segments.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Required: Yes

## Response Syntax
<a name="API_BatchGetTraces_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Traces": [ 
      { 
         "Duration": number,
         "Id": "string",
         "LimitExceeded": boolean,
         "Segments": [ 
            { 
               "Document": "string",
               "Id": "string"
            }
         ]
      }
   ],
   "UnprocessedTraceIds": [ "string" ]
}
```

## Response Elements
<a name="API_BatchGetTraces_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_BatchGetTraces_ResponseSyntax) **   <a name="xray-BatchGetTraces-response-NextToken"></a>
Pagination token.  
Type: String

 ** [Traces](#API_BatchGetTraces_ResponseSyntax) **   <a name="xray-BatchGetTraces-response-Traces"></a>
Full traces for the specified requests.  
Type: Array of [Trace](API_Trace.md) objects

 ** [UnprocessedTraceIds](#API_BatchGetTraces_ResponseSyntax) **   <a name="xray-BatchGetTraces-response-UnprocessedTraceIds"></a>
Trace IDs of requests that haven't been processed.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 35.

## Errors
<a name="API_BatchGetTraces_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_BatchGetTraces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/BatchGetTraces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/BatchGetTraces) 

# CancelTraceRetrieval
<a name="API_CancelTraceRetrieval"></a>

 Cancels an ongoing trace retrieval job initiated by `StartTraceRetrieval` using the provided `RetrievalToken`. A successful cancellation will return an HTTP 200 response. 

## Request Syntax
<a name="API_CancelTraceRetrieval_RequestSyntax"></a>

```
POST /CancelTraceRetrieval HTTP/1.1
Content-type: application/json

{
   "RetrievalToken": "string"
}
```

## URI Request Parameters
<a name="API_CancelTraceRetrieval_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CancelTraceRetrieval_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RetrievalToken](#API_CancelTraceRetrieval_RequestSyntax) **   <a name="xray-CancelTraceRetrieval-request-RetrievalToken"></a>
 Retrieval token.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1020.  
Required: Yes

## Response Syntax
<a name="API_CancelTraceRetrieval_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelTraceRetrieval_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelTraceRetrieval_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_CancelTraceRetrieval_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/CancelTraceRetrieval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/CancelTraceRetrieval) 

# CreateGroup
<a name="API_CreateGroup"></a>

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

## Request Syntax
<a name="API_CreateGroup_RequestSyntax"></a>

```
POST /CreateGroup HTTP/1.1
Content-type: application/json

{
   "FilterExpression": "string",
   "GroupName": "string",
   "InsightsConfiguration": { 
      "InsightsEnabled": boolean,
      "NotificationsEnabled": boolean
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FilterExpression](#API_CreateGroup_RequestSyntax) **   <a name="xray-CreateGroup-request-FilterExpression"></a>
The filter expression defining criteria by which to group traces.  
Type: String  
Required: No

 ** [GroupName](#API_CreateGroup_RequestSyntax) **   <a name="xray-CreateGroup-request-GroupName"></a>
The case-sensitive name of the new group. Default is a reserved name and names must be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: Yes

 ** [InsightsConfiguration](#API_CreateGroup_RequestSyntax) **   <a name="xray-CreateGroup-request-InsightsConfiguration"></a>
The structure containing configurations related to insights.  
+ The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
+ The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
Type: [InsightsConfiguration](API_InsightsConfiguration.md) object  
Required: No

 ** [Tags](#API_CreateGroup_RequestSyntax) **   <a name="xray-CreateGroup-request-Tags"></a>
A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference*.  
The following restrictions apply to tags:  
+ Maximum number of user-applied tags per resource: 50
+ Maximum tag key length: 128 Unicode characters
+ Maximum tag value length: 256 Unicode characters
+ Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: \$1 . : / = \$1 - and @
+ Tag keys and values are case sensitive.
+ Don't use `aws:` as a prefix for keys; it's reserved for AWS use.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Group": { 
      "FilterExpression": "string",
      "GroupARN": "string",
      "GroupName": "string",
      "InsightsConfiguration": { 
         "InsightsEnabled": boolean,
         "NotificationsEnabled": boolean
      }
   }
}
```

## Response Elements
<a name="API_CreateGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Group](#API_CreateGroup_ResponseSyntax) **   <a name="xray-CreateGroup-response-Group"></a>
The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.  
Type: [Group](API_Group.md) object

## Errors
<a name="API_CreateGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_CreateGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/CreateGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/CreateGroup) 

# CreateSamplingRule
<a name="API_CreateSamplingRule"></a>

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with [GetSamplingRules](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html), 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](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) 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.

## Request Syntax
<a name="API_CreateSamplingRule_RequestSyntax"></a>

```
POST /CreateSamplingRule HTTP/1.1
Content-type: application/json

{
   "SamplingRule": { 
      "Attributes": { 
         "string" : "string" 
      },
      "FixedRate": number,
      "Host": "string",
      "HTTPMethod": "string",
      "Priority": number,
      "ReservoirSize": number,
      "ResourceARN": "string",
      "RuleARN": "string",
      "RuleName": "string",
      "SamplingRateBoost": { 
         "CooldownWindowMinutes": number,
         "MaxRate": number
      },
      "ServiceName": "string",
      "ServiceType": "string",
      "URLPath": "string",
      "Version": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateSamplingRule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateSamplingRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SamplingRule](#API_CreateSamplingRule_RequestSyntax) **   <a name="xray-CreateSamplingRule-request-SamplingRule"></a>
The rule definition.  
Type: [SamplingRule](API_SamplingRule.md) object  
Required: Yes

 ** [Tags](#API_CreateSamplingRule_RequestSyntax) **   <a name="xray-CreateSamplingRule-request-Tags"></a>
A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference*.  
The following restrictions apply to tags:  
+ Maximum number of user-applied tags per resource: 50
+ Maximum tag key length: 128 Unicode characters
+ Maximum tag value length: 256 Unicode characters
+ Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: \$1 . : / = \$1 - and @
+ Tag keys and values are case sensitive.
+ Don't use `aws:` as a prefix for keys; it's reserved for AWS use.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateSamplingRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SamplingRuleRecord": { 
      "CreatedAt": number,
      "ModifiedAt": number,
      "SamplingRule": { 
         "Attributes": { 
            "string" : "string" 
         },
         "FixedRate": number,
         "Host": "string",
         "HTTPMethod": "string",
         "Priority": number,
         "ReservoirSize": number,
         "ResourceARN": "string",
         "RuleARN": "string",
         "RuleName": "string",
         "SamplingRateBoost": { 
            "CooldownWindowMinutes": number,
            "MaxRate": number
         },
         "ServiceName": "string",
         "ServiceType": "string",
         "URLPath": "string",
         "Version": number
      }
   }
}
```

## Response Elements
<a name="API_CreateSamplingRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SamplingRuleRecord](#API_CreateSamplingRule_ResponseSyntax) **   <a name="xray-CreateSamplingRule-response-SamplingRuleRecord"></a>
The saved rule definition and metadata.  
Type: [SamplingRuleRecord](API_SamplingRuleRecord.md) object

## Errors
<a name="API_CreateSamplingRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** RuleLimitExceededException **   
You have reached the maximum number of sampling rules.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_CreateSamplingRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/CreateSamplingRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/CreateSamplingRule) 

# DeleteGroup
<a name="API_DeleteGroup"></a>

Deletes a group resource.

## Request Syntax
<a name="API_DeleteGroup_RequestSyntax"></a>

```
POST /DeleteGroup HTTP/1.1
Content-type: application/json

{
   "GroupARN": "string",
   "GroupName": "string"
}
```

## URI Request Parameters
<a name="API_DeleteGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [GroupARN](#API_DeleteGroup_RequestSyntax) **   <a name="xray-DeleteGroup-request-GroupARN"></a>
The ARN of the group that was generated on creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_DeleteGroup_RequestSyntax) **   <a name="xray-DeleteGroup-request-GroupName"></a>
The case-sensitive name of the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## Response Syntax
<a name="API_DeleteGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/DeleteGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/DeleteGroup) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

Deletes a resource policy from the target AWS account.

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
POST /DeleteResourcePolicy HTTP/1.1
Content-type: application/json

{
   "PolicyName": "string",
   "PolicyRevisionId": "string"
}
```

## URI Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteResourcePolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PolicyName](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="xray-DeleteResourcePolicy-request-PolicyName"></a>
The name of the resource policy to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w+=,.@-]+`   
Required: Yes

 ** [PolicyRevisionId](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="xray-DeleteResourcePolicy-request-PolicyRevisionId"></a>
Specifies a specific policy revision to delete. Provide a `PolicyRevisionId` to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an `InvalidPolicyRevisionIdException` exception is returned.   
Type: String  
Required: No

## Response Syntax
<a name="API_DeleteResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/DeleteResourcePolicy) 

# DeleteSamplingRule
<a name="API_DeleteSamplingRule"></a>

Deletes a sampling rule.

## Request Syntax
<a name="API_DeleteSamplingRule_RequestSyntax"></a>

```
POST /DeleteSamplingRule HTTP/1.1
Content-type: application/json

{
   "RuleARN": "string",
   "RuleName": "string"
}
```

## URI Request Parameters
<a name="API_DeleteSamplingRule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteSamplingRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RuleARN](#API_DeleteSamplingRule_RequestSyntax) **   <a name="xray-DeleteSamplingRule-request-RuleARN"></a>
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.  
Type: String  
Required: No

 ** [RuleName](#API_DeleteSamplingRule_RequestSyntax) **   <a name="xray-DeleteSamplingRule-request-RuleName"></a>
The name of the sampling rule. Specify a rule by either name or ARN, but not both.  
Type: String  
Required: No

## Response Syntax
<a name="API_DeleteSamplingRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SamplingRuleRecord": { 
      "CreatedAt": number,
      "ModifiedAt": number,
      "SamplingRule": { 
         "Attributes": { 
            "string" : "string" 
         },
         "FixedRate": number,
         "Host": "string",
         "HTTPMethod": "string",
         "Priority": number,
         "ReservoirSize": number,
         "ResourceARN": "string",
         "RuleARN": "string",
         "RuleName": "string",
         "SamplingRateBoost": { 
            "CooldownWindowMinutes": number,
            "MaxRate": number
         },
         "ServiceName": "string",
         "ServiceType": "string",
         "URLPath": "string",
         "Version": number
      }
   }
}
```

## Response Elements
<a name="API_DeleteSamplingRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SamplingRuleRecord](#API_DeleteSamplingRule_ResponseSyntax) **   <a name="xray-DeleteSamplingRule-response-SamplingRuleRecord"></a>
The deleted rule definition and metadata.  
Type: [SamplingRuleRecord](API_SamplingRuleRecord.md) object

## Errors
<a name="API_DeleteSamplingRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteSamplingRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/DeleteSamplingRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/DeleteSamplingRule) 

# GetEncryptionConfig
<a name="API_GetEncryptionConfig"></a>

Retrieves the current encryption configuration for X-Ray data.

## Request Syntax
<a name="API_GetEncryptionConfig_RequestSyntax"></a>

```
POST /EncryptionConfig HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEncryptionConfig_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetEncryptionConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEncryptionConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EncryptionConfig": { 
      "KeyId": "string",
      "Status": "string",
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_GetEncryptionConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EncryptionConfig](#API_GetEncryptionConfig_ResponseSyntax) **   <a name="xray-GetEncryptionConfig-response-EncryptionConfig"></a>
The encryption configuration document.  
Type: [EncryptionConfig](API_EncryptionConfig.md) object

## Errors
<a name="API_GetEncryptionConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetEncryptionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetEncryptionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetEncryptionConfig) 

# GetGroup
<a name="API_GetGroup"></a>

Retrieves group resource details.

## Request Syntax
<a name="API_GetGroup_RequestSyntax"></a>

```
POST /GetGroup HTTP/1.1
Content-type: application/json

{
   "GroupARN": "string",
   "GroupName": "string"
}
```

## URI Request Parameters
<a name="API_GetGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [GroupARN](#API_GetGroup_RequestSyntax) **   <a name="xray-GetGroup-request-GroupARN"></a>
The ARN of the group that was generated on creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_GetGroup_RequestSyntax) **   <a name="xray-GetGroup-request-GroupName"></a>
The case-sensitive name of the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## Response Syntax
<a name="API_GetGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Group": { 
      "FilterExpression": "string",
      "GroupARN": "string",
      "GroupName": "string",
      "InsightsConfiguration": { 
         "InsightsEnabled": boolean,
         "NotificationsEnabled": boolean
      }
   }
}
```

## Response Elements
<a name="API_GetGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Group](#API_GetGroup_ResponseSyntax) **   <a name="xray-GetGroup-response-Group"></a>
The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.  
Type: [Group](API_Group.md) object

## Errors
<a name="API_GetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetGroup) 

# GetGroups
<a name="API_GetGroups"></a>

Retrieves all active group details.

## Request Syntax
<a name="API_GetGroups_RequestSyntax"></a>

```
POST /Groups HTTP/1.1
Content-type: application/json

{
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetGroups_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetGroups_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetGroups_RequestSyntax) **   <a name="xray-GetGroups-request-NextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_GetGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Groups": [ 
      { 
         "FilterExpression": "string",
         "GroupARN": "string",
         "GroupName": "string",
         "InsightsConfiguration": { 
            "InsightsEnabled": boolean,
            "NotificationsEnabled": boolean
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Groups](#API_GetGroups_ResponseSyntax) **   <a name="xray-GetGroups-response-Groups"></a>
The collection of all active groups.  
Type: Array of [GroupSummary](API_GroupSummary.md) objects

 ** [NextToken](#API_GetGroups_ResponseSyntax) **   <a name="xray-GetGroups-response-NextToken"></a>
Pagination token.  
Type: String

## Errors
<a name="API_GetGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetGroups) 

# GetIndexingRules
<a name="API_GetIndexingRules"></a>

 Retrieves all indexing rules.

Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see [Transaction Search](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html).

## Request Syntax
<a name="API_GetIndexingRules_RequestSyntax"></a>

```
POST /GetIndexingRules HTTP/1.1
Content-type: application/json

{
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetIndexingRules_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetIndexingRules_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetIndexingRules_RequestSyntax) **   <a name="xray-GetIndexingRules-request-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String  
Required: No

## Response Syntax
<a name="API_GetIndexingRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IndexingRules": [ 
      { 
         "ModifiedAt": number,
         "Name": "string",
         "Rule": { ... }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetIndexingRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IndexingRules](#API_GetIndexingRules_ResponseSyntax) **   <a name="xray-GetIndexingRules-response-IndexingRules"></a>
 Retrieves all indexing rules.  
Type: Array of [IndexingRule](API_IndexingRule.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.

 ** [NextToken](#API_GetIndexingRules_ResponseSyntax) **   <a name="xray-GetIndexingRules-response-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String

## Errors
<a name="API_GetIndexingRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetIndexingRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetIndexingRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetIndexingRules) 

# GetInsight
<a name="API_GetInsight"></a>

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.

## Request Syntax
<a name="API_GetInsight_RequestSyntax"></a>

```
POST /Insight HTTP/1.1
Content-type: application/json

{
   "InsightId": "string"
}
```

## URI Request Parameters
<a name="API_GetInsight_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetInsight_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InsightId](#API_GetInsight_RequestSyntax) **   <a name="xray-GetInsight-request-InsightId"></a>
The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}`   
Required: Yes

## Response Syntax
<a name="API_GetInsight_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Insight": { 
      "Categories": [ "string" ],
      "ClientRequestImpactStatistics": { 
         "FaultCount": number,
         "OkCount": number,
         "TotalCount": number
      },
      "EndTime": number,
      "GroupARN": "string",
      "GroupName": "string",
      "InsightId": "string",
      "RootCauseServiceId": { 
         "AccountId": "string",
         "Name": "string",
         "Names": [ "string" ],
         "Type": "string"
      },
      "RootCauseServiceRequestImpactStatistics": { 
         "FaultCount": number,
         "OkCount": number,
         "TotalCount": number
      },
      "StartTime": number,
      "State": "string",
      "Summary": "string",
      "TopAnomalousServices": [ 
         { 
            "ServiceId": { 
               "AccountId": "string",
               "Name": "string",
               "Names": [ "string" ],
               "Type": "string"
            }
         }
      ]
   }
}
```

## Response Elements
<a name="API_GetInsight_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Insight](#API_GetInsight_ResponseSyntax) **   <a name="xray-GetInsight-response-Insight"></a>
The summary information of an insight.  
Type: [Insight](API_Insight.md) object

## Errors
<a name="API_GetInsight_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetInsight_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetInsight) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetInsight) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetInsight) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetInsight) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetInsight) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetInsight) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetInsight) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetInsight) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetInsight) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetInsight) 

# GetInsightEvents
<a name="API_GetInsightEvents"></a>

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.

## Request Syntax
<a name="API_GetInsightEvents_RequestSyntax"></a>

```
POST /InsightEvents HTTP/1.1
Content-type: application/json

{
   "InsightId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetInsightEvents_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetInsightEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InsightId](#API_GetInsightEvents_RequestSyntax) **   <a name="xray-GetInsightEvents-request-InsightId"></a>
The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [MaxResults](#API_GetInsightEvents_RequestSyntax) **   <a name="xray-GetInsightEvents-request-MaxResults"></a>
Used to retrieve at most the specified value of events.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_GetInsightEvents_RequestSyntax) **   <a name="xray-GetInsightEvents-request-NextToken"></a>
Specify the pagination token returned by a previous request to retrieve the next page of events.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_GetInsightEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InsightEvents": [ 
      { 
         "ClientRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "EventTime": number,
         "RootCauseServiceRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "Summary": "string",
         "TopAnomalousServices": [ 
            { 
               "ServiceId": { 
                  "AccountId": "string",
                  "Name": "string",
                  "Names": [ "string" ],
                  "Type": "string"
               }
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetInsightEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InsightEvents](#API_GetInsightEvents_ResponseSyntax) **   <a name="xray-GetInsightEvents-response-InsightEvents"></a>
A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.  
Type: Array of [InsightEvent](API_InsightEvent.md) objects

 ** [NextToken](#API_GetInsightEvents_ResponseSyntax) **   <a name="xray-GetInsightEvents-response-NextToken"></a>
Use this token to retrieve the next page of insight events.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_GetInsightEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetInsightEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetInsightEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetInsightEvents) 

# GetInsightImpactGraph
<a name="API_GetInsightImpactGraph"></a>

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.

## Request Syntax
<a name="API_GetInsightImpactGraph_RequestSyntax"></a>

```
POST /InsightImpactGraph HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "InsightId": "string",
   "NextToken": "string",
   "StartTime": number
}
```

## URI Request Parameters
<a name="API_GetInsightImpactGraph_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetInsightImpactGraph_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetInsightImpactGraph_RequestSyntax) **   <a name="xray-GetInsightImpactGraph-request-EndTime"></a>
The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours.   
Type: Timestamp  
Required: Yes

 ** [InsightId](#API_GetInsightImpactGraph_RequestSyntax) **   <a name="xray-GetInsightImpactGraph-request-InsightId"></a>
The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [NextToken](#API_GetInsightImpactGraph_RequestSyntax) **   <a name="xray-GetInsightImpactGraph-request-NextToken"></a>
Specify the pagination token returned by a previous request to retrieve the next page of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [StartTime](#API_GetInsightImpactGraph_RequestSyntax) **   <a name="xray-GetInsightImpactGraph-request-StartTime"></a>
The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.  
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_GetInsightImpactGraph_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EndTime": number,
   "InsightId": "string",
   "NextToken": "string",
   "ServiceGraphEndTime": number,
   "ServiceGraphStartTime": number,
   "Services": [ 
      { 
         "AccountId": "string",
         "Edges": [ 
            { 
               "ReferenceId": number
            }
         ],
         "Name": "string",
         "Names": [ "string" ],
         "ReferenceId": number,
         "Type": "string"
      }
   ],
   "StartTime": number
}
```

## Response Elements
<a name="API_GetInsightImpactGraph_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EndTime](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-EndTime"></a>
The provided end time.   
Type: Timestamp

 ** [InsightId](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-InsightId"></a>
The insight's unique identifier.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}` 

 ** [NextToken](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-NextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [ServiceGraphEndTime](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-ServiceGraphEndTime"></a>
The time, in Unix seconds, at which the service graph ended.  
Type: Timestamp

 ** [ServiceGraphStartTime](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-ServiceGraphStartTime"></a>
The time, in Unix seconds, at which the service graph started.  
Type: Timestamp

 ** [Services](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-Services"></a>
The AWS instrumented services related to the insight.  
Type: Array of [InsightImpactGraphService](API_InsightImpactGraphService.md) objects

 ** [StartTime](#API_GetInsightImpactGraph_ResponseSyntax) **   <a name="xray-GetInsightImpactGraph-response-StartTime"></a>
The provided start time.  
Type: Timestamp

## Errors
<a name="API_GetInsightImpactGraph_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetInsightImpactGraph_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetInsightImpactGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetInsightImpactGraph) 

# GetInsightSummaries
<a name="API_GetInsightSummaries"></a>

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

## Request Syntax
<a name="API_GetInsightSummaries_RequestSyntax"></a>

```
POST /InsightSummaries HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "GroupARN": "string",
   "GroupName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "StartTime": number,
   "States": [ "string" ]
}
```

## URI Request Parameters
<a name="API_GetInsightSummaries_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetInsightSummaries_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-EndTime"></a>
The end of the time frame in which the insights ended. The end time can't be more than 30 days old.  
Type: Timestamp  
Required: Yes

 ** [GroupARN](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-GroupARN"></a>
The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-GroupName"></a>
The name of the group. Required if the GroupARN isn't provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** [MaxResults](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-MaxResults"></a>
The maximum number of results to display.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-NextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [StartTime](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-StartTime"></a>
The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.  
Type: Timestamp  
Required: Yes

 ** [States](#API_GetInsightSummaries_RequestSyntax) **   <a name="xray-GetInsightSummaries-request-States"></a>
The list of insight states.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Valid Values: `ACTIVE | CLOSED`   
Required: No

## Response Syntax
<a name="API_GetInsightSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InsightSummaries": [ 
      { 
         "Categories": [ "string" ],
         "ClientRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "EndTime": number,
         "GroupARN": "string",
         "GroupName": "string",
         "InsightId": "string",
         "LastUpdateTime": number,
         "RootCauseServiceId": { 
            "AccountId": "string",
            "Name": "string",
            "Names": [ "string" ],
            "Type": "string"
         },
         "RootCauseServiceRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "StartTime": number,
         "State": "string",
         "Summary": "string",
         "TopAnomalousServices": [ 
            { 
               "ServiceId": { 
                  "AccountId": "string",
                  "Name": "string",
                  "Names": [ "string" ],
                  "Type": "string"
               }
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetInsightSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InsightSummaries](#API_GetInsightSummaries_ResponseSyntax) **   <a name="xray-GetInsightSummaries-response-InsightSummaries"></a>
The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.  
Type: Array of [InsightSummary](API_InsightSummary.md) objects

 ** [NextToken](#API_GetInsightSummaries_ResponseSyntax) **   <a name="xray-GetInsightSummaries-response-NextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_GetInsightSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetInsightSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetInsightSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetInsightSummaries) 

# GetRetrievedTracesGraph
<a name="API_GetRetrievedTracesGraph"></a>

 Retrieves a service graph for traces based on the specified `RetrievalToken` from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute `StartTraceRetrieval` to obtain the required `RetrievalToken`. 

The trace graph describes services that process incoming requests and any downstream services they call, which may include AWS resources, external APIs, or databases.

The response is empty until the `RetrievalStatus` is *COMPLETE*. Retry the request after the status changes from *RUNNING* or *SCHEDULED* to *COMPLETE* to access the full service graph.

 When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see [GetTraceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html).

## Request Syntax
<a name="API_GetRetrievedTracesGraph_RequestSyntax"></a>

```
POST /GetRetrievedTracesGraph HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalToken": "string"
}
```

## URI Request Parameters
<a name="API_GetRetrievedTracesGraph_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetRetrievedTracesGraph_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetRetrievedTracesGraph_RequestSyntax) **   <a name="xray-GetRetrievedTracesGraph-request-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String  
Required: No

 ** [RetrievalToken](#API_GetRetrievedTracesGraph_RequestSyntax) **   <a name="xray-GetRetrievedTracesGraph-request-RetrievalToken"></a>
 Retrieval token.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1020.  
Required: Yes

## Response Syntax
<a name="API_GetRetrievedTracesGraph_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalStatus": "string",
   "Services": [ 
      { 
         "Links": [ 
            { 
               "DestinationTraceIds": [ "string" ],
               "ReferenceType": "string",
               "SourceTraceId": "string"
            }
         ],
         "Service": { 
            "AccountId": "string",
            "DurationHistogram": [ 
               { 
                  "Count": number,
                  "Value": number
               }
            ],
            "Edges": [ 
               { 
                  "Aliases": [ 
                     { 
                        "Name": "string",
                        "Names": [ "string" ],
                        "Type": "string"
                     }
                  ],
                  "EdgeType": "string",
                  "EndTime": number,
                  "ReceivedEventAgeHistogram": [ 
                     { 
                        "Count": number,
                        "Value": number
                     }
                  ],
                  "ReferenceId": number,
                  "ResponseTimeHistogram": [ 
                     { 
                        "Count": number,
                        "Value": number
                     }
                  ],
                  "StartTime": number,
                  "SummaryStatistics": { 
                     "ErrorStatistics": { 
                        "OtherCount": number,
                        "ThrottleCount": number,
                        "TotalCount": number
                     },
                     "FaultStatistics": { 
                        "OtherCount": number,
                        "TotalCount": number
                     },
                     "OkCount": number,
                     "TotalCount": number,
                     "TotalResponseTime": number
                  }
               }
            ],
            "EndTime": number,
            "Name": "string",
            "Names": [ "string" ],
            "ReferenceId": number,
            "ResponseTimeHistogram": [ 
               { 
                  "Count": number,
                  "Value": number
               }
            ],
            "Root": boolean,
            "StartTime": number,
            "State": "string",
            "SummaryStatistics": { 
               "ErrorStatistics": { 
                  "OtherCount": number,
                  "ThrottleCount": number,
                  "TotalCount": number
               },
               "FaultStatistics": { 
                  "OtherCount": number,
                  "TotalCount": number
               },
               "OkCount": number,
               "TotalCount": number,
               "TotalResponseTime": number
            },
            "Type": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_GetRetrievedTracesGraph_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetRetrievedTracesGraph_ResponseSyntax) **   <a name="xray-GetRetrievedTracesGraph-response-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String

 ** [RetrievalStatus](#API_GetRetrievedTracesGraph_ResponseSyntax) **   <a name="xray-GetRetrievedTracesGraph-response-RetrievalStatus"></a>
 Status of the retrieval.   
Type: String  
Valid Values: `SCHEDULED | RUNNING | COMPLETE | FAILED | CANCELLED | TIMEOUT` 

 ** [Services](#API_GetRetrievedTracesGraph_ResponseSyntax) **   <a name="xray-GetRetrievedTracesGraph-response-Services"></a>
 Retrieved services.   
Type: Array of [RetrievedService](API_RetrievedService.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1000 items.

## Errors
<a name="API_GetRetrievedTracesGraph_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetRetrievedTracesGraph_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetRetrievedTracesGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetRetrievedTracesGraph) 

# GetSamplingRules
<a name="API_GetSamplingRules"></a>

Retrieves all sampling rules.

## Request Syntax
<a name="API_GetSamplingRules_RequestSyntax"></a>

```
POST /GetSamplingRules HTTP/1.1
Content-type: application/json

{
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetSamplingRules_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetSamplingRules_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetSamplingRules_RequestSyntax) **   <a name="xray-GetSamplingRules-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetSamplingRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SamplingRuleRecords": [ 
      { 
         "CreatedAt": number,
         "ModifiedAt": number,
         "SamplingRule": { 
            "Attributes": { 
               "string" : "string" 
            },
            "FixedRate": number,
            "Host": "string",
            "HTTPMethod": "string",
            "Priority": number,
            "ReservoirSize": number,
            "ResourceARN": "string",
            "RuleARN": "string",
            "RuleName": "string",
            "SamplingRateBoost": { 
               "CooldownWindowMinutes": number,
               "MaxRate": number
            },
            "ServiceName": "string",
            "ServiceType": "string",
            "URLPath": "string",
            "Version": number
         }
      }
   ]
}
```

## Response Elements
<a name="API_GetSamplingRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetSamplingRules_ResponseSyntax) **   <a name="xray-GetSamplingRules-response-NextToken"></a>
Pagination token.  
Type: String

 ** [SamplingRuleRecords](#API_GetSamplingRules_ResponseSyntax) **   <a name="xray-GetSamplingRules-response-SamplingRuleRecords"></a>
Rule definitions and metadata.  
Type: Array of [SamplingRuleRecord](API_SamplingRuleRecord.md) objects

## Errors
<a name="API_GetSamplingRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetSamplingRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetSamplingRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetSamplingRules) 

# GetSamplingStatisticSummaries
<a name="API_GetSamplingStatisticSummaries"></a>

Retrieves information about recent sampling results for all sampling rules.

## Request Syntax
<a name="API_GetSamplingStatisticSummaries_RequestSyntax"></a>

```
POST /SamplingStatisticSummaries HTTP/1.1
Content-type: application/json

{
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetSamplingStatisticSummaries_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetSamplingStatisticSummaries_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetSamplingStatisticSummaries_RequestSyntax) **   <a name="xray-GetSamplingStatisticSummaries-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetSamplingStatisticSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SamplingStatisticSummaries": [ 
      { 
         "BorrowCount": number,
         "RequestCount": number,
         "RuleName": "string",
         "SampledCount": number,
         "Timestamp": number
      }
   ]
}
```

## Response Elements
<a name="API_GetSamplingStatisticSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetSamplingStatisticSummaries_ResponseSyntax) **   <a name="xray-GetSamplingStatisticSummaries-response-NextToken"></a>
Pagination token.  
Type: String

 ** [SamplingStatisticSummaries](#API_GetSamplingStatisticSummaries_ResponseSyntax) **   <a name="xray-GetSamplingStatisticSummaries-response-SamplingStatisticSummaries"></a>
Information about the number of requests instrumented for each sampling rule.  
Type: Array of [SamplingStatisticSummary](API_SamplingStatisticSummary.md) objects

## Errors
<a name="API_GetSamplingStatisticSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetSamplingStatisticSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetSamplingStatisticSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetSamplingStatisticSummaries) 

# GetSamplingTargets
<a name="API_GetSamplingTargets"></a>

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

## Request Syntax
<a name="API_GetSamplingTargets_RequestSyntax"></a>

```
POST /SamplingTargets HTTP/1.1
Content-type: application/json

{
   "SamplingBoostStatisticsDocuments": [ 
      { 
         "AnomalyCount": number,
         "RuleName": "string",
         "SampledAnomalyCount": number,
         "ServiceName": "string",
         "Timestamp": number,
         "TotalCount": number
      }
   ],
   "SamplingStatisticsDocuments": [ 
      { 
         "BorrowCount": number,
         "ClientID": "string",
         "RequestCount": number,
         "RuleName": "string",
         "SampledCount": number,
         "Timestamp": number
      }
   ]
}
```

## URI Request Parameters
<a name="API_GetSamplingTargets_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetSamplingTargets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SamplingBoostStatisticsDocuments](#API_GetSamplingTargets_RequestSyntax) **   <a name="xray-GetSamplingTargets-request-SamplingBoostStatisticsDocuments"></a>
Information about rules that the service is using to boost sampling rate.  
Type: Array of [SamplingBoostStatisticsDocument](API_SamplingBoostStatisticsDocument.md) objects  
Array Members: Maximum number of 25 items.  
Required: No

 ** [SamplingStatisticsDocuments](#API_GetSamplingTargets_RequestSyntax) **   <a name="xray-GetSamplingTargets-request-SamplingStatisticsDocuments"></a>
Information about rules that the service is using to sample requests.  
Type: Array of [SamplingStatisticsDocument](API_SamplingStatisticsDocument.md) objects  
Array Members: Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_GetSamplingTargets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastRuleModification": number,
   "SamplingTargetDocuments": [ 
      { 
         "FixedRate": number,
         "Interval": number,
         "ReservoirQuota": number,
         "ReservoirQuotaTTL": number,
         "RuleName": "string",
         "SamplingBoost": { 
            "BoostRate": number,
            "BoostRateTTL": number
         }
      }
   ],
   "UnprocessedBoostStatistics": [ 
      { 
         "ErrorCode": "string",
         "Message": "string",
         "RuleName": "string"
      }
   ],
   "UnprocessedStatistics": [ 
      { 
         "ErrorCode": "string",
         "Message": "string",
         "RuleName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetSamplingTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastRuleModification](#API_GetSamplingTargets_ResponseSyntax) **   <a name="xray-GetSamplingTargets-response-LastRuleModification"></a>
The last time a user changed the sampling rule configuration, in Unix time seconds. If the sampling rule configuration changed since the service last retrieved it, the service should call [GetSamplingRules](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html) to get the latest version.  
Type: Timestamp

 ** [SamplingTargetDocuments](#API_GetSamplingTargets_ResponseSyntax) **   <a name="xray-GetSamplingTargets-response-SamplingTargetDocuments"></a>
Updated rules that the service should use to sample requests.  
Type: Array of [SamplingTargetDocument](API_SamplingTargetDocument.md) objects

 ** [UnprocessedBoostStatistics](#API_GetSamplingTargets_ResponseSyntax) **   <a name="xray-GetSamplingTargets-response-UnprocessedBoostStatistics"></a>
Information about [SamplingBoostStatisticsDocument](https://docs.aws.amazon.com/xray/latest/api/API_SamplingBoostStatisticsDocument.html) that X-Ray could not process.  
Type: Array of [UnprocessedStatistics](API_UnprocessedStatistics.md) objects

 ** [UnprocessedStatistics](#API_GetSamplingTargets_ResponseSyntax) **   <a name="xray-GetSamplingTargets-response-UnprocessedStatistics"></a>
Information about [SamplingStatisticsDocument](https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html) that X-Ray could not process.  
Type: Array of [UnprocessedStatistics](API_UnprocessedStatistics.md) objects

## Errors
<a name="API_GetSamplingTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetSamplingTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetSamplingTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetSamplingTargets) 

# GetServiceGraph
<a name="API_GetServiceGraph"></a>

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the [AWS X-Ray SDK](https://docs.aws.amazon.com/xray/index.html). Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

## Request Syntax
<a name="API_GetServiceGraph_RequestSyntax"></a>

```
POST /ServiceGraph HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "GroupARN": "string",
   "GroupName": "string",
   "NextToken": "string",
   "StartTime": number
}
```

## URI Request Parameters
<a name="API_GetServiceGraph_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetServiceGraph_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetServiceGraph_RequestSyntax) **   <a name="xray-GetServiceGraph-request-EndTime"></a>
The end of the timeframe for which to generate a graph, in Unix time seconds.  
Type: Timestamp  
Required: Yes

 ** [GroupARN](#API_GetServiceGraph_RequestSyntax) **   <a name="xray-GetServiceGraph-request-GroupARN"></a>
The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_GetServiceGraph_RequestSyntax) **   <a name="xray-GetServiceGraph-request-GroupName"></a>
The name of a group based on which you want to generate a graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** [NextToken](#API_GetServiceGraph_RequestSyntax) **   <a name="xray-GetServiceGraph-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

 ** [StartTime](#API_GetServiceGraph_RequestSyntax) **   <a name="xray-GetServiceGraph-request-StartTime"></a>
The start of the time frame for which to generate a graph, in Unix time seconds.  
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_GetServiceGraph_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContainsOldGroupVersions": boolean,
   "EndTime": number,
   "NextToken": "string",
   "Services": [ 
      { 
         "AccountId": "string",
         "DurationHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "Edges": [ 
            { 
               "Aliases": [ 
                  { 
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ],
               "EdgeType": "string",
               "EndTime": number,
               "ReceivedEventAgeHistogram": [ 
                  { 
                     "Count": number,
                     "Value": number
                  }
               ],
               "ReferenceId": number,
               "ResponseTimeHistogram": [ 
                  { 
                     "Count": number,
                     "Value": number
                  }
               ],
               "StartTime": number,
               "SummaryStatistics": { 
                  "ErrorStatistics": { 
                     "OtherCount": number,
                     "ThrottleCount": number,
                     "TotalCount": number
                  },
                  "FaultStatistics": { 
                     "OtherCount": number,
                     "TotalCount": number
                  },
                  "OkCount": number,
                  "TotalCount": number,
                  "TotalResponseTime": number
               }
            }
         ],
         "EndTime": number,
         "Name": "string",
         "Names": [ "string" ],
         "ReferenceId": number,
         "ResponseTimeHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "Root": boolean,
         "StartTime": number,
         "State": "string",
         "SummaryStatistics": { 
            "ErrorStatistics": { 
               "OtherCount": number,
               "ThrottleCount": number,
               "TotalCount": number
            },
            "FaultStatistics": { 
               "OtherCount": number,
               "TotalCount": number
            },
            "OkCount": number,
            "TotalCount": number,
            "TotalResponseTime": number
         },
         "Type": "string"
      }
   ],
   "StartTime": number
}
```

## Response Elements
<a name="API_GetServiceGraph_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContainsOldGroupVersions](#API_GetServiceGraph_ResponseSyntax) **   <a name="xray-GetServiceGraph-response-ContainsOldGroupVersions"></a>
A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.  
Type: Boolean

 ** [EndTime](#API_GetServiceGraph_ResponseSyntax) **   <a name="xray-GetServiceGraph-response-EndTime"></a>
The end of the time frame for which the graph was generated, in Unix time seconds.  
Type: Timestamp

 ** [NextToken](#API_GetServiceGraph_ResponseSyntax) **   <a name="xray-GetServiceGraph-response-NextToken"></a>
Pagination token.  
Type: String

 ** [Services](#API_GetServiceGraph_ResponseSyntax) **   <a name="xray-GetServiceGraph-response-Services"></a>
The services that have processed a traced request during the specified time frame.  
Type: Array of [Service](API_Service.md) objects

 ** [StartTime](#API_GetServiceGraph_ResponseSyntax) **   <a name="xray-GetServiceGraph-response-StartTime"></a>
The start of the time frame for which the graph was generated, in Unix time seconds.  
Type: Timestamp

## Errors
<a name="API_GetServiceGraph_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetServiceGraph_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetServiceGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetServiceGraph) 

# GetTimeSeriesServiceStatistics
<a name="API_GetTimeSeriesServiceStatistics"></a>

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

## Request Syntax
<a name="API_GetTimeSeriesServiceStatistics_RequestSyntax"></a>

```
POST /TimeSeriesServiceStatistics HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "EntitySelectorExpression": "string",
   "ForecastStatistics": boolean,
   "GroupARN": "string",
   "GroupName": "string",
   "NextToken": "string",
   "Period": number,
   "StartTime": number
}
```

## URI Request Parameters
<a name="API_GetTimeSeriesServiceStatistics_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetTimeSeriesServiceStatistics_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-EndTime"></a>
The end of the time frame for which to aggregate statistics.  
Type: Timestamp  
Required: Yes

 ** [EntitySelectorExpression](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-EntitySelectorExpression"></a>
A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

 ** [ForecastStatistics](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-ForecastStatistics"></a>
The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.  
Type: Boolean  
Required: No

 ** [GroupARN](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-GroupARN"></a>
The Amazon Resource Name (ARN) of the group for which to pull statistics from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-GroupName"></a>
The case-sensitive name of the group for which to pull statistics from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** [NextToken](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

 ** [Period](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-Period"></a>
Aggregation period in seconds.  
Type: Integer  
Required: No

 ** [StartTime](#API_GetTimeSeriesServiceStatistics_RequestSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-request-StartTime"></a>
The start of the time frame for which to aggregate statistics.  
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_GetTimeSeriesServiceStatistics_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContainsOldGroupVersions": boolean,
   "NextToken": "string",
   "TimeSeriesServiceStatistics": [ 
      { 
         "EdgeSummaryStatistics": { 
            "ErrorStatistics": { 
               "OtherCount": number,
               "ThrottleCount": number,
               "TotalCount": number
            },
            "FaultStatistics": { 
               "OtherCount": number,
               "TotalCount": number
            },
            "OkCount": number,
            "TotalCount": number,
            "TotalResponseTime": number
         },
         "ResponseTimeHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "ServiceForecastStatistics": { 
            "FaultCountHigh": number,
            "FaultCountLow": number
         },
         "ServiceSummaryStatistics": { 
            "ErrorStatistics": { 
               "OtherCount": number,
               "ThrottleCount": number,
               "TotalCount": number
            },
            "FaultStatistics": { 
               "OtherCount": number,
               "TotalCount": number
            },
            "OkCount": number,
            "TotalCount": number,
            "TotalResponseTime": number
         },
         "Timestamp": number
      }
   ]
}
```

## Response Elements
<a name="API_GetTimeSeriesServiceStatistics_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContainsOldGroupVersions](#API_GetTimeSeriesServiceStatistics_ResponseSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-response-ContainsOldGroupVersions"></a>
A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.  
Type: Boolean

 ** [NextToken](#API_GetTimeSeriesServiceStatistics_ResponseSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-response-NextToken"></a>
Pagination token.  
Type: String

 ** [TimeSeriesServiceStatistics](#API_GetTimeSeriesServiceStatistics_ResponseSyntax) **   <a name="xray-GetTimeSeriesServiceStatistics-response-TimeSeriesServiceStatistics"></a>
The collection of statistics.  
Type: Array of [TimeSeriesServiceStatistics](API_TimeSeriesServiceStatistics.md) objects

## Errors
<a name="API_GetTimeSeriesServiceStatistics_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetTimeSeriesServiceStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetTimeSeriesServiceStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetTimeSeriesServiceStatistics) 

# GetTraceGraph
<a name="API_GetTraceGraph"></a>

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

## Request Syntax
<a name="API_GetTraceGraph_RequestSyntax"></a>

```
POST /TraceGraph HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "TraceIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_GetTraceGraph_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetTraceGraph_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_GetTraceGraph_RequestSyntax) **   <a name="xray-GetTraceGraph-request-NextToken"></a>
Pagination token.  
Type: String  
Required: No

 ** [TraceIds](#API_GetTraceGraph_RequestSyntax) **   <a name="xray-GetTraceGraph-request-TraceIds"></a>
Trace IDs of requests for which to generate a service graph.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Required: Yes

## Response Syntax
<a name="API_GetTraceGraph_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Services": [ 
      { 
         "AccountId": "string",
         "DurationHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "Edges": [ 
            { 
               "Aliases": [ 
                  { 
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ],
               "EdgeType": "string",
               "EndTime": number,
               "ReceivedEventAgeHistogram": [ 
                  { 
                     "Count": number,
                     "Value": number
                  }
               ],
               "ReferenceId": number,
               "ResponseTimeHistogram": [ 
                  { 
                     "Count": number,
                     "Value": number
                  }
               ],
               "StartTime": number,
               "SummaryStatistics": { 
                  "ErrorStatistics": { 
                     "OtherCount": number,
                     "ThrottleCount": number,
                     "TotalCount": number
                  },
                  "FaultStatistics": { 
                     "OtherCount": number,
                     "TotalCount": number
                  },
                  "OkCount": number,
                  "TotalCount": number,
                  "TotalResponseTime": number
               }
            }
         ],
         "EndTime": number,
         "Name": "string",
         "Names": [ "string" ],
         "ReferenceId": number,
         "ResponseTimeHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "Root": boolean,
         "StartTime": number,
         "State": "string",
         "SummaryStatistics": { 
            "ErrorStatistics": { 
               "OtherCount": number,
               "ThrottleCount": number,
               "TotalCount": number
            },
            "FaultStatistics": { 
               "OtherCount": number,
               "TotalCount": number
            },
            "OkCount": number,
            "TotalCount": number,
            "TotalResponseTime": number
         },
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetTraceGraph_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetTraceGraph_ResponseSyntax) **   <a name="xray-GetTraceGraph-response-NextToken"></a>
Pagination token.  
Type: String

 ** [Services](#API_GetTraceGraph_ResponseSyntax) **   <a name="xray-GetTraceGraph-response-Services"></a>
The services that have processed one of the specified requests.  
Type: Array of [Service](API_Service.md) objects

## Errors
<a name="API_GetTraceGraph_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetTraceGraph_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetTraceGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetTraceGraph) 

# GetTraceSegmentDestination
<a name="API_GetTraceSegmentDestination"></a>

 Retrieves the current destination of data sent to `PutTraceSegments` and *OpenTelemetry protocol (OTLP)* endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see [Transaction Search](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html) and [OpenTelemetry](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html). 

## Request Syntax
<a name="API_GetTraceSegmentDestination_RequestSyntax"></a>

```
POST /GetTraceSegmentDestination HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTraceSegmentDestination_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetTraceSegmentDestination_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTraceSegmentDestination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Destination": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_GetTraceSegmentDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Destination](#API_GetTraceSegmentDestination_ResponseSyntax) **   <a name="xray-GetTraceSegmentDestination-response-Destination"></a>
 Retrieves the current destination.   
Type: String  
Valid Values: `XRay | CloudWatchLogs` 

 ** [Status](#API_GetTraceSegmentDestination_ResponseSyntax) **   <a name="xray-GetTraceSegmentDestination-response-Status"></a>
 Status of the retrieval.   
Type: String  
Valid Values: `PENDING | ACTIVE` 

## Errors
<a name="API_GetTraceSegmentDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetTraceSegmentDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetTraceSegmentDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetTraceSegmentDestination) 

# GetTraceSummaries
<a name="API_GetTraceSummaries"></a>

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 [Use filter expressions](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-filters) in the * AWS X-Ray Developer Guide*.

## Request Syntax
<a name="API_GetTraceSummaries_RequestSyntax"></a>

```
POST /TraceSummaries HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "FilterExpression": "string",
   "NextToken": "string",
   "Sampling": boolean,
   "SamplingStrategy": { 
      "Name": "string",
      "Value": number
   },
   "StartTime": number,
   "TimeRangeType": "string"
}
```

## URI Request Parameters
<a name="API_GetTraceSummaries_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetTraceSummaries_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-EndTime"></a>
The end of the time frame for which to retrieve traces, in Unix time seconds.  
Type: Timestamp  
Required: Yes

 ** [FilterExpression](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-FilterExpression"></a>
Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.  
Type: String  
Required: No

 ** [NextToken](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-NextToken"></a>
Specify the pagination token returned by a previous request to retrieve the next page of results.  
Type: String  
Required: No

 ** [Sampling](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-Sampling"></a>
Set to `true` to get summaries for only a subset of available traces.  
Type: Boolean  
Required: No

 ** [SamplingStrategy](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-SamplingStrategy"></a>
A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.  
Type: [SamplingStrategy](API_SamplingStrategy.md) object  
Required: No

 ** [StartTime](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-StartTime"></a>
The start of the time frame for which to retrieve traces, in Unix time seconds.  
Type: Timestamp  
Required: Yes

 ** [TimeRangeType](#API_GetTraceSummaries_RequestSyntax) **   <a name="xray-GetTraceSummaries-request-TimeRangeType"></a>
Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).  
Type: String  
Valid Values: `TraceId | Event | Service`   
Required: No

## Response Syntax
<a name="API_GetTraceSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTime": number,
   "NextToken": "string",
   "TracesProcessedCount": number,
   "TraceSummaries": [ 
      { 
         "Annotations": { 
            "string" : [ 
               { 
                  "AnnotationValue": { 
                     "BooleanValue": boolean,
                     "NumberValue": number,
                     "StringValue": "string"
                  },
                  "ServiceIds": [ 
                     { 
                        "AccountId": "string",
                        "Name": "string",
                        "Names": [ "string" ],
                        "Type": "string"
                     }
                  ]
               }
            ]
         },
         "AvailabilityZones": [ 
            { 
               "Name": "string"
            }
         ],
         "Duration": number,
         "EntryPoint": { 
            "AccountId": "string",
            "Name": "string",
            "Names": [ "string" ],
            "Type": "string"
         },
         "ErrorRootCauses": [ 
            { 
               "ClientImpacting": boolean,
               "Services": [ 
                  { 
                     "AccountId": "string",
                     "EntityPath": [ 
                        { 
                           "Exceptions": [ 
                              { 
                                 "Message": "string",
                                 "Name": "string"
                              }
                           ],
                           "Name": "string",
                           "Remote": boolean
                        }
                     ],
                     "Inferred": boolean,
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ]
            }
         ],
         "FaultRootCauses": [ 
            { 
               "ClientImpacting": boolean,
               "Services": [ 
                  { 
                     "AccountId": "string",
                     "EntityPath": [ 
                        { 
                           "Exceptions": [ 
                              { 
                                 "Message": "string",
                                 "Name": "string"
                              }
                           ],
                           "Name": "string",
                           "Remote": boolean
                        }
                     ],
                     "Inferred": boolean,
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ]
            }
         ],
         "HasError": boolean,
         "HasFault": boolean,
         "HasThrottle": boolean,
         "Http": { 
            "ClientIp": "string",
            "HttpMethod": "string",
            "HttpStatus": number,
            "HttpURL": "string",
            "UserAgent": "string"
         },
         "Id": "string",
         "InstanceIds": [ 
            { 
               "Id": "string"
            }
         ],
         "IsPartial": boolean,
         "MatchedEventTime": number,
         "ResourceARNs": [ 
            { 
               "ARN": "string"
            }
         ],
         "ResponseTime": number,
         "ResponseTimeRootCauses": [ 
            { 
               "ClientImpacting": boolean,
               "Services": [ 
                  { 
                     "AccountId": "string",
                     "EntityPath": [ 
                        { 
                           "Coverage": number,
                           "Name": "string",
                           "Remote": boolean
                        }
                     ],
                     "Inferred": boolean,
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ]
            }
         ],
         "Revision": number,
         "ServiceIds": [ 
            { 
               "AccountId": "string",
               "Name": "string",
               "Names": [ "string" ],
               "Type": "string"
            }
         ],
         "StartTime": number,
         "Users": [ 
            { 
               "ServiceIds": [ 
                  { 
                     "AccountId": "string",
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ],
               "UserName": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_GetTraceSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTime](#API_GetTraceSummaries_ResponseSyntax) **   <a name="xray-GetTraceSummaries-response-ApproximateTime"></a>
The start time of this page of results.  
Type: Timestamp

 ** [NextToken](#API_GetTraceSummaries_ResponseSyntax) **   <a name="xray-GetTraceSummaries-response-NextToken"></a>
If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.  
Type: String

 ** [TracesProcessedCount](#API_GetTraceSummaries_ResponseSyntax) **   <a name="xray-GetTraceSummaries-response-TracesProcessedCount"></a>
The total number of traces processed, including traces that did not match the specified filter expression.  
Type: Long

 ** [TraceSummaries](#API_GetTraceSummaries_ResponseSyntax) **   <a name="xray-GetTraceSummaries-response-TraceSummaries"></a>
Trace IDs and annotations for traces that were found in the specified time frame.  
Type: Array of [TraceSummary](API_TraceSummary.md) objects

## Errors
<a name="API_GetTraceSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_GetTraceSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/GetTraceSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/GetTraceSummaries) 

# ListResourcePolicies
<a name="API_ListResourcePolicies"></a>

Returns the list of resource policies in the target AWS account.

## Request Syntax
<a name="API_ListResourcePolicies_RequestSyntax"></a>

```
POST /ListResourcePolicies HTTP/1.1
Content-type: application/json

{
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListResourcePolicies_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListResourcePolicies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_ListResourcePolicies_RequestSyntax) **   <a name="xray-ListResourcePolicies-request-NextToken"></a>
Not currently supported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_ListResourcePolicies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ResourcePolicies": [ 
      { 
         "LastUpdatedTime": number,
         "PolicyDocument": "string",
         "PolicyName": "string",
         "PolicyRevisionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResourcePolicies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListResourcePolicies_ResponseSyntax) **   <a name="xray-ListResourcePolicies-response-NextToken"></a>
Pagination token. Not currently supported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [ResourcePolicies](#API_ListResourcePolicies_ResponseSyntax) **   <a name="xray-ListResourcePolicies-response-ResourcePolicies"></a>
The list of resource policies in the target AWS account.  
Type: Array of [ResourcePolicy](API_ResourcePolicy.md) objects

## Errors
<a name="API_ListResourcePolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_ListResourcePolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/ListResourcePolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/ListResourcePolicies) 

# ListRetrievedTraces
<a name="API_ListRetrievedTraces"></a>

 Retrieves a list of traces for a given `RetrievalToken` from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html). 

This API does not initiate a retrieval process. To start a trace retrieval, use `StartTraceRetrieval`, which generates the required `RetrievalToken`.

 When the `RetrievalStatus` is not *COMPLETE*, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html).

## Request Syntax
<a name="API_ListRetrievedTraces_RequestSyntax"></a>

```
POST /ListRetrievedTraces HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalToken": "string",
   "TraceFormat": "string"
}
```

## URI Request Parameters
<a name="API_ListRetrievedTraces_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListRetrievedTraces_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String  
Required: No

 ** [RetrievalToken](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-RetrievalToken"></a>
 Retrieval token.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1020.  
Required: Yes

 ** [TraceFormat](#API_ListRetrievedTraces_RequestSyntax) **   <a name="xray-ListRetrievedTraces-request-TraceFormat"></a>
 Format of the requested traces.   
Type: String  
Valid Values: `XRAY | OTEL`   
Required: No

## Response Syntax
<a name="API_ListRetrievedTraces_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RetrievalStatus": "string",
   "TraceFormat": "string",
   "Traces": [ 
      { 
         "Duration": number,
         "Id": "string",
         "Spans": [ 
            { 
               "Document": "string",
               "Id": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_ListRetrievedTraces_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-NextToken"></a>
 Specify the pagination token returned by a previous request to retrieve the next page of indexes.   
Type: String

 ** [RetrievalStatus](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-RetrievalStatus"></a>
 Status of the retrieval.   
Type: String  
Valid Values: `SCHEDULED | RUNNING | COMPLETE | FAILED | CANCELLED | TIMEOUT` 

 ** [TraceFormat](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-TraceFormat"></a>
 Format of the requested traces.   
Type: String  
Valid Values: `XRAY | OTEL` 

 ** [Traces](#API_ListRetrievedTraces_ResponseSyntax) **   <a name="xray-ListRetrievedTraces-response-Traces"></a>
 Full traces for the specified requests.   
Type: Array of [RetrievedTrace](API_RetrievedTrace.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

## Errors
<a name="API_ListRetrievedTraces_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_ListRetrievedTraces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/ListRetrievedTraces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/ListRetrievedTraces) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
POST /ListTagsForResource HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "ResourceARN": "string"
}
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="xray-ListTagsForResource-request-NextToken"></a>
A pagination token. If multiple pages of results are returned, use the `NextToken` value returned with the current page of results as the value of this parameter to get the next page of results.  
Type: String  
Required: No

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="xray-ListTagsForResource-request-ResourceARN"></a>
The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="xray-ListTagsForResource-response-NextToken"></a>
A pagination token. If multiple pages of results are returned, use the `NextToken` value returned with the current page of results to get the next page of results.  
Type: String

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="xray-ListTagsForResource-response-Tags"></a>
A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/ListTagsForResource) 

# PutEncryptionConfig
<a name="API_PutEncryptionConfig"></a>

Updates the encryption configuration for X-Ray data.

## Request Syntax
<a name="API_PutEncryptionConfig_RequestSyntax"></a>

```
POST /PutEncryptionConfig HTTP/1.1
Content-type: application/json

{
   "KeyId": "string",
   "Type": "string"
}
```

## URI Request Parameters
<a name="API_PutEncryptionConfig_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutEncryptionConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [KeyId](#API_PutEncryptionConfig_RequestSyntax) **   <a name="xray-PutEncryptionConfig-request-KeyId"></a>
An AWS KMS key in one of the following formats:  
+  **Alias** - The name of the key. For example, `alias/MyKey`.
+  **Key ID** - The KMS key ID of the key. For example, `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. AWS X-Ray does not support asymmetric KMS keys.
+  **ARN** - The full Amazon Resource Name of the key ID or alias. For example, `arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Use this format to specify a key in a different account.
Omit this key if you set `Type` to `NONE`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 3000.  
Required: No

 ** [Type](#API_PutEncryptionConfig_RequestSyntax) **   <a name="xray-PutEncryptionConfig-request-Type"></a>
The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption.  
Type: String  
Valid Values: `NONE | KMS`   
Required: Yes

## Response Syntax
<a name="API_PutEncryptionConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EncryptionConfig": { 
      "KeyId": "string",
      "Status": "string",
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_PutEncryptionConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EncryptionConfig](#API_PutEncryptionConfig_ResponseSyntax) **   <a name="xray-PutEncryptionConfig-response-EncryptionConfig"></a>
The new encryption configuration.  
Type: [EncryptionConfig](API_EncryptionConfig.md) object

## Errors
<a name="API_PutEncryptionConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_PutEncryptionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/PutEncryptionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/PutEncryptionConfig) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

 Sets the resource policy to grant one or more AWS services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific AWS account. Each AWS 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. 

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
POST /PutResourcePolicy HTTP/1.1
Content-type: application/json

{
   "BypassPolicyLockoutCheck": boolean,
   "PolicyDocument": "string",
   "PolicyName": "string",
   "PolicyRevisionId": "string"
}
```

## URI Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutResourcePolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [BypassPolicyLockoutCheck](#API_PutResourcePolicy_RequestSyntax) **   <a name="xray-PutResourcePolicy-request-BypassPolicyLockoutCheck"></a>
A flag to indicate whether to bypass the resource policy lockout safety check.  
Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent `PutResourcePolicy` request.  
The default value is false.  
Type: Boolean  
Required: No

 ** [PolicyDocument](#API_PutResourcePolicy_RequestSyntax) **   <a name="xray-PutResourcePolicy-request-PolicyDocument"></a>
The resource policy document, which can be up to 5kb in size.  
Type: String  
Required: Yes

 ** [PolicyName](#API_PutResourcePolicy_RequestSyntax) **   <a name="xray-PutResourcePolicy-request-PolicyName"></a>
The name of the resource policy. Must be unique within a specific AWS account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w+=,.@-]+`   
Required: Yes

 ** [PolicyRevisionId](#API_PutResourcePolicy_RequestSyntax) **   <a name="xray-PutResourcePolicy-request-PolicyRevisionId"></a>
Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.  
If the policy revision id does not match the latest revision id, the operation will fail with an `InvalidPolicyRevisionIdException` exception. You can also provide a `PolicyRevisionId` of 0. In this case, the operation will fail with an `InvalidPolicyRevisionIdException` exception if a resource policy with the same name already exists.   
Type: String  
Required: No

## Response Syntax
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ResourcePolicy": { 
      "LastUpdatedTime": number,
      "PolicyDocument": "string",
      "PolicyName": "string",
      "PolicyRevisionId": "string"
   }
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourcePolicy](#API_PutResourcePolicy_ResponseSyntax) **   <a name="xray-PutResourcePolicy-response-ResourcePolicy"></a>
The resource policy document, as provided in the `PutResourcePolicyRequest`.  
Type: [ResourcePolicy](API_ResourcePolicy.md) object

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.  
HTTP Status Code: 400

 ** LockoutPreventionException **   
The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.  
HTTP Status Code: 400

 ** MalformedPolicyDocumentException **   
Invalid policy document provided in request.  
HTTP Status Code: 400

 ** PolicyCountLimitExceededException **   
Exceeded the maximum number of resource policies for a target AWS account.  
HTTP Status Code: 400

 ** PolicySizeLimitExceededException **   
Exceeded the maximum size for a resource policy.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/PutResourcePolicy) 

# PutTelemetryRecords
<a name="API_PutTelemetryRecords"></a>

Used by the AWS X-Ray daemon to upload telemetry.

## Request Syntax
<a name="API_PutTelemetryRecords_RequestSyntax"></a>

```
POST /TelemetryRecords HTTP/1.1
Content-type: application/json

{
   "EC2InstanceId": "string",
   "Hostname": "string",
   "ResourceARN": "string",
   "TelemetryRecords": [ 
      { 
         "BackendConnectionErrors": { 
            "ConnectionRefusedCount": number,
            "HTTPCode4XXCount": number,
            "HTTPCode5XXCount": number,
            "OtherCount": number,
            "TimeoutCount": number,
            "UnknownHostCount": number
         },
         "SegmentsReceivedCount": number,
         "SegmentsRejectedCount": number,
         "SegmentsSentCount": number,
         "SegmentsSpilloverCount": number,
         "Timestamp": number
      }
   ]
}
```

## URI Request Parameters
<a name="API_PutTelemetryRecords_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutTelemetryRecords_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EC2InstanceId](#API_PutTelemetryRecords_RequestSyntax) **   <a name="xray-PutTelemetryRecords-request-EC2InstanceId"></a>
  
Type: String  
Length Constraints: Maximum length of 20.  
Required: No

 ** [Hostname](#API_PutTelemetryRecords_RequestSyntax) **   <a name="xray-PutTelemetryRecords-request-Hostname"></a>
  
Type: String  
Length Constraints: Maximum length of 255.  
Required: No

 ** [ResourceARN](#API_PutTelemetryRecords_RequestSyntax) **   <a name="xray-PutTelemetryRecords-request-ResourceARN"></a>
  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [TelemetryRecords](#API_PutTelemetryRecords_RequestSyntax) **   <a name="xray-PutTelemetryRecords-request-TelemetryRecords"></a>
  
Type: Array of [TelemetryRecord](API_TelemetryRecord.md) objects  
Required: Yes

## Response Syntax
<a name="API_PutTelemetryRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutTelemetryRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutTelemetryRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_PutTelemetryRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/PutTelemetryRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/PutTelemetryRecords) 

# PutTraceSegments
<a name="API_PutTraceSegments"></a>

Uploads segment documents to AWS X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Segments must include the following fields. For the full segment document schema, see [AWS X-Ray Segment Documents](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments.html) in the * AWS X-Ray Developer Guide*.

**Required segment document fields**
+  `name` - The name of the service that handled the request.
+  `id` - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.
+  `trace_id` - A unique identifier that connects all segments and subsegments originating from a single client request.
+  `start_time` - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, `1480615200.010` or `1.480615200010E9`.
+  `end_time` - Time the segment or subsegment was closed. For example, `1480615200.090` or `1.480615200090E9`. Specify either an `end_time` or `in_progress`.
+  `in_progress` - Set to `true` instead of specifying an `end_time` to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace 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. For trace IDs created by an X-Ray SDK, or by AWS services integrated with X-Ray, a trace ID 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.

**Note**  
Trace IDs created via OpenTelemetry have a different format based on the [W3C Trace Context specification](https://www.w3.org/TR/trace-context/). A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID `4efaaf4d1e8720b39541901950019ee5` should be formatted as `1-4efaaf4d-1e8720b39541901950019ee5` when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated. 

## Request Syntax
<a name="API_PutTraceSegments_RequestSyntax"></a>

```
POST /TraceSegments HTTP/1.1
Content-type: application/json

{
   "TraceSegmentDocuments": [ "string" ]
}
```

## URI Request Parameters
<a name="API_PutTraceSegments_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutTraceSegments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [TraceSegmentDocuments](#API_PutTraceSegments_RequestSyntax) **   <a name="xray-PutTraceSegments-request-TraceSegmentDocuments"></a>
A string containing a JSON document defining one or more segments or subsegments.  
Type: Array of strings  
Required: Yes

## Response Syntax
<a name="API_PutTraceSegments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "UnprocessedTraceSegments": [ 
      { 
         "ErrorCode": "string",
         "Id": "string",
         "Message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_PutTraceSegments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [UnprocessedTraceSegments](#API_PutTraceSegments_ResponseSyntax) **   <a name="xray-PutTraceSegments-response-UnprocessedTraceSegments"></a>
Segments that failed processing.  
Type: Array of [UnprocessedTraceSegment](API_UnprocessedTraceSegment.md) objects

## Errors
<a name="API_PutTraceSegments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_PutTraceSegments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/PutTraceSegments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/PutTraceSegments) 

# StartTraceRetrieval
<a name="API_StartTraceRetrieval"></a>

 Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see [Transaction Search](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html). 

API returns a `RetrievalToken`, which can be used with `ListRetrievedTraces` or `GetRetrievedTracesGraph` to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

If you are using [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html), you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html).

## Request Syntax
<a name="API_StartTraceRetrieval_RequestSyntax"></a>

```
POST /StartTraceRetrieval HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "StartTime": number,
   "TraceIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_StartTraceRetrieval_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartTraceRetrieval_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_StartTraceRetrieval_RequestSyntax) **   <a name="xray-StartTraceRetrieval-request-EndTime"></a>
 The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.  
Type: Timestamp  
Required: Yes

 ** [StartTime](#API_StartTraceRetrieval_RequestSyntax) **   <a name="xray-StartTraceRetrieval-request-StartTime"></a>
 The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.   
Type: Timestamp  
Required: Yes

 ** [TraceIds](#API_StartTraceRetrieval_RequestSyntax) **   <a name="xray-StartTraceRetrieval-request-TraceIds"></a>
 Specify the trace IDs of the traces to be retrieved.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Required: Yes

## Response Syntax
<a name="API_StartTraceRetrieval_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RetrievalToken": "string"
}
```

## Response Elements
<a name="API_StartTraceRetrieval_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RetrievalToken](#API_StartTraceRetrieval_ResponseSyntax) **   <a name="xray-StartTraceRetrieval-response-RetrievalToken"></a>
 Retrieval token.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1020.

## Errors
<a name="API_StartTraceRetrieval_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_StartTraceRetrieval_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/StartTraceRetrieval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/StartTraceRetrieval) 

# TagResource
<a name="API_TagResource"></a>

Applies tags to an existing AWS X-Ray group or sampling rule.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /TagResource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="xray-TagResource-request-ResourceARN"></a>
The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="xray-TagResource-request-Tags"></a>
A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference*.  
The following restrictions apply to tags:  
+ Maximum number of user-applied tags per resource: 50
+ Maximum tag key length: 128 Unicode characters
+ Maximum tag value length: 256 Unicode characters
+ Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: \$1 . : / = \$1 - and @
+ Tag keys and values are case sensitive.
+ Don't use `aws:` as a prefix for keys; it's reserved for AWS use. You cannot edit or delete system tags.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

 ** TooManyTagsException **   
You have exceeded the maximum number of tags you can apply to this resource.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an `aws:` prefix).

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
POST /UntagResource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="xray-UntagResource-request-ResourceARN"></a>
The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="xray-UntagResource-request-TagKeys"></a>
Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/UntagResource) 

# UpdateGroup
<a name="API_UpdateGroup"></a>

Updates a group resource.

## Request Syntax
<a name="API_UpdateGroup_RequestSyntax"></a>

```
POST /UpdateGroup HTTP/1.1
Content-type: application/json

{
   "FilterExpression": "string",
   "GroupARN": "string",
   "GroupName": "string",
   "InsightsConfiguration": { 
      "InsightsEnabled": boolean,
      "NotificationsEnabled": boolean
   }
}
```

## URI Request Parameters
<a name="API_UpdateGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FilterExpression](#API_UpdateGroup_RequestSyntax) **   <a name="xray-UpdateGroup-request-FilterExpression"></a>
The updated filter expression defining criteria by which to group traces.  
Type: String  
Required: No

 ** [GroupARN](#API_UpdateGroup_RequestSyntax) **   <a name="xray-UpdateGroup-request-GroupARN"></a>
The ARN that was generated upon creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [GroupName](#API_UpdateGroup_RequestSyntax) **   <a name="xray-UpdateGroup-request-GroupName"></a>
The case-sensitive name of the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** [InsightsConfiguration](#API_UpdateGroup_RequestSyntax) **   <a name="xray-UpdateGroup-request-InsightsConfiguration"></a>
The structure containing configurations related to insights.  
+ The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
+ The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
Type: [InsightsConfiguration](API_InsightsConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_UpdateGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Group": { 
      "FilterExpression": "string",
      "GroupARN": "string",
      "GroupName": "string",
      "InsightsConfiguration": { 
         "InsightsEnabled": boolean,
         "NotificationsEnabled": boolean
      }
   }
}
```

## Response Elements
<a name="API_UpdateGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Group](#API_UpdateGroup_ResponseSyntax) **   <a name="xray-UpdateGroup-response-Group"></a>
The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.  
Type: [Group](API_Group.md) object

## Errors
<a name="API_UpdateGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/UpdateGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/UpdateGroup) 

# UpdateIndexingRule
<a name="API_UpdateIndexingRule"></a>

 Modifies an indexing rule’s configuration. 

Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see [Transaction Search](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html).

## Request Syntax
<a name="API_UpdateIndexingRule_RequestSyntax"></a>

```
POST /UpdateIndexingRule HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "Rule": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateIndexingRule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateIndexingRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_UpdateIndexingRule_RequestSyntax) **   <a name="xray-UpdateIndexingRule-request-Name"></a>
 Name of the indexing rule to be updated.   
Type: String  
Required: Yes

 ** [Rule](#API_UpdateIndexingRule_RequestSyntax) **   <a name="xray-UpdateIndexingRule-request-Rule"></a>
 Rule configuration to be updated.   
Type: [IndexingRuleValueUpdate](API_IndexingRuleValueUpdate.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_UpdateIndexingRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IndexingRule": { 
      "ModifiedAt": number,
      "Name": "string",
      "Rule": { ... }
   }
}
```

## Response Elements
<a name="API_UpdateIndexingRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IndexingRule](#API_UpdateIndexingRule_ResponseSyntax) **   <a name="xray-UpdateIndexingRule-response-IndexingRule"></a>
 Updated indexing rule.   
Type: [IndexingRule](API_IndexingRule.md) object

## Errors
<a name="API_UpdateIndexingRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.  
HTTP Status Code: 404

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateIndexingRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/UpdateIndexingRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/UpdateIndexingRule) 

# UpdateSamplingRule
<a name="API_UpdateSamplingRule"></a>

Modifies a sampling rule's configuration.

## Request Syntax
<a name="API_UpdateSamplingRule_RequestSyntax"></a>

```
POST /UpdateSamplingRule HTTP/1.1
Content-type: application/json

{
   "SamplingRuleUpdate": { 
      "Attributes": { 
         "string" : "string" 
      },
      "FixedRate": number,
      "Host": "string",
      "HTTPMethod": "string",
      "Priority": number,
      "ReservoirSize": number,
      "ResourceARN": "string",
      "RuleARN": "string",
      "RuleName": "string",
      "SamplingRateBoost": { 
         "CooldownWindowMinutes": number,
         "MaxRate": number
      },
      "ServiceName": "string",
      "ServiceType": "string",
      "URLPath": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateSamplingRule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateSamplingRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SamplingRuleUpdate](#API_UpdateSamplingRule_RequestSyntax) **   <a name="xray-UpdateSamplingRule-request-SamplingRuleUpdate"></a>
The rule and fields to change.  
Type: [SamplingRuleUpdate](API_SamplingRuleUpdate.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateSamplingRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SamplingRuleRecord": { 
      "CreatedAt": number,
      "ModifiedAt": number,
      "SamplingRule": { 
         "Attributes": { 
            "string" : "string" 
         },
         "FixedRate": number,
         "Host": "string",
         "HTTPMethod": "string",
         "Priority": number,
         "ReservoirSize": number,
         "ResourceARN": "string",
         "RuleARN": "string",
         "RuleName": "string",
         "SamplingRateBoost": { 
            "CooldownWindowMinutes": number,
            "MaxRate": number
         },
         "ServiceName": "string",
         "ServiceType": "string",
         "URLPath": "string",
         "Version": number
      }
   }
}
```

## Response Elements
<a name="API_UpdateSamplingRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SamplingRuleRecord](#API_UpdateSamplingRule_ResponseSyntax) **   <a name="xray-UpdateSamplingRule-response-SamplingRuleRecord"></a>
The updated rule definition and metadata.  
Type: [SamplingRuleRecord](API_SamplingRuleRecord.md) object

## Errors
<a name="API_UpdateSamplingRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateSamplingRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/UpdateSamplingRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/UpdateSamplingRule) 

# UpdateTraceSegmentDestination
<a name="API_UpdateTraceSegmentDestination"></a>

 Modifies the destination of data sent to `PutTraceSegments`. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see [Transaction Search](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html). 

## Request Syntax
<a name="API_UpdateTraceSegmentDestination_RequestSyntax"></a>

```
POST /UpdateTraceSegmentDestination HTTP/1.1
Content-type: application/json

{
   "Destination": "string"
}
```

## URI Request Parameters
<a name="API_UpdateTraceSegmentDestination_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateTraceSegmentDestination_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Destination](#API_UpdateTraceSegmentDestination_RequestSyntax) **   <a name="xray-UpdateTraceSegmentDestination-request-Destination"></a>
 The configured destination of trace segments.   
Type: String  
Valid Values: `XRay | CloudWatchLogs`   
Required: No

## Response Syntax
<a name="API_UpdateTraceSegmentDestination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Destination": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateTraceSegmentDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Destination](#API_UpdateTraceSegmentDestination_ResponseSyntax) **   <a name="xray-UpdateTraceSegmentDestination-response-Destination"></a>
 The destination of the trace segments.   
Type: String  
Valid Values: `XRay | CloudWatchLogs` 

 ** [Status](#API_UpdateTraceSegmentDestination_ResponseSyntax) **   <a name="xray-UpdateTraceSegmentDestination-response-Status"></a>
 The status of the update.   
Type: String  
Valid Values: `PENDING | ACTIVE` 

## Errors
<a name="API_UpdateTraceSegmentDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidRequestException **   
The request is missing required parameters or has invalid parameters.  
HTTP Status Code: 400

 ** ThrottledException **   
The request exceeds the maximum number of requests per second.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateTraceSegmentDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/xray-2016-04-12/UpdateTraceSegmentDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/xray-2016-04-12/UpdateTraceSegmentDestination)