1---2name: aws-x-ray3description: AWS X-Ray API skill. Use when working with AWS X-Ray for Traces, CreateGroup, CreateSamplingRule. Covers 30 endpoints.4---5
6# AWS X-Ray
7API version: 2016-04-12
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
173. POST /Traces -- create first Traces
18
19## Endpoints
20
2130 endpoints across 30 groups. See references/api-spec.lap for full details.
22
23### Traces
24| Method | Path | Description |
25|--------|------|-------------|
26| POST | /Traces | 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. |
27
28### CreateGroup
29| Method | Path | Description |
30|--------|------|-------------|
31| POST | /CreateGroup | Creates a group resource with a name and a filter expression. |
32
33### CreateSamplingRule
34| Method | Path | Description |
35|--------|------|-------------|
36| POST | /CreateSamplingRule | Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir. |
37
38### DeleteGroup
39| Method | Path | Description |
40|--------|------|-------------|
41| POST | /DeleteGroup | Deletes a group resource. |
42
43### DeleteResourcePolicy
44| Method | Path | Description |
45|--------|------|-------------|
46| POST | /DeleteResourcePolicy | Deletes a resource policy from the target Amazon Web Services account. |
47
48### DeleteSamplingRule
49| Method | Path | Description |
50|--------|------|-------------|
51| POST | /DeleteSamplingRule | Deletes a sampling rule. |
52
53### EncryptionConfig
54| Method | Path | Description |
55|--------|------|-------------|
56| POST | /EncryptionConfig | Retrieves the current encryption configuration for X-Ray data. |
57
58### GetGroup
59| Method | Path | Description |
60|--------|------|-------------|
61| POST | /GetGroup | Retrieves group resource details. |
62
63### Groups
64| Method | Path | Description |
65|--------|------|-------------|
66| POST | /Groups | Retrieves all active group details. |
67
68### Insight
69| Method | Path | Description |
70|--------|------|-------------|
71| POST | /Insight | 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. |
72
73### InsightEvents
74| Method | Path | Description |
75|--------|------|-------------|
76| POST | /InsightEvents | 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. |
77
78### InsightImpactGraph
79| Method | Path | Description |
80|--------|------|-------------|
81| POST | /InsightImpactGraph | 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. |
82
83### InsightSummaries
84| Method | Path | Description |
85|--------|------|-------------|
86| POST | /InsightSummaries | Retrieves the summaries of all insights in the specified group matching the provided filter values. |
87
88### GetSamplingRules
89| Method | Path | Description |
90|--------|------|-------------|
91| POST | /GetSamplingRules | Retrieves all sampling rules. |
92
93### SamplingStatisticSummaries
94| Method | Path | Description |
95|--------|------|-------------|
96| POST | /SamplingStatisticSummaries | Retrieves information about recent sampling results for all sampling rules. |
97
98### SamplingTargets
99| Method | Path | Description |
100|--------|------|-------------|
101| POST | /SamplingTargets | Requests a sampling quota for rules that the service is using to sample requests. |
102
103### ServiceGraph
104| Method | Path | Description |
105|--------|------|-------------|
106| POST | /ServiceGraph | Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases. |
107
108### TimeSeriesServiceStatistics
109| Method | Path | Description |
110|--------|------|-------------|
111| POST | /TimeSeriesServiceStatistics | Get an aggregation of service statistics defined by a specific time range. |
112
113### TraceGraph
114| Method | Path | Description |
115|--------|------|-------------|
116| POST | /TraceGraph | Retrieves a service graph for one or more specific trace IDs. |
117
118### TraceSummaries
119| Method | Path | Description |
120|--------|------|-------------|
121| POST | /TraceSummaries | Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide. |
122
123### ListResourcePolicies
124| Method | Path | Description |
125|--------|------|-------------|
126| POST | /ListResourcePolicies | Returns the list of resource policies in the target Amazon Web Services account. |
127
128### ListTagsForResource
129| Method | Path | Description |
130|--------|------|-------------|
131| POST | /ListTagsForResource | Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule. |
132
133### PutEncryptionConfig
134| Method | Path | Description |
135|--------|------|-------------|
136| POST | /PutEncryptionConfig | Updates the encryption configuration for X-Ray data. |
137
138### PutResourcePolicy
139| Method | Path | Description |
140|--------|------|-------------|
141| POST | /PutResourcePolicy | Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB. |
142
143### TelemetryRecords
144| Method | Path | Description |
145|--------|------|-------------|
146| POST | /TelemetryRecords | Used by the Amazon Web Services X-Ray daemon to upload telemetry. |
147
148### TraceSegments
149| Method | Path | Description |
150|--------|------|-------------|
151| POST | /TraceSegments | Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, for instance, 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. |
152
153### TagResource
154| Method | Path | Description |
155|--------|------|-------------|
156| POST | /TagResource | Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. |
157
158### UntagResource
159| Method | Path | Description |
160|--------|------|-------------|
161| POST | /UntagResource | Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix). |
162
163### UpdateGroup
164| Method | Path | Description |
165|--------|------|-------------|
166| POST | /UpdateGroup | Updates a group resource. |
167
168### UpdateSamplingRule
169| Method | Path | Description |
170|--------|------|-------------|
171| POST | /UpdateSamplingRule | Modifies a sampling rule's configuration. |
172
173## Common Questions
174
175Match user requests to endpoints in references/api-spec.lap. Key patterns:
176- "Create a Trace?" -> POST /Traces
177- "Create a CreateGroup?" -> POST /CreateGroup
178- "Create a CreateSamplingRule?" -> POST /CreateSamplingRule
179- "Create a DeleteGroup?" -> POST /DeleteGroup
180- "Create a DeleteResourcePolicy?" -> POST /DeleteResourcePolicy
181- "Create a DeleteSamplingRule?" -> POST /DeleteSamplingRule
182- "Create a EncryptionConfig?" -> POST /EncryptionConfig
183- "Create a GetGroup?" -> POST /GetGroup
184- "Create a Group?" -> POST /Groups
185- "Create a Insight?" -> POST /Insight
186- "Create a InsightEvent?" -> POST /InsightEvents
187- "Create a InsightImpactGraph?" -> POST /InsightImpactGraph
188- "Create a InsightSummary?" -> POST /InsightSummaries
189- "Create a GetSamplingRule?" -> POST /GetSamplingRules
190- "Create a SamplingStatisticSummary?" -> POST /SamplingStatisticSummaries
191- "Create a SamplingTarget?" -> POST /SamplingTargets
192- "Create a ServiceGraph?" -> POST /ServiceGraph
193- "Create a TimeSeriesServiceStatistic?" -> POST /TimeSeriesServiceStatistics
194- "Create a TraceGraph?" -> POST /TraceGraph
195- "Create a TraceSummary?" -> POST /TraceSummaries
196- "Create a ListResourcePolicy?" -> POST /ListResourcePolicies
197- "Create a ListTagsForResource?" -> POST /ListTagsForResource
198- "Create a PutEncryptionConfig?" -> POST /PutEncryptionConfig
199- "Create a PutResourcePolicy?" -> POST /PutResourcePolicy
200- "Create a TelemetryRecord?" -> POST /TelemetryRecords
201- "Create a TraceSegment?" -> POST /TraceSegments
202- "Create a TagResource?" -> POST /TagResource
203- "Create a UntagResource?" -> POST /UntagResource
204- "Create a UpdateGroup?" -> POST /UpdateGroup
205- "Create a UpdateSamplingRule?" -> POST /UpdateSamplingRule
206- "How to authenticate?" -> See Auth section
207
208## Response Tips
209- Check response schemas in references/api-spec.lap for field details
210- Create/update endpoints typically return the created/updated object
211
212## References
213- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
214
215> Generated from the official API spec by [LAP](https://lap.sh)