@aws-sdk/client-xray 3.296.0 → 3.297.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 (48) hide show
  1. package/dist-types/XRay.d.ts +31 -0
  2. package/dist-types/XRayClient.d.ts +24 -4
  3. package/dist-types/commands/BatchGetTracesCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateSamplingRuleCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteSamplingRuleCommand.d.ts +16 -0
  9. package/dist-types/commands/GetEncryptionConfigCommand.d.ts +16 -0
  10. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  11. package/dist-types/commands/GetGroupsCommand.d.ts +16 -0
  12. package/dist-types/commands/GetInsightCommand.d.ts +16 -0
  13. package/dist-types/commands/GetInsightEventsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetInsightImpactGraphCommand.d.ts +16 -0
  15. package/dist-types/commands/GetInsightSummariesCommand.d.ts +16 -0
  16. package/dist-types/commands/GetSamplingRulesCommand.d.ts +16 -0
  17. package/dist-types/commands/GetSamplingStatisticSummariesCommand.d.ts +16 -0
  18. package/dist-types/commands/GetSamplingTargetsCommand.d.ts +16 -0
  19. package/dist-types/commands/GetServiceGraphCommand.d.ts +16 -0
  20. package/dist-types/commands/GetTimeSeriesServiceStatisticsCommand.d.ts +16 -0
  21. package/dist-types/commands/GetTraceGraphCommand.d.ts +16 -0
  22. package/dist-types/commands/GetTraceSummariesCommand.d.ts +16 -0
  23. package/dist-types/commands/ListResourcePoliciesCommand.d.ts +16 -0
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/PutEncryptionConfigCommand.d.ts +16 -0
  26. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  27. package/dist-types/commands/PutTelemetryRecordsCommand.d.ts +16 -0
  28. package/dist-types/commands/PutTraceSegmentsCommand.d.ts +16 -0
  29. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  30. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateSamplingRuleCommand.d.ts +16 -0
  33. package/dist-types/models/XRayServiceException.d.ts +2 -0
  34. package/dist-types/models/models_0.d.ts +266 -0
  35. package/dist-types/pagination/BatchGetTracesPaginator.d.ts +3 -0
  36. package/dist-types/pagination/GetGroupsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/GetInsightEventsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/GetInsightSummariesPaginator.d.ts +3 -0
  39. package/dist-types/pagination/GetSamplingRulesPaginator.d.ts +3 -0
  40. package/dist-types/pagination/GetSamplingStatisticSummariesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/GetServiceGraphPaginator.d.ts +3 -0
  42. package/dist-types/pagination/GetTimeSeriesServiceStatisticsPaginator.d.ts +3 -0
  43. package/dist-types/pagination/GetTraceGraphPaginator.d.ts +3 -0
  44. package/dist-types/pagination/GetTraceSummariesPaginator.d.ts +3 -0
  45. package/dist-types/pagination/Interfaces.d.ts +3 -0
  46. package/dist-types/pagination/ListResourcePoliciesPaginator.d.ts +3 -0
  47. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  48. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListResourcePoliciesRequest, ListResourcePoliciesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListResourcePoliciesCommand}.
8
10
  */
9
11
  export interface ListResourcePoliciesCommandInput extends ListResourcePoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListResourcePoliciesCommand}.
13
17
  */
14
18
  export interface ListResourcePoliciesCommandOutput extends ListResourcePoliciesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the list of resource policies in 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 ListResourcePoliciesCommandOutput extends ListResourcePoliciesR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListResourcePoliciesCommandInput - {@link ListResourcePoliciesCommandInput}
34
+ * @returns {@link ListResourcePoliciesCommandOutput}
28
35
  * @see {@link ListResourcePoliciesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListResourcePoliciesCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface ListResourcePoliciesCommandOutput extends ListResourcePoliciesR
40
47
  export declare class ListResourcePoliciesCommand extends $Command<ListResourcePoliciesCommandInput, ListResourcePoliciesCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: ListResourcePoliciesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: ListResourcePoliciesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListResourcePoliciesCommandInput, ListResourcePoliciesCommandOutput>;
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 { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or 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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
44
51
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, XRayClientResolvedConfig> {
45
52
  readonly input: ListTagsForResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListTagsForResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
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 { PutEncryptionConfigRequest, PutEncryptionConfigResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutEncryptionConfigCommand}.
8
10
  */
9
11
  export interface PutEncryptionConfigCommandInput extends PutEncryptionConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutEncryptionConfigCommand}.
13
17
  */
14
18
  export interface PutEncryptionConfigCommandOutput extends PutEncryptionConfigResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the 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 PutEncryptionConfigCommandOutput extends PutEncryptionConfigRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutEncryptionConfigCommandInput - {@link PutEncryptionConfigCommandInput}
34
+ * @returns {@link PutEncryptionConfigCommandOutput}
28
35
  * @see {@link PutEncryptionConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link PutEncryptionConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface PutEncryptionConfigCommandOutput extends PutEncryptionConfigRes
40
47
  export declare class PutEncryptionConfigCommand extends $Command<PutEncryptionConfigCommandInput, PutEncryptionConfigCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: PutEncryptionConfigCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: PutEncryptionConfigCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEncryptionConfigCommandInput, PutEncryptionConfigCommandOutput>;
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 { PutResourcePolicyRequest, PutResourcePolicyResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutResourcePolicyCommand}.
8
10
  */
9
11
  export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutResourcePolicyCommand}.
13
17
  */
14
18
  export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to
19
24
  * access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account.
@@ -30,6 +35,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResult,
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
39
+ * @returns {@link PutResourcePolicyCommandOutput}
33
40
  * @see {@link PutResourcePolicyCommandInput} for command's `input` shape.
34
41
  * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
35
42
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -58,11 +65,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResult,
58
65
  export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, XRayClientResolvedConfig> {
59
66
  readonly input: PutResourcePolicyCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: PutResourcePolicyCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutTelemetryRecordsRequest, PutTelemetryRecordsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutTelemetryRecordsCommand}.
8
10
  */
9
11
  export interface PutTelemetryRecordsCommandInput extends PutTelemetryRecordsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutTelemetryRecordsCommand}.
13
17
  */
14
18
  export interface PutTelemetryRecordsCommandOutput extends PutTelemetryRecordsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Used by the Amazon Web Services X-Ray daemon to upload telemetry.</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 PutTelemetryRecordsCommandOutput extends PutTelemetryRecordsRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutTelemetryRecordsCommandInput - {@link PutTelemetryRecordsCommandInput}
34
+ * @returns {@link PutTelemetryRecordsCommandOutput}
28
35
  * @see {@link PutTelemetryRecordsCommandInput} for command's `input` shape.
29
36
  * @see {@link PutTelemetryRecordsCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface PutTelemetryRecordsCommandOutput extends PutTelemetryRecordsRes
40
47
  export declare class PutTelemetryRecordsCommand extends $Command<PutTelemetryRecordsCommandInput, PutTelemetryRecordsCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: PutTelemetryRecordsCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: PutTelemetryRecordsCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutTelemetryRecordsCommandInput, PutTelemetryRecordsCommandOutput>;
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 { PutTraceSegmentsRequest, PutTraceSegmentsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutTraceSegmentsCommand}.
8
10
  */
9
11
  export interface PutTraceSegmentsCommandInput extends PutTraceSegmentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutTraceSegmentsCommand}.
13
17
  */
14
18
  export interface PutTraceSegmentsCommandOutput extends PutTraceSegmentsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Uploads segment documents to Amazon Web Services X-Ray. The <a href="https://docs.aws.amazon.com/xray/index.html">X-Ray SDK</a> generates segment documents and sends them to the X-Ray daemon, which uploads them in
18
23
  * batches. A segment document can be a completed segment, an in-progress segment, or an array of
19
24
  * subsegments.</p>
@@ -87,6 +92,8 @@ export interface PutTraceSegmentsCommandOutput extends PutTraceSegmentsResult, _
87
92
  * const response = await client.send(command);
88
93
  * ```
89
94
  *
95
+ * @param PutTraceSegmentsCommandInput - {@link PutTraceSegmentsCommandInput}
96
+ * @returns {@link PutTraceSegmentsCommandOutput}
90
97
  * @see {@link PutTraceSegmentsCommandInput} for command's `input` shape.
91
98
  * @see {@link PutTraceSegmentsCommandOutput} for command's `response` shape.
92
99
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -102,11 +109,20 @@ export interface PutTraceSegmentsCommandOutput extends PutTraceSegmentsResult, _
102
109
  export declare class PutTraceSegmentsCommand extends $Command<PutTraceSegmentsCommandInput, PutTraceSegmentsCommandOutput, XRayClientResolvedConfig> {
103
110
  readonly input: PutTraceSegmentsCommandInput;
104
111
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
112
+ /**
113
+ * @public
114
+ */
105
115
  constructor(input: PutTraceSegmentsCommandInput);
106
116
  /**
107
117
  * @internal
108
118
  */
109
119
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutTraceSegmentsCommandInput, PutTraceSegmentsCommandOutput>;
120
+ /**
121
+ * @internal
122
+ */
110
123
  private serialize;
124
+ /**
125
+ * @internal
126
+ */
111
127
  private deserialize;
112
128
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Applies tags to an existing Amazon Web Services X-Ray group or 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 TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -47,11 +54,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
47
54
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, XRayClientResolvedConfig> {
48
55
  readonly input: TagResourceCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: TagResourceCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system
18
23
  * tags (those with an <code>aws:</code> prefix).</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
35
+ * @returns {@link UntagResourceCommandOutput}
29
36
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -45,11 +52,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
45
52
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, XRayClientResolvedConfig> {
46
53
  readonly input: UntagResourceCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: UntagResourceCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateGroupRequest, UpdateGroupResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGroupCommand}.
8
10
  */
9
11
  export interface UpdateGroupCommandInput extends UpdateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGroupCommand}.
13
17
  */
14
18
  export interface UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates 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 UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateGroupCommandInput - {@link UpdateGroupCommandInput}
34
+ * @returns {@link UpdateGroupCommandOutput}
28
35
  * @see {@link UpdateGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataB
40
47
  export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: UpdateGroupCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: UpdateGroupCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGroupCommandInput, UpdateGroupCommandOutput>;
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 { UpdateSamplingRuleRequest, UpdateSamplingRuleResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateSamplingRuleCommand}.
8
10
  */
9
11
  export interface UpdateSamplingRuleCommandInput extends UpdateSamplingRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateSamplingRuleCommand}.
13
17
  */
14
18
  export interface UpdateSamplingRuleCommandOutput extends UpdateSamplingRuleResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies a sampling rule's configuration.</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 UpdateSamplingRuleCommandOutput extends UpdateSamplingRuleResul
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateSamplingRuleCommandInput - {@link UpdateSamplingRuleCommandInput}
34
+ * @returns {@link UpdateSamplingRuleCommandOutput}
28
35
  * @see {@link UpdateSamplingRuleCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateSamplingRuleCommandOutput} for command's `response` shape.
30
37
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface UpdateSamplingRuleCommandOutput extends UpdateSamplingRuleResul
40
47
  export declare class UpdateSamplingRuleCommand extends $Command<UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput, XRayClientResolvedConfig> {
41
48
  readonly input: UpdateSamplingRuleCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: UpdateSamplingRuleCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from XRay service.
4
6
  */
5
7
  export declare class XRayServiceException extends __ServiceException {