@aws-sdk/client-xray 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/dist-cjs/commands/BatchGetTracesCommand.js +2 -3
  2. package/dist-cjs/commands/CreateGroupCommand.js +2 -3
  3. package/dist-cjs/commands/CreateSamplingRuleCommand.js +2 -3
  4. package/dist-cjs/commands/DeleteGroupCommand.js +2 -3
  5. package/dist-cjs/commands/DeleteResourcePolicyCommand.js +2 -3
  6. package/dist-cjs/commands/DeleteSamplingRuleCommand.js +2 -3
  7. package/dist-cjs/commands/GetEncryptionConfigCommand.js +2 -3
  8. package/dist-cjs/commands/GetGroupCommand.js +2 -3
  9. package/dist-cjs/commands/GetGroupsCommand.js +2 -3
  10. package/dist-cjs/commands/GetInsightCommand.js +2 -3
  11. package/dist-cjs/commands/GetInsightEventsCommand.js +2 -3
  12. package/dist-cjs/commands/GetInsightImpactGraphCommand.js +2 -3
  13. package/dist-cjs/commands/GetInsightSummariesCommand.js +2 -3
  14. package/dist-cjs/commands/GetSamplingRulesCommand.js +2 -3
  15. package/dist-cjs/commands/GetSamplingStatisticSummariesCommand.js +2 -3
  16. package/dist-cjs/commands/GetSamplingTargetsCommand.js +2 -3
  17. package/dist-cjs/commands/GetServiceGraphCommand.js +2 -3
  18. package/dist-cjs/commands/GetTimeSeriesServiceStatisticsCommand.js +2 -3
  19. package/dist-cjs/commands/GetTraceGraphCommand.js +2 -3
  20. package/dist-cjs/commands/GetTraceSummariesCommand.js +2 -3
  21. package/dist-cjs/commands/ListResourcePoliciesCommand.js +2 -3
  22. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  23. package/dist-cjs/commands/PutEncryptionConfigCommand.js +2 -3
  24. package/dist-cjs/commands/PutResourcePolicyCommand.js +2 -3
  25. package/dist-cjs/commands/PutTelemetryRecordsCommand.js +2 -3
  26. package/dist-cjs/commands/PutTraceSegmentsCommand.js +2 -3
  27. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  28. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  29. package/dist-cjs/commands/UpdateGroupCommand.js +2 -3
  30. package/dist-cjs/commands/UpdateSamplingRuleCommand.js +2 -3
  31. package/dist-cjs/models/models_0.js +1 -474
  32. package/dist-es/commands/BatchGetTracesCommand.js +2 -3
  33. package/dist-es/commands/CreateGroupCommand.js +2 -3
  34. package/dist-es/commands/CreateSamplingRuleCommand.js +2 -3
  35. package/dist-es/commands/DeleteGroupCommand.js +2 -3
  36. package/dist-es/commands/DeleteResourcePolicyCommand.js +2 -3
  37. package/dist-es/commands/DeleteSamplingRuleCommand.js +2 -3
  38. package/dist-es/commands/GetEncryptionConfigCommand.js +2 -3
  39. package/dist-es/commands/GetGroupCommand.js +2 -3
  40. package/dist-es/commands/GetGroupsCommand.js +2 -3
  41. package/dist-es/commands/GetInsightCommand.js +2 -3
  42. package/dist-es/commands/GetInsightEventsCommand.js +2 -3
  43. package/dist-es/commands/GetInsightImpactGraphCommand.js +2 -3
  44. package/dist-es/commands/GetInsightSummariesCommand.js +2 -3
  45. package/dist-es/commands/GetSamplingRulesCommand.js +2 -3
  46. package/dist-es/commands/GetSamplingStatisticSummariesCommand.js +2 -3
  47. package/dist-es/commands/GetSamplingTargetsCommand.js +2 -3
  48. package/dist-es/commands/GetServiceGraphCommand.js +2 -3
  49. package/dist-es/commands/GetTimeSeriesServiceStatisticsCommand.js +2 -3
  50. package/dist-es/commands/GetTraceGraphCommand.js +2 -3
  51. package/dist-es/commands/GetTraceSummariesCommand.js +2 -3
  52. package/dist-es/commands/ListResourcePoliciesCommand.js +2 -3
  53. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  54. package/dist-es/commands/PutEncryptionConfigCommand.js +2 -3
  55. package/dist-es/commands/PutResourcePolicyCommand.js +2 -3
  56. package/dist-es/commands/PutTelemetryRecordsCommand.js +2 -3
  57. package/dist-es/commands/PutTraceSegmentsCommand.js +2 -3
  58. package/dist-es/commands/TagResourceCommand.js +2 -3
  59. package/dist-es/commands/UntagResourceCommand.js +2 -3
  60. package/dist-es/commands/UpdateGroupCommand.js +2 -3
  61. package/dist-es/commands/UpdateSamplingRuleCommand.js +2 -3
  62. package/dist-es/models/models_0.js +0 -356
  63. package/dist-types/XRay.d.ts +31 -0
  64. package/dist-types/XRayClient.d.ts +24 -4
  65. package/dist-types/commands/BatchGetTracesCommand.d.ts +16 -0
  66. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  67. package/dist-types/commands/CreateSamplingRuleCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  69. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  70. package/dist-types/commands/DeleteSamplingRuleCommand.d.ts +16 -0
  71. package/dist-types/commands/GetEncryptionConfigCommand.d.ts +16 -0
  72. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  73. package/dist-types/commands/GetGroupsCommand.d.ts +16 -0
  74. package/dist-types/commands/GetInsightCommand.d.ts +16 -0
  75. package/dist-types/commands/GetInsightEventsCommand.d.ts +16 -0
  76. package/dist-types/commands/GetInsightImpactGraphCommand.d.ts +16 -0
  77. package/dist-types/commands/GetInsightSummariesCommand.d.ts +16 -0
  78. package/dist-types/commands/GetSamplingRulesCommand.d.ts +16 -0
  79. package/dist-types/commands/GetSamplingStatisticSummariesCommand.d.ts +16 -0
  80. package/dist-types/commands/GetSamplingTargetsCommand.d.ts +16 -0
  81. package/dist-types/commands/GetServiceGraphCommand.d.ts +16 -0
  82. package/dist-types/commands/GetTimeSeriesServiceStatisticsCommand.d.ts +16 -0
  83. package/dist-types/commands/GetTraceGraphCommand.d.ts +16 -0
  84. package/dist-types/commands/GetTraceSummariesCommand.d.ts +16 -0
  85. package/dist-types/commands/ListResourcePoliciesCommand.d.ts +16 -0
  86. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  87. package/dist-types/commands/PutEncryptionConfigCommand.d.ts +16 -0
  88. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  89. package/dist-types/commands/PutTelemetryRecordsCommand.d.ts +16 -0
  90. package/dist-types/commands/PutTraceSegmentsCommand.d.ts +16 -0
  91. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  92. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateSamplingRuleCommand.d.ts +16 -0
  95. package/dist-types/models/XRayServiceException.d.ts +2 -0
  96. package/dist-types/models/models_0.d.ts +266 -460
  97. package/dist-types/pagination/BatchGetTracesPaginator.d.ts +3 -0
  98. package/dist-types/pagination/GetGroupsPaginator.d.ts +3 -0
  99. package/dist-types/pagination/GetInsightEventsPaginator.d.ts +3 -0
  100. package/dist-types/pagination/GetInsightSummariesPaginator.d.ts +3 -0
  101. package/dist-types/pagination/GetSamplingRulesPaginator.d.ts +3 -0
  102. package/dist-types/pagination/GetSamplingStatisticSummariesPaginator.d.ts +3 -0
  103. package/dist-types/pagination/GetServiceGraphPaginator.d.ts +3 -0
  104. package/dist-types/pagination/GetTimeSeriesServiceStatisticsPaginator.d.ts +3 -0
  105. package/dist-types/pagination/GetTraceGraphPaginator.d.ts +3 -0
  106. package/dist-types/pagination/GetTraceSummariesPaginator.d.ts +3 -0
  107. package/dist-types/pagination/Interfaces.d.ts +3 -0
  108. package/dist-types/pagination/ListResourcePoliciesPaginator.d.ts +3 -0
  109. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  110. package/dist-types/ts3.4/models/models_0.d.ts +0 -315
  111. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchGetTracesRequest, BatchGetTracesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetTracesCommand}.
8
10
  */
9
11
  export interface BatchGetTracesCommandInput extends BatchGetTracesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetTracesCommand}.
13
17
  */
14
18
  export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a list of traces specified by ID. Each trace is a collection of segment
18
23
  * documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a
19
24
  * list of trace IDs.</p>
@@ -27,6 +32,8 @@ export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param BatchGetTracesCommandInput - {@link BatchGetTracesCommandInput}
36
+ * @returns {@link BatchGetTracesCommandOutput}
30
37
  * @see {@link BatchGetTracesCommandInput} for command's `input` shape.
31
38
  * @see {@link BatchGetTracesCommandOutput} for command's `response` shape.
32
39
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -42,11 +49,20 @@ export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __Met
42
49
  export declare class BatchGetTracesCommand extends $Command<BatchGetTracesCommandInput, BatchGetTracesCommandOutput, XRayClientResolvedConfig> {
43
50
  readonly input: BatchGetTracesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: BatchGetTracesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetTracesCommandInput, BatchGetTracesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateGroupRequest, CreateGroupResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGroupCommand}.
8
10
  */
9
11
  export interface CreateGroupCommandInput extends CreateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGroupCommand}.
13
17
  */
14
18
  export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a group resource with a name and a filter expression. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
34
+ * @returns {@link CreateGroupCommandOutput}
28
35
  * @see {@link CreateGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB
40
47
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: CreateGroupCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: CreateGroupCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSamplingRuleRequest, CreateSamplingRuleResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSamplingRuleCommand}.
8
10
  */
9
11
  export interface CreateSamplingRuleCommandInput extends CreateSamplingRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSamplingRuleCommand}.
13
17
  */
14
18
  export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a rule to control sampling behavior for instrumented applications. Services
18
23
  * retrieve rules with <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a>, and evaluate each rule in ascending
19
24
  * order of <i>priority</i> for each request. If a rule matches, the service
@@ -31,6 +36,8 @@ export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResul
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param CreateSamplingRuleCommandInput - {@link CreateSamplingRuleCommandInput}
40
+ * @returns {@link CreateSamplingRuleCommandOutput}
34
41
  * @see {@link CreateSamplingRuleCommandInput} for command's `input` shape.
35
42
  * @see {@link CreateSamplingRuleCommandOutput} for command's `response` shape.
36
43
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResul
49
56
  export declare class CreateSamplingRuleCommand extends $Command<CreateSamplingRuleCommandInput, CreateSamplingRuleCommandOutput, XRayClientResolvedConfig> {
50
57
  readonly input: CreateSamplingRuleCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateSamplingRuleCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSamplingRuleCommandInput, CreateSamplingRuleCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteGroupRequest, DeleteGroupResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGroupCommand}.
8
10
  */
9
11
  export interface DeleteGroupCommandInput extends DeleteGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGroupCommand}.
13
17
  */
14
18
  export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a group resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
34
+ * @returns {@link DeleteGroupCommandOutput}
28
35
  * @see {@link DeleteGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB
40
47
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: DeleteGroupCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DeleteGroupCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupCommandInput, DeleteGroupCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteResourcePolicyRequest, DeleteResourcePolicyResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteResourcePolicyCommand}.
8
10
  */
9
11
  export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteResourcePolicyCommand}.
13
17
  */
14
18
  export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a resource policy from the target Amazon Web Services account.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
34
+ * @returns {@link DeleteResourcePolicyCommandOutput}
28
35
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
44
51
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, XRayClientResolvedConfig> {
45
52
  readonly input: DeleteResourcePolicyCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteResourcePolicyCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSamplingRuleRequest, DeleteSamplingRuleResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSamplingRuleCommand}.
8
10
  */
9
11
  export interface DeleteSamplingRuleCommandInput extends DeleteSamplingRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSamplingRuleCommand}.
13
17
  */
14
18
  export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a sampling rule.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResul
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteSamplingRuleCommandInput - {@link DeleteSamplingRuleCommandInput}
34
+ * @returns {@link DeleteSamplingRuleCommandOutput}
28
35
  * @see {@link DeleteSamplingRuleCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteSamplingRuleCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResul
40
47
  export declare class DeleteSamplingRuleCommand extends $Command<DeleteSamplingRuleCommandInput, DeleteSamplingRuleCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: DeleteSamplingRuleCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DeleteSamplingRuleCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSamplingRuleCommandInput, DeleteSamplingRuleCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetEncryptionConfigRequest, GetEncryptionConfigResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEncryptionConfigCommand}.
8
10
  */
9
11
  export interface GetEncryptionConfigCommandInput extends GetEncryptionConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEncryptionConfigCommand}.
13
17
  */
14
18
  export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the current encryption configuration for X-Ray data.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEncryptionConfigCommandInput - {@link GetEncryptionConfigCommandInput}
34
+ * @returns {@link GetEncryptionConfigCommandOutput}
28
35
  * @see {@link GetEncryptionConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEncryptionConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigRes
40
47
  export declare class GetEncryptionConfigCommand extends $Command<GetEncryptionConfigCommandInput, GetEncryptionConfigCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: GetEncryptionConfigCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetEncryptionConfigCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEncryptionConfigCommandInput, GetEncryptionConfigCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetGroupRequest, GetGroupResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetGroupCommand}.
8
10
  */
9
11
  export interface GetGroupCommandInput extends GetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetGroupCommand}.
13
17
  */
14
18
  export interface GetGroupCommandOutput extends GetGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves group resource details.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetGroupCommandOutput extends GetGroupResult, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetGroupCommandInput - {@link GetGroupCommandInput}
34
+ * @returns {@link GetGroupCommandOutput}
28
35
  * @see {@link GetGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link GetGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetGroupCommandOutput extends GetGroupResult, __MetadataBearer
40
47
  export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: GetGroupCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetGroupCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGroupCommandInput, GetGroupCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetGroupsRequest, GetGroupsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetGroupsCommand}.
8
10
  */
9
11
  export interface GetGroupsCommandInput extends GetGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetGroupsCommand}.
13
17
  */
14
18
  export interface GetGroupsCommandOutput extends GetGroupsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves all active group details.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetGroupsCommandOutput extends GetGroupsResult, __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetGroupsCommandInput - {@link GetGroupsCommandInput}
34
+ * @returns {@link GetGroupsCommandOutput}
28
35
  * @see {@link GetGroupsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetGroupsCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetGroupsCommandOutput extends GetGroupsResult, __MetadataBeare
40
47
  export declare class GetGroupsCommand extends $Command<GetGroupsCommandInput, GetGroupsCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: GetGroupsCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetGroupsCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGroupsCommandInput, GetGroupsCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetInsightRequest, GetInsightResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInsightCommand}.
8
10
  */
9
11
  export interface GetInsightCommandInput extends GetInsightRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInsightCommand}.
13
17
  */
14
18
  export interface GetInsightCommandOutput extends GetInsightResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the summary information of an insight. This includes impact to clients and
18
23
  * root cause services, the top anomalous services, the category, the state of the insight,
19
24
  * and the start and end time of the insight.</p>
@@ -27,6 +32,8 @@ export interface GetInsightCommandOutput extends GetInsightResult, __MetadataBea
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetInsightCommandInput - {@link GetInsightCommandInput}
36
+ * @returns {@link GetInsightCommandOutput}
30
37
  * @see {@link GetInsightCommandInput} for command's `input` shape.
31
38
  * @see {@link GetInsightCommandOutput} for command's `response` shape.
32
39
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -42,11 +49,20 @@ export interface GetInsightCommandOutput extends GetInsightResult, __MetadataBea
42
49
  export declare class GetInsightCommand extends $Command<GetInsightCommandInput, GetInsightCommandOutput, XRayClientResolvedConfig> {
43
50
  readonly input: GetInsightCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: GetInsightCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInsightCommandInput, GetInsightCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetInsightEventsRequest, GetInsightEventsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInsightEventsCommand}.
8
10
  */
9
11
  export interface GetInsightEventsCommandInput extends GetInsightEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInsightEventsCommand}.
13
17
  */
14
18
  export interface GetInsightEventsCommandOutput extends GetInsightEventsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an
18
23
  * event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray
19
24
  * console.</p>
@@ -27,6 +32,8 @@ export interface GetInsightEventsCommandOutput extends GetInsightEventsResult, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetInsightEventsCommandInput - {@link GetInsightEventsCommandInput}
36
+ * @returns {@link GetInsightEventsCommandOutput}
30
37
  * @see {@link GetInsightEventsCommandInput} for command's `input` shape.
31
38
  * @see {@link GetInsightEventsCommandOutput} for command's `response` shape.
32
39
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -42,11 +49,20 @@ export interface GetInsightEventsCommandOutput extends GetInsightEventsResult, _
42
49
  export declare class GetInsightEventsCommand extends $Command<GetInsightEventsCommandInput, GetInsightEventsCommandOutput, XRayClientResolvedConfig> {
43
50
  readonly input: GetInsightEventsCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: GetInsightEventsCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInsightEventsCommandInput, GetInsightEventsCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetInsightImpactGraphRequest, GetInsightImpactGraphResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInsightImpactGraphCommand}.
8
10
  */
9
11
  export interface GetInsightImpactGraphCommandInput extends GetInsightImpactGraphRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInsightImpactGraphCommand}.
13
17
  */
14
18
  export interface GetInsightImpactGraphCommandOutput extends GetInsightImpactGraphResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only
18
23
  * structural information. For a complete service graph, use this API with the GetServiceGraph API.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetInsightImpactGraphCommandOutput extends GetInsightImpactGrap
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetInsightImpactGraphCommandInput - {@link GetInsightImpactGraphCommandInput}
35
+ * @returns {@link GetInsightImpactGraphCommandOutput}
29
36
  * @see {@link GetInsightImpactGraphCommandInput} for command's `input` shape.
30
37
  * @see {@link GetInsightImpactGraphCommandOutput} for command's `response` shape.
31
38
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -41,11 +48,20 @@ export interface GetInsightImpactGraphCommandOutput extends GetInsightImpactGrap
41
48
  export declare class GetInsightImpactGraphCommand extends $Command<GetInsightImpactGraphCommandInput, GetInsightImpactGraphCommandOutput, XRayClientResolvedConfig> {
42
49
  readonly input: GetInsightImpactGraphCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: GetInsightImpactGraphCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInsightImpactGraphCommandInput, GetInsightImpactGraphCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetInsightSummariesRequest, GetInsightSummariesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInsightSummariesCommand}.
8
10
  */
9
11
  export interface GetInsightSummariesCommandInput extends GetInsightSummariesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInsightSummariesCommand}.
13
17
  */
14
18
  export interface GetInsightSummariesCommandOutput extends GetInsightSummariesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the summaries of all insights in the specified group matching the provided filter values.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetInsightSummariesCommandOutput extends GetInsightSummariesRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetInsightSummariesCommandInput - {@link GetInsightSummariesCommandInput}
34
+ * @returns {@link GetInsightSummariesCommandOutput}
28
35
  * @see {@link GetInsightSummariesCommandInput} for command's `input` shape.
29
36
  * @see {@link GetInsightSummariesCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetInsightSummariesCommandOutput extends GetInsightSummariesRes
40
47
  export declare class GetInsightSummariesCommand extends $Command<GetInsightSummariesCommandInput, GetInsightSummariesCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: GetInsightSummariesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetInsightSummariesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInsightSummariesCommandInput, GetInsightSummariesCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }