UNPKG

28.2 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2016-04-12",
5 "endpointPrefix": "xray",
6 "protocol": "rest-json",
7 "serviceFullName": "AWS X-Ray",
8 "serviceId": "XRay",
9 "signatureVersion": "v4",
10 "uid": "xray-2016-04-12"
11 },
12 "operations": {
13 "BatchGetTraces": {
14 "http": {
15 "requestUri": "/Traces"
16 },
17 "input": {
18 "type": "structure",
19 "required": [
20 "TraceIds"
21 ],
22 "members": {
23 "TraceIds": {
24 "shape": "S2"
25 },
26 "NextToken": {}
27 }
28 },
29 "output": {
30 "type": "structure",
31 "members": {
32 "Traces": {
33 "type": "list",
34 "member": {
35 "type": "structure",
36 "members": {
37 "Id": {},
38 "Duration": {
39 "type": "double"
40 },
41 "Segments": {
42 "type": "list",
43 "member": {
44 "type": "structure",
45 "members": {
46 "Id": {},
47 "Document": {}
48 }
49 }
50 }
51 }
52 }
53 },
54 "UnprocessedTraceIds": {
55 "type": "list",
56 "member": {}
57 },
58 "NextToken": {}
59 }
60 }
61 },
62 "CreateGroup": {
63 "http": {
64 "requestUri": "/CreateGroup"
65 },
66 "input": {
67 "type": "structure",
68 "required": [
69 "GroupName"
70 ],
71 "members": {
72 "GroupName": {},
73 "FilterExpression": {}
74 }
75 },
76 "output": {
77 "type": "structure",
78 "members": {
79 "Group": {
80 "shape": "Si"
81 }
82 }
83 }
84 },
85 "CreateSamplingRule": {
86 "http": {
87 "requestUri": "/CreateSamplingRule"
88 },
89 "input": {
90 "type": "structure",
91 "required": [
92 "SamplingRule"
93 ],
94 "members": {
95 "SamplingRule": {
96 "shape": "Sk"
97 }
98 }
99 },
100 "output": {
101 "type": "structure",
102 "members": {
103 "SamplingRuleRecord": {
104 "shape": "S10"
105 }
106 }
107 }
108 },
109 "DeleteGroup": {
110 "http": {
111 "requestUri": "/DeleteGroup"
112 },
113 "input": {
114 "type": "structure",
115 "members": {
116 "GroupName": {},
117 "GroupARN": {}
118 }
119 },
120 "output": {
121 "type": "structure",
122 "members": {}
123 }
124 },
125 "DeleteSamplingRule": {
126 "http": {
127 "requestUri": "/DeleteSamplingRule"
128 },
129 "input": {
130 "type": "structure",
131 "members": {
132 "RuleName": {},
133 "RuleARN": {}
134 }
135 },
136 "output": {
137 "type": "structure",
138 "members": {
139 "SamplingRuleRecord": {
140 "shape": "S10"
141 }
142 }
143 }
144 },
145 "GetEncryptionConfig": {
146 "http": {
147 "requestUri": "/EncryptionConfig"
148 },
149 "input": {
150 "type": "structure",
151 "members": {}
152 },
153 "output": {
154 "type": "structure",
155 "members": {
156 "EncryptionConfig": {
157 "shape": "S19"
158 }
159 }
160 }
161 },
162 "GetGroup": {
163 "http": {
164 "requestUri": "/GetGroup"
165 },
166 "input": {
167 "type": "structure",
168 "members": {
169 "GroupName": {},
170 "GroupARN": {}
171 }
172 },
173 "output": {
174 "type": "structure",
175 "members": {
176 "Group": {
177 "shape": "Si"
178 }
179 }
180 }
181 },
182 "GetGroups": {
183 "http": {
184 "requestUri": "/Groups"
185 },
186 "input": {
187 "type": "structure",
188 "members": {
189 "NextToken": {}
190 }
191 },
192 "output": {
193 "type": "structure",
194 "members": {
195 "Groups": {
196 "type": "list",
197 "member": {
198 "type": "structure",
199 "members": {
200 "GroupName": {},
201 "GroupARN": {},
202 "FilterExpression": {}
203 }
204 }
205 },
206 "NextToken": {}
207 }
208 }
209 },
210 "GetSamplingRules": {
211 "http": {
212 "requestUri": "/GetSamplingRules"
213 },
214 "input": {
215 "type": "structure",
216 "members": {
217 "NextToken": {}
218 }
219 },
220 "output": {
221 "type": "structure",
222 "members": {
223 "SamplingRuleRecords": {
224 "type": "list",
225 "member": {
226 "shape": "S10"
227 }
228 },
229 "NextToken": {}
230 }
231 }
232 },
233 "GetSamplingStatisticSummaries": {
234 "http": {
235 "requestUri": "/SamplingStatisticSummaries"
236 },
237 "input": {
238 "type": "structure",
239 "members": {
240 "NextToken": {}
241 }
242 },
243 "output": {
244 "type": "structure",
245 "members": {
246 "SamplingStatisticSummaries": {
247 "type": "list",
248 "member": {
249 "type": "structure",
250 "members": {
251 "RuleName": {},
252 "Timestamp": {
253 "type": "timestamp"
254 },
255 "RequestCount": {
256 "type": "integer"
257 },
258 "BorrowCount": {
259 "type": "integer"
260 },
261 "SampledCount": {
262 "type": "integer"
263 }
264 }
265 }
266 },
267 "NextToken": {}
268 }
269 }
270 },
271 "GetSamplingTargets": {
272 "http": {
273 "requestUri": "/SamplingTargets"
274 },
275 "input": {
276 "type": "structure",
277 "required": [
278 "SamplingStatisticsDocuments"
279 ],
280 "members": {
281 "SamplingStatisticsDocuments": {
282 "type": "list",
283 "member": {
284 "type": "structure",
285 "required": [
286 "RuleName",
287 "ClientID",
288 "Timestamp",
289 "RequestCount",
290 "SampledCount"
291 ],
292 "members": {
293 "RuleName": {},
294 "ClientID": {},
295 "Timestamp": {
296 "type": "timestamp"
297 },
298 "RequestCount": {
299 "type": "integer"
300 },
301 "SampledCount": {
302 "type": "integer"
303 },
304 "BorrowCount": {
305 "type": "integer"
306 }
307 }
308 }
309 }
310 }
311 },
312 "output": {
313 "type": "structure",
314 "members": {
315 "SamplingTargetDocuments": {
316 "type": "list",
317 "member": {
318 "type": "structure",
319 "members": {
320 "RuleName": {},
321 "FixedRate": {
322 "type": "double"
323 },
324 "ReservoirQuota": {
325 "type": "integer"
326 },
327 "ReservoirQuotaTTL": {
328 "type": "timestamp"
329 },
330 "Interval": {
331 "type": "integer"
332 }
333 }
334 }
335 },
336 "LastRuleModification": {
337 "type": "timestamp"
338 },
339 "UnprocessedStatistics": {
340 "type": "list",
341 "member": {
342 "type": "structure",
343 "members": {
344 "RuleName": {},
345 "ErrorCode": {},
346 "Message": {}
347 }
348 }
349 }
350 }
351 }
352 },
353 "GetServiceGraph": {
354 "http": {
355 "requestUri": "/ServiceGraph"
356 },
357 "input": {
358 "type": "structure",
359 "required": [
360 "StartTime",
361 "EndTime"
362 ],
363 "members": {
364 "StartTime": {
365 "type": "timestamp"
366 },
367 "EndTime": {
368 "type": "timestamp"
369 },
370 "GroupName": {},
371 "GroupARN": {},
372 "NextToken": {}
373 }
374 },
375 "output": {
376 "type": "structure",
377 "members": {
378 "StartTime": {
379 "type": "timestamp"
380 },
381 "EndTime": {
382 "type": "timestamp"
383 },
384 "Services": {
385 "shape": "S27"
386 },
387 "ContainsOldGroupVersions": {
388 "type": "boolean"
389 },
390 "NextToken": {}
391 }
392 }
393 },
394 "GetTraceGraph": {
395 "http": {
396 "requestUri": "/TraceGraph"
397 },
398 "input": {
399 "type": "structure",
400 "required": [
401 "TraceIds"
402 ],
403 "members": {
404 "TraceIds": {
405 "shape": "S2"
406 },
407 "NextToken": {}
408 }
409 },
410 "output": {
411 "type": "structure",
412 "members": {
413 "Services": {
414 "shape": "S27"
415 },
416 "NextToken": {}
417 }
418 }
419 },
420 "GetTraceSummaries": {
421 "http": {
422 "requestUri": "/TraceSummaries"
423 },
424 "input": {
425 "type": "structure",
426 "required": [
427 "StartTime",
428 "EndTime"
429 ],
430 "members": {
431 "StartTime": {
432 "type": "timestamp"
433 },
434 "EndTime": {
435 "type": "timestamp"
436 },
437 "Sampling": {
438 "type": "boolean"
439 },
440 "FilterExpression": {},
441 "NextToken": {}
442 }
443 },
444 "output": {
445 "type": "structure",
446 "members": {
447 "TraceSummaries": {
448 "type": "list",
449 "member": {
450 "type": "structure",
451 "members": {
452 "Id": {},
453 "Duration": {
454 "type": "double"
455 },
456 "ResponseTime": {
457 "type": "double"
458 },
459 "HasFault": {
460 "type": "boolean"
461 },
462 "HasError": {
463 "type": "boolean"
464 },
465 "HasThrottle": {
466 "type": "boolean"
467 },
468 "IsPartial": {
469 "type": "boolean"
470 },
471 "Http": {
472 "type": "structure",
473 "members": {
474 "HttpURL": {},
475 "HttpStatus": {
476 "type": "integer"
477 },
478 "HttpMethod": {},
479 "UserAgent": {},
480 "ClientIp": {}
481 }
482 },
483 "Annotations": {
484 "type": "map",
485 "key": {},
486 "value": {
487 "type": "list",
488 "member": {
489 "type": "structure",
490 "members": {
491 "AnnotationValue": {
492 "type": "structure",
493 "members": {
494 "NumberValue": {
495 "type": "double"
496 },
497 "BooleanValue": {
498 "type": "boolean"
499 },
500 "StringValue": {}
501 }
502 },
503 "ServiceIds": {
504 "shape": "S30"
505 }
506 }
507 }
508 }
509 },
510 "Users": {
511 "type": "list",
512 "member": {
513 "type": "structure",
514 "members": {
515 "UserName": {},
516 "ServiceIds": {
517 "shape": "S30"
518 }
519 }
520 }
521 },
522 "ServiceIds": {
523 "shape": "S30"
524 },
525 "ResourceARNs": {
526 "type": "list",
527 "member": {
528 "type": "structure",
529 "members": {
530 "ARN": {}
531 }
532 }
533 },
534 "InstanceIds": {
535 "type": "list",
536 "member": {
537 "type": "structure",
538 "members": {
539 "Id": {}
540 }
541 }
542 },
543 "AvailabilityZones": {
544 "type": "list",
545 "member": {
546 "type": "structure",
547 "members": {
548 "Name": {}
549 }
550 }
551 },
552 "EntryPoint": {
553 "shape": "S31"
554 },
555 "FaultRootCauses": {
556 "type": "list",
557 "member": {
558 "type": "structure",
559 "members": {
560 "Services": {
561 "type": "list",
562 "member": {
563 "type": "structure",
564 "members": {
565 "Name": {},
566 "Names": {
567 "shape": "S29"
568 },
569 "Type": {},
570 "AccountId": {},
571 "EntityPath": {
572 "type": "list",
573 "member": {
574 "type": "structure",
575 "members": {
576 "Name": {},
577 "Exceptions": {
578 "shape": "S3g"
579 },
580 "Remote": {
581 "type": "boolean"
582 }
583 }
584 }
585 },
586 "Inferred": {
587 "type": "boolean"
588 }
589 }
590 }
591 }
592 }
593 }
594 },
595 "ErrorRootCauses": {
596 "type": "list",
597 "member": {
598 "type": "structure",
599 "members": {
600 "Services": {
601 "type": "list",
602 "member": {
603 "type": "structure",
604 "members": {
605 "Name": {},
606 "Names": {
607 "shape": "S29"
608 },
609 "Type": {},
610 "AccountId": {},
611 "EntityPath": {
612 "type": "list",
613 "member": {
614 "type": "structure",
615 "members": {
616 "Name": {},
617 "Exceptions": {
618 "shape": "S3g"
619 },
620 "Remote": {
621 "type": "boolean"
622 }
623 }
624 }
625 },
626 "Inferred": {
627 "type": "boolean"
628 }
629 }
630 }
631 }
632 }
633 }
634 },
635 "ResponseTimeRootCauses": {
636 "type": "list",
637 "member": {
638 "type": "structure",
639 "members": {
640 "Services": {
641 "type": "list",
642 "member": {
643 "type": "structure",
644 "members": {
645 "Name": {},
646 "Names": {
647 "shape": "S29"
648 },
649 "Type": {},
650 "AccountId": {},
651 "EntityPath": {
652 "type": "list",
653 "member": {
654 "type": "structure",
655 "members": {
656 "Name": {},
657 "Coverage": {
658 "type": "double"
659 },
660 "Remote": {
661 "type": "boolean"
662 }
663 }
664 }
665 },
666 "Inferred": {
667 "type": "boolean"
668 }
669 }
670 }
671 }
672 }
673 }
674 },
675 "Revision": {
676 "type": "integer"
677 }
678 }
679 }
680 },
681 "ApproximateTime": {
682 "type": "timestamp"
683 },
684 "TracesProcessedCount": {
685 "type": "long"
686 },
687 "NextToken": {}
688 }
689 }
690 },
691 "PutEncryptionConfig": {
692 "http": {
693 "requestUri": "/PutEncryptionConfig"
694 },
695 "input": {
696 "type": "structure",
697 "required": [
698 "Type"
699 ],
700 "members": {
701 "KeyId": {},
702 "Type": {}
703 }
704 },
705 "output": {
706 "type": "structure",
707 "members": {
708 "EncryptionConfig": {
709 "shape": "S19"
710 }
711 }
712 }
713 },
714 "PutTelemetryRecords": {
715 "http": {
716 "requestUri": "/TelemetryRecords"
717 },
718 "input": {
719 "type": "structure",
720 "required": [
721 "TelemetryRecords"
722 ],
723 "members": {
724 "TelemetryRecords": {
725 "type": "list",
726 "member": {
727 "type": "structure",
728 "required": [
729 "Timestamp"
730 ],
731 "members": {
732 "Timestamp": {
733 "type": "timestamp"
734 },
735 "SegmentsReceivedCount": {
736 "type": "integer"
737 },
738 "SegmentsSentCount": {
739 "type": "integer"
740 },
741 "SegmentsSpilloverCount": {
742 "type": "integer"
743 },
744 "SegmentsRejectedCount": {
745 "type": "integer"
746 },
747 "BackendConnectionErrors": {
748 "type": "structure",
749 "members": {
750 "TimeoutCount": {
751 "type": "integer"
752 },
753 "ConnectionRefusedCount": {
754 "type": "integer"
755 },
756 "HTTPCode4XXCount": {
757 "type": "integer"
758 },
759 "HTTPCode5XXCount": {
760 "type": "integer"
761 },
762 "UnknownHostCount": {
763 "type": "integer"
764 },
765 "OtherCount": {
766 "type": "integer"
767 }
768 }
769 }
770 }
771 }
772 },
773 "EC2InstanceId": {},
774 "Hostname": {},
775 "ResourceARN": {}
776 }
777 },
778 "output": {
779 "type": "structure",
780 "members": {}
781 }
782 },
783 "PutTraceSegments": {
784 "http": {
785 "requestUri": "/TraceSegments"
786 },
787 "input": {
788 "type": "structure",
789 "required": [
790 "TraceSegmentDocuments"
791 ],
792 "members": {
793 "TraceSegmentDocuments": {
794 "type": "list",
795 "member": {}
796 }
797 }
798 },
799 "output": {
800 "type": "structure",
801 "members": {
802 "UnprocessedTraceSegments": {
803 "type": "list",
804 "member": {
805 "type": "structure",
806 "members": {
807 "Id": {},
808 "ErrorCode": {},
809 "Message": {}
810 }
811 }
812 }
813 }
814 }
815 },
816 "UpdateGroup": {
817 "http": {
818 "requestUri": "/UpdateGroup"
819 },
820 "input": {
821 "type": "structure",
822 "members": {
823 "GroupName": {},
824 "GroupARN": {},
825 "FilterExpression": {}
826 }
827 },
828 "output": {
829 "type": "structure",
830 "members": {
831 "Group": {
832 "shape": "Si"
833 }
834 }
835 }
836 },
837 "UpdateSamplingRule": {
838 "http": {
839 "requestUri": "/UpdateSamplingRule"
840 },
841 "input": {
842 "type": "structure",
843 "required": [
844 "SamplingRuleUpdate"
845 ],
846 "members": {
847 "SamplingRuleUpdate": {
848 "type": "structure",
849 "members": {
850 "RuleName": {},
851 "RuleARN": {},
852 "ResourceARN": {},
853 "Priority": {
854 "type": "integer"
855 },
856 "FixedRate": {
857 "type": "double"
858 },
859 "ReservoirSize": {
860 "type": "integer"
861 },
862 "Host": {},
863 "ServiceName": {},
864 "ServiceType": {},
865 "HTTPMethod": {},
866 "URLPath": {},
867 "Attributes": {
868 "shape": "Sw"
869 }
870 }
871 }
872 }
873 },
874 "output": {
875 "type": "structure",
876 "members": {
877 "SamplingRuleRecord": {
878 "shape": "S10"
879 }
880 }
881 }
882 }
883 },
884 "shapes": {
885 "S2": {
886 "type": "list",
887 "member": {}
888 },
889 "Si": {
890 "type": "structure",
891 "members": {
892 "GroupName": {},
893 "GroupARN": {},
894 "FilterExpression": {}
895 }
896 },
897 "Sk": {
898 "type": "structure",
899 "required": [
900 "ResourceARN",
901 "Priority",
902 "FixedRate",
903 "ReservoirSize",
904 "ServiceName",
905 "ServiceType",
906 "Host",
907 "HTTPMethod",
908 "URLPath",
909 "Version"
910 ],
911 "members": {
912 "RuleName": {},
913 "RuleARN": {},
914 "ResourceARN": {},
915 "Priority": {
916 "type": "integer"
917 },
918 "FixedRate": {
919 "type": "double"
920 },
921 "ReservoirSize": {
922 "type": "integer"
923 },
924 "ServiceName": {},
925 "ServiceType": {},
926 "Host": {},
927 "HTTPMethod": {},
928 "URLPath": {},
929 "Version": {
930 "type": "integer"
931 },
932 "Attributes": {
933 "shape": "Sw"
934 }
935 }
936 },
937 "Sw": {
938 "type": "map",
939 "key": {},
940 "value": {}
941 },
942 "S10": {
943 "type": "structure",
944 "members": {
945 "SamplingRule": {
946 "shape": "Sk"
947 },
948 "CreatedAt": {
949 "type": "timestamp"
950 },
951 "ModifiedAt": {
952 "type": "timestamp"
953 }
954 }
955 },
956 "S19": {
957 "type": "structure",
958 "members": {
959 "KeyId": {},
960 "Status": {},
961 "Type": {}
962 }
963 },
964 "S27": {
965 "type": "list",
966 "member": {
967 "type": "structure",
968 "members": {
969 "ReferenceId": {
970 "type": "integer"
971 },
972 "Name": {},
973 "Names": {
974 "shape": "S29"
975 },
976 "Root": {
977 "type": "boolean"
978 },
979 "AccountId": {},
980 "Type": {},
981 "State": {},
982 "StartTime": {
983 "type": "timestamp"
984 },
985 "EndTime": {
986 "type": "timestamp"
987 },
988 "Edges": {
989 "type": "list",
990 "member": {
991 "type": "structure",
992 "members": {
993 "ReferenceId": {
994 "type": "integer"
995 },
996 "StartTime": {
997 "type": "timestamp"
998 },
999 "EndTime": {
1000 "type": "timestamp"
1001 },
1002 "SummaryStatistics": {
1003 "type": "structure",
1004 "members": {
1005 "OkCount": {
1006 "type": "long"
1007 },
1008 "ErrorStatistics": {
1009 "shape": "S2f"
1010 },
1011 "FaultStatistics": {
1012 "shape": "S2g"
1013 },
1014 "TotalCount": {
1015 "type": "long"
1016 },
1017 "TotalResponseTime": {
1018 "type": "double"
1019 }
1020 }
1021 },
1022 "ResponseTimeHistogram": {
1023 "shape": "S2h"
1024 },
1025 "Aliases": {
1026 "type": "list",
1027 "member": {
1028 "type": "structure",
1029 "members": {
1030 "Name": {},
1031 "Names": {
1032 "type": "list",
1033 "member": {}
1034 },
1035 "Type": {}
1036 }
1037 }
1038 }
1039 }
1040 }
1041 },
1042 "SummaryStatistics": {
1043 "type": "structure",
1044 "members": {
1045 "OkCount": {
1046 "type": "long"
1047 },
1048 "ErrorStatistics": {
1049 "shape": "S2f"
1050 },
1051 "FaultStatistics": {
1052 "shape": "S2g"
1053 },
1054 "TotalCount": {
1055 "type": "long"
1056 },
1057 "TotalResponseTime": {
1058 "type": "double"
1059 }
1060 }
1061 },
1062 "DurationHistogram": {
1063 "shape": "S2h"
1064 },
1065 "ResponseTimeHistogram": {
1066 "shape": "S2h"
1067 }
1068 }
1069 }
1070 },
1071 "S29": {
1072 "type": "list",
1073 "member": {}
1074 },
1075 "S2f": {
1076 "type": "structure",
1077 "members": {
1078 "ThrottleCount": {
1079 "type": "long"
1080 },
1081 "OtherCount": {
1082 "type": "long"
1083 },
1084 "TotalCount": {
1085 "type": "long"
1086 }
1087 }
1088 },
1089 "S2g": {
1090 "type": "structure",
1091 "members": {
1092 "OtherCount": {
1093 "type": "long"
1094 },
1095 "TotalCount": {
1096 "type": "long"
1097 }
1098 }
1099 },
1100 "S2h": {
1101 "type": "list",
1102 "member": {
1103 "type": "structure",
1104 "members": {
1105 "Value": {
1106 "type": "double"
1107 },
1108 "Count": {
1109 "type": "integer"
1110 }
1111 }
1112 }
1113 },
1114 "S30": {
1115 "type": "list",
1116 "member": {
1117 "shape": "S31"
1118 }
1119 },
1120 "S31": {
1121 "type": "structure",
1122 "members": {
1123 "Name": {},
1124 "Names": {
1125 "shape": "S29"
1126 },
1127 "AccountId": {},
1128 "Type": {}
1129 }
1130 },
1131 "S3g": {
1132 "type": "list",
1133 "member": {
1134 "type": "structure",
1135 "members": {
1136 "Name": {},
1137 "Message": {}
1138 }
1139 }
1140 }
1141 }
1142}
\No newline at end of file