@aws-sdk/client-rum 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 (27) hide show
  1. package/dist-types/RUM.d.ts +18 -0
  2. package/dist-types/RUMClient.d.ts +24 -4
  3. package/dist-types/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchGetRumMetricDefinitionsCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateAppMonitorCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteAppMonitorCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteRumMetricsDestinationCommand.d.ts +16 -0
  9. package/dist-types/commands/GetAppMonitorCommand.d.ts +16 -0
  10. package/dist-types/commands/GetAppMonitorDataCommand.d.ts +16 -0
  11. package/dist-types/commands/ListAppMonitorsCommand.d.ts +16 -0
  12. package/dist-types/commands/ListRumMetricsDestinationsCommand.d.ts +16 -0
  13. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  14. package/dist-types/commands/PutRumEventsCommand.d.ts +16 -0
  15. package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts +16 -0
  16. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  17. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  18. package/dist-types/commands/UpdateAppMonitorCommand.d.ts +16 -0
  19. package/dist-types/commands/UpdateRumMetricDefinitionCommand.d.ts +16 -0
  20. package/dist-types/models/RUMServiceException.d.ts +2 -0
  21. package/dist-types/models/models_0.d.ts +182 -45
  22. package/dist-types/pagination/BatchGetRumMetricDefinitionsPaginator.d.ts +3 -0
  23. package/dist-types/pagination/GetAppMonitorDataPaginator.d.ts +3 -0
  24. package/dist-types/pagination/Interfaces.d.ts +3 -0
  25. package/dist-types/pagination/ListAppMonitorsPaginator.d.ts +3 -0
  26. package/dist-types/pagination/ListRumMetricsDestinationsPaginator.d.ts +3 -0
  27. package/package.json +3 -3
@@ -18,6 +18,7 @@ import { UpdateAppMonitorCommandInput, UpdateAppMonitorCommandOutput } from "./c
18
18
  import { UpdateRumMetricDefinitionCommandInput, UpdateRumMetricDefinitionCommandOutput } from "./commands/UpdateRumMetricDefinitionCommand";
19
19
  import { RUMClient } from "./RUMClient";
20
20
  /**
21
+ * @public
21
22
  * <p>With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about
22
23
  * your web application performance from actual user sessions in real time. The data collected includes page load
23
24
  * times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and
@@ -29,6 +30,7 @@ import { RUMClient } from "./RUMClient";
29
30
  */
30
31
  export declare class RUM extends RUMClient {
31
32
  /**
33
+ * @public
32
34
  * <p>Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
33
35
  * destinations include CloudWatch and Evidently.</p>
34
36
  * <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics
@@ -74,6 +76,7 @@ export declare class RUM extends RUMClient {
74
76
  batchCreateRumMetricDefinitions(args: BatchCreateRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void): void;
75
77
  batchCreateRumMetricDefinitions(args: BatchCreateRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void): void;
76
78
  /**
79
+ * @public
77
80
  * <p>Removes the specified metrics from being sent to an extended metrics destination.</p>
78
81
  * <p>If some metric definition IDs specified in a <code>BatchDeleteRumMetricDefinitions</code> operations are not valid,
79
82
  * those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still
@@ -85,12 +88,14 @@ export declare class RUM extends RUMClient {
85
88
  batchDeleteRumMetricDefinitions(args: BatchDeleteRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void): void;
86
89
  batchDeleteRumMetricDefinitions(args: BatchDeleteRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void): void;
87
90
  /**
91
+ * @public
88
92
  * <p>Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.</p>
89
93
  */
90
94
  batchGetRumMetricDefinitions(args: BatchGetRumMetricDefinitionsCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetRumMetricDefinitionsCommandOutput>;
91
95
  batchGetRumMetricDefinitions(args: BatchGetRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void): void;
92
96
  batchGetRumMetricDefinitions(args: BatchGetRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void): void;
93
97
  /**
98
+ * @public
94
99
  * <p>Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that
95
100
  * data to RUM. The data includes performance and reliability information such as page load time, client-side errors,
96
101
  * and user behavior.</p>
@@ -105,12 +110,14 @@ export declare class RUM extends RUMClient {
105
110
  createAppMonitor(args: CreateAppMonitorCommandInput, cb: (err: any, data?: CreateAppMonitorCommandOutput) => void): void;
106
111
  createAppMonitor(args: CreateAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppMonitorCommandOutput) => void): void;
107
112
  /**
113
+ * @public
108
114
  * <p>Deletes an existing app monitor. This immediately stops the collection of data.</p>
109
115
  */
110
116
  deleteAppMonitor(args: DeleteAppMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAppMonitorCommandOutput>;
111
117
  deleteAppMonitor(args: DeleteAppMonitorCommandInput, cb: (err: any, data?: DeleteAppMonitorCommandOutput) => void): void;
112
118
  deleteAppMonitor(args: DeleteAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppMonitorCommandOutput) => void): void;
113
119
  /**
120
+ * @public
114
121
  * <p>Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops
115
122
  * sending extended metrics to that destination.</p>
116
123
  */
@@ -118,12 +125,14 @@ export declare class RUM extends RUMClient {
118
125
  deleteRumMetricsDestination(args: DeleteRumMetricsDestinationCommandInput, cb: (err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void): void;
119
126
  deleteRumMetricsDestination(args: DeleteRumMetricsDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void): void;
120
127
  /**
128
+ * @public
121
129
  * <p>Retrieves the complete configuration information for one app monitor.</p>
122
130
  */
123
131
  getAppMonitor(args: GetAppMonitorCommandInput, options?: __HttpHandlerOptions): Promise<GetAppMonitorCommandOutput>;
124
132
  getAppMonitor(args: GetAppMonitorCommandInput, cb: (err: any, data?: GetAppMonitorCommandOutput) => void): void;
125
133
  getAppMonitor(args: GetAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppMonitorCommandOutput) => void): void;
126
134
  /**
135
+ * @public
127
136
  * <p>Retrieves the raw performance events that RUM has collected from your web application,
128
137
  * so that you can do your own processing or analysis of this data.</p>
129
138
  */
@@ -131,12 +140,14 @@ export declare class RUM extends RUMClient {
131
140
  getAppMonitorData(args: GetAppMonitorDataCommandInput, cb: (err: any, data?: GetAppMonitorDataCommandOutput) => void): void;
132
141
  getAppMonitorData(args: GetAppMonitorDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppMonitorDataCommandOutput) => void): void;
133
142
  /**
143
+ * @public
134
144
  * <p>Returns a list of the Amazon CloudWatch RUM app monitors in the account.</p>
135
145
  */
136
146
  listAppMonitors(args: ListAppMonitorsCommandInput, options?: __HttpHandlerOptions): Promise<ListAppMonitorsCommandOutput>;
137
147
  listAppMonitors(args: ListAppMonitorsCommandInput, cb: (err: any, data?: ListAppMonitorsCommandOutput) => void): void;
138
148
  listAppMonitors(args: ListAppMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppMonitorsCommandOutput) => void): void;
139
149
  /**
150
+ * @public
140
151
  * <p>Returns a list of destinations that you have created to receive RUM extended metrics,
141
152
  * for the specified app monitor.</p>
142
153
  * <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html">AddRumMetrics</a>.</p>
@@ -145,12 +156,14 @@ export declare class RUM extends RUMClient {
145
156
  listRumMetricsDestinations(args: ListRumMetricsDestinationsCommandInput, cb: (err: any, data?: ListRumMetricsDestinationsCommandOutput) => void): void;
146
157
  listRumMetricsDestinations(args: ListRumMetricsDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRumMetricsDestinationsCommandOutput) => void): void;
147
158
  /**
159
+ * @public
148
160
  * <p>Displays the tags associated with a CloudWatch RUM resource.</p>
149
161
  */
150
162
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
151
163
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
152
164
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
153
165
  /**
166
+ * @public
154
167
  * <p>Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code
155
168
  * snippet that RUM generates for you to add to your application includes <code>PutRumEvents</code> operations to
156
169
  * send this data to RUM.</p>
@@ -160,6 +173,7 @@ export declare class RUM extends RUMClient {
160
173
  putRumEvents(args: PutRumEventsCommandInput, cb: (err: any, data?: PutRumEventsCommandOutput) => void): void;
161
174
  putRumEvents(args: PutRumEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRumEventsCommandOutput) => void): void;
162
175
  /**
176
+ * @public
163
177
  * <p>Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send
164
178
  * extended metrics to CloudWatch or to a CloudWatch Evidently experiment.</p>
165
179
  * <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html">BatchCreateRumMetricDefinitions</a>.</p>
@@ -168,6 +182,7 @@ export declare class RUM extends RUMClient {
168
182
  putRumMetricsDestination(args: PutRumMetricsDestinationCommandInput, cb: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void): void;
169
183
  putRumMetricsDestination(args: PutRumMetricsDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void): void;
170
184
  /**
185
+ * @public
171
186
  * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently,
172
187
  * the only resources that
173
188
  * can be tagged app monitors.</p>
@@ -187,12 +202,14 @@ export declare class RUM extends RUMClient {
187
202
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
188
203
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
189
204
  /**
205
+ * @public
190
206
  * <p>Removes one or more tags from the specified resource.</p>
191
207
  */
192
208
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
193
209
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
194
210
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
195
211
  /**
212
+ * @public
196
213
  * <p>Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor
197
214
  * configuration that you specify in this operation are changed. For any parameters that you omit, the existing
198
215
  * values are kept.</p>
@@ -209,6 +226,7 @@ export declare class RUM extends RUMClient {
209
226
  updateAppMonitor(args: UpdateAppMonitorCommandInput, cb: (err: any, data?: UpdateAppMonitorCommandOutput) => void): void;
210
227
  updateAppMonitor(args: UpdateAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppMonitorCommandOutput) => void): void;
211
228
  /**
229
+ * @public
212
230
  * <p>Modifies one existing metric definition for CloudWatch RUM extended metrics. For
213
231
  * more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>.</p>
214
232
  */
@@ -25,15 +25,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
25
25
  import { UpdateAppMonitorCommandInput, UpdateAppMonitorCommandOutput } from "./commands/UpdateAppMonitorCommand";
26
26
  import { UpdateRumMetricDefinitionCommandInput, UpdateRumMetricDefinitionCommandOutput } from "./commands/UpdateRumMetricDefinitionCommand";
27
27
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
28
+ /**
29
+ * @public
30
+ */
28
31
  export type ServiceInputTypes = BatchCreateRumMetricDefinitionsCommandInput | BatchDeleteRumMetricDefinitionsCommandInput | BatchGetRumMetricDefinitionsCommandInput | CreateAppMonitorCommandInput | DeleteAppMonitorCommandInput | DeleteRumMetricsDestinationCommandInput | GetAppMonitorCommandInput | GetAppMonitorDataCommandInput | ListAppMonitorsCommandInput | ListRumMetricsDestinationsCommandInput | ListTagsForResourceCommandInput | PutRumEventsCommandInput | PutRumMetricsDestinationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAppMonitorCommandInput | UpdateRumMetricDefinitionCommandInput;
32
+ /**
33
+ * @public
34
+ */
29
35
  export type ServiceOutputTypes = BatchCreateRumMetricDefinitionsCommandOutput | BatchDeleteRumMetricDefinitionsCommandOutput | BatchGetRumMetricDefinitionsCommandOutput | CreateAppMonitorCommandOutput | DeleteAppMonitorCommandOutput | DeleteRumMetricsDestinationCommandOutput | GetAppMonitorCommandOutput | GetAppMonitorDataCommandOutput | ListAppMonitorsCommandOutput | ListRumMetricsDestinationsCommandOutput | ListTagsForResourceCommandOutput | PutRumEventsCommandOutput | PutRumMetricsDestinationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAppMonitorCommandOutput | UpdateRumMetricDefinitionCommandOutput;
36
+ /**
37
+ * @public
38
+ */
30
39
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
31
40
  /**
32
41
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
33
42
  */
34
43
  requestHandler?: __HttpHandler;
35
44
  /**
36
- * A constructor for a class implementing the {@link __Checksum} interface
45
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
37
46
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
38
47
  * @internal
39
48
  */
@@ -123,23 +132,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
123
132
  */
124
133
  logger?: __Logger;
125
134
  /**
126
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
135
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
127
136
  */
128
137
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
129
138
  }
139
+ /**
140
+ * @public
141
+ */
130
142
  type RUMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
131
143
  /**
132
- * The configuration interface of RUMClient class constructor that set the region, credentials and other options.
144
+ * @public
145
+ *
146
+ * The configuration interface of RUMClient class constructor that set the region, credentials and other options.
133
147
  */
134
148
  export interface RUMClientConfig extends RUMClientConfigType {
135
149
  }
150
+ /**
151
+ * @public
152
+ */
136
153
  type RUMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
137
154
  /**
138
- * The resolved configuration interface of RUMClient class. This is resolved and normalized from the {@link RUMClientConfig | constructor configuration interface}.
155
+ * @public
156
+ *
157
+ * The resolved configuration interface of RUMClient class. This is resolved and normalized from the {@link RUMClientConfig | constructor configuration interface}.
139
158
  */
140
159
  export interface RUMClientResolvedConfig extends RUMClientResolvedConfigType {
141
160
  }
142
161
  /**
162
+ * @public
143
163
  * <p>With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about
144
164
  * your web application performance from actual user sessions in real time. The data collected includes page load
145
165
  * times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchCreateRumMetricDefinitionsRequest, BatchCreateRumMetricDefinitionsResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchCreateRumMetricDefinitionsCommand}.
8
10
  */
9
11
  export interface BatchCreateRumMetricDefinitionsCommandInput extends BatchCreateRumMetricDefinitionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchCreateRumMetricDefinitionsCommand}.
13
17
  */
14
18
  export interface BatchCreateRumMetricDefinitionsCommandOutput extends BatchCreateRumMetricDefinitionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
18
23
  * destinations include CloudWatch and Evidently.</p>
19
24
  * <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics
@@ -64,6 +69,8 @@ export interface BatchCreateRumMetricDefinitionsCommandOutput extends BatchCreat
64
69
  * const response = await client.send(command);
65
70
  * ```
66
71
  *
72
+ * @param BatchCreateRumMetricDefinitionsCommandInput - {@link BatchCreateRumMetricDefinitionsCommandInput}
73
+ * @returns {@link BatchCreateRumMetricDefinitionsCommandOutput}
67
74
  * @see {@link BatchCreateRumMetricDefinitionsCommandInput} for command's `input` shape.
68
75
  * @see {@link BatchCreateRumMetricDefinitionsCommandOutput} for command's `response` shape.
69
76
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -94,11 +101,20 @@ export interface BatchCreateRumMetricDefinitionsCommandOutput extends BatchCreat
94
101
  export declare class BatchCreateRumMetricDefinitionsCommand extends $Command<BatchCreateRumMetricDefinitionsCommandInput, BatchCreateRumMetricDefinitionsCommandOutput, RUMClientResolvedConfig> {
95
102
  readonly input: BatchCreateRumMetricDefinitionsCommandInput;
96
103
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
104
+ /**
105
+ * @public
106
+ */
97
107
  constructor(input: BatchCreateRumMetricDefinitionsCommandInput);
98
108
  /**
99
109
  * @internal
100
110
  */
101
111
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchCreateRumMetricDefinitionsCommandInput, BatchCreateRumMetricDefinitionsCommandOutput>;
112
+ /**
113
+ * @internal
114
+ */
102
115
  private serialize;
116
+ /**
117
+ * @internal
118
+ */
103
119
  private deserialize;
104
120
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchDeleteRumMetricDefinitionsRequest, BatchDeleteRumMetricDefinitionsResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchDeleteRumMetricDefinitionsCommand}.
8
10
  */
9
11
  export interface BatchDeleteRumMetricDefinitionsCommandInput extends BatchDeleteRumMetricDefinitionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchDeleteRumMetricDefinitionsCommand}.
13
17
  */
14
18
  export interface BatchDeleteRumMetricDefinitionsCommandOutput extends BatchDeleteRumMetricDefinitionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified metrics from being sent to an extended metrics destination.</p>
18
23
  * <p>If some metric definition IDs specified in a <code>BatchDeleteRumMetricDefinitions</code> operations are not valid,
19
24
  * those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still
@@ -30,6 +35,8 @@ export interface BatchDeleteRumMetricDefinitionsCommandOutput extends BatchDelet
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param BatchDeleteRumMetricDefinitionsCommandInput - {@link BatchDeleteRumMetricDefinitionsCommandInput}
39
+ * @returns {@link BatchDeleteRumMetricDefinitionsCommandOutput}
33
40
  * @see {@link BatchDeleteRumMetricDefinitionsCommandInput} for command's `input` shape.
34
41
  * @see {@link BatchDeleteRumMetricDefinitionsCommandOutput} for command's `response` shape.
35
42
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -57,11 +64,20 @@ export interface BatchDeleteRumMetricDefinitionsCommandOutput extends BatchDelet
57
64
  export declare class BatchDeleteRumMetricDefinitionsCommand extends $Command<BatchDeleteRumMetricDefinitionsCommandInput, BatchDeleteRumMetricDefinitionsCommandOutput, RUMClientResolvedConfig> {
58
65
  readonly input: BatchDeleteRumMetricDefinitionsCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: BatchDeleteRumMetricDefinitionsCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteRumMetricDefinitionsCommandInput, BatchDeleteRumMetricDefinitionsCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchGetRumMetricDefinitionsRequest, BatchGetRumMetricDefinitionsResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetRumMetricDefinitionsCommand}.
8
10
  */
9
11
  export interface BatchGetRumMetricDefinitionsCommandInput extends BatchGetRumMetricDefinitionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetRumMetricDefinitionsCommand}.
13
17
  */
14
18
  export interface BatchGetRumMetricDefinitionsCommandOutput extends BatchGetRumMetricDefinitionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.</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 BatchGetRumMetricDefinitionsCommandOutput extends BatchGetRumMe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param BatchGetRumMetricDefinitionsCommandInput - {@link BatchGetRumMetricDefinitionsCommandInput}
34
+ * @returns {@link BatchGetRumMetricDefinitionsCommandOutput}
28
35
  * @see {@link BatchGetRumMetricDefinitionsCommandInput} for command's `input` shape.
29
36
  * @see {@link BatchGetRumMetricDefinitionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -46,11 +53,20 @@ export interface BatchGetRumMetricDefinitionsCommandOutput extends BatchGetRumMe
46
53
  export declare class BatchGetRumMetricDefinitionsCommand extends $Command<BatchGetRumMetricDefinitionsCommandInput, BatchGetRumMetricDefinitionsCommandOutput, RUMClientResolvedConfig> {
47
54
  readonly input: BatchGetRumMetricDefinitionsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: BatchGetRumMetricDefinitionsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetRumMetricDefinitionsCommandInput, BatchGetRumMetricDefinitionsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateAppMonitorRequest, CreateAppMonitorResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAppMonitorCommand}.
8
10
  */
9
11
  export interface CreateAppMonitorCommandInput extends CreateAppMonitorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAppMonitorCommand}.
13
17
  */
14
18
  export interface CreateAppMonitorCommandOutput extends CreateAppMonitorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that
18
23
  * data to RUM. The data includes performance and reliability information such as page load time, client-side errors,
19
24
  * and user behavior.</p>
@@ -33,6 +38,8 @@ export interface CreateAppMonitorCommandOutput extends CreateAppMonitorResponse,
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param CreateAppMonitorCommandInput - {@link CreateAppMonitorCommandInput}
42
+ * @returns {@link CreateAppMonitorCommandOutput}
36
43
  * @see {@link CreateAppMonitorCommandInput} for command's `input` shape.
37
44
  * @see {@link CreateAppMonitorCommandOutput} for command's `response` shape.
38
45
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateAppMonitorCommandOutput extends CreateAppMonitorResponse,
63
70
  export declare class CreateAppMonitorCommand extends $Command<CreateAppMonitorCommandInput, CreateAppMonitorCommandOutput, RUMClientResolvedConfig> {
64
71
  readonly input: CreateAppMonitorCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: CreateAppMonitorCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAppMonitorCommandInput, CreateAppMonitorCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteAppMonitorRequest, DeleteAppMonitorResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAppMonitorCommand}.
8
10
  */
9
11
  export interface DeleteAppMonitorCommandInput extends DeleteAppMonitorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAppMonitorCommand}.
13
17
  */
14
18
  export interface DeleteAppMonitorCommandOutput extends DeleteAppMonitorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an existing app monitor. This immediately stops the collection of 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 DeleteAppMonitorCommandOutput extends DeleteAppMonitorResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAppMonitorCommandInput - {@link DeleteAppMonitorCommandInput}
34
+ * @returns {@link DeleteAppMonitorCommandOutput}
28
35
  * @see {@link DeleteAppMonitorCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAppMonitorCommandOutput} for command's `response` shape.
30
37
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteAppMonitorCommandOutput extends DeleteAppMonitorResponse,
52
59
  export declare class DeleteAppMonitorCommand extends $Command<DeleteAppMonitorCommandInput, DeleteAppMonitorCommandOutput, RUMClientResolvedConfig> {
53
60
  readonly input: DeleteAppMonitorCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteAppMonitorCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAppMonitorCommandInput, DeleteAppMonitorCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteRumMetricsDestinationRequest, DeleteRumMetricsDestinationResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRumMetricsDestinationCommand}.
8
10
  */
9
11
  export interface DeleteRumMetricsDestinationCommandInput extends DeleteRumMetricsDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRumMetricsDestinationCommand}.
13
17
  */
14
18
  export interface DeleteRumMetricsDestinationCommandOutput extends DeleteRumMetricsDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops
18
23
  * sending extended metrics to that destination.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteRumMetricsDestinationCommandOutput extends DeleteRumMetri
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteRumMetricsDestinationCommandInput - {@link DeleteRumMetricsDestinationCommandInput}
35
+ * @returns {@link DeleteRumMetricsDestinationCommandOutput}
29
36
  * @see {@link DeleteRumMetricsDestinationCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteRumMetricsDestinationCommandOutput} for command's `response` shape.
31
38
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteRumMetricsDestinationCommandOutput extends DeleteRumMetri
53
60
  export declare class DeleteRumMetricsDestinationCommand extends $Command<DeleteRumMetricsDestinationCommandInput, DeleteRumMetricsDestinationCommandOutput, RUMClientResolvedConfig> {
54
61
  readonly input: DeleteRumMetricsDestinationCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeleteRumMetricsDestinationCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRumMetricsDestinationCommandInput, DeleteRumMetricsDestinationCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetAppMonitorRequest, GetAppMonitorResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAppMonitorCommand}.
8
10
  */
9
11
  export interface GetAppMonitorCommandInput extends GetAppMonitorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAppMonitorCommand}.
13
17
  */
14
18
  export interface GetAppMonitorCommandOutput extends GetAppMonitorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the complete configuration information for one app monitor.</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 GetAppMonitorCommandOutput extends GetAppMonitorResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetAppMonitorCommandInput - {@link GetAppMonitorCommandInput}
34
+ * @returns {@link GetAppMonitorCommandOutput}
28
35
  * @see {@link GetAppMonitorCommandInput} for command's `input` shape.
29
36
  * @see {@link GetAppMonitorCommandOutput} for command's `response` shape.
30
37
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetAppMonitorCommandOutput extends GetAppMonitorResponse, __Met
49
56
  export declare class GetAppMonitorCommand extends $Command<GetAppMonitorCommandInput, GetAppMonitorCommandOutput, RUMClientResolvedConfig> {
50
57
  readonly input: GetAppMonitorCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetAppMonitorCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAppMonitorCommandInput, GetAppMonitorCommandOutput>;
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 { GetAppMonitorDataRequest, GetAppMonitorDataResponse } from "../models/models_0";
5
5
  import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAppMonitorDataCommand}.
8
10
  */
9
11
  export interface GetAppMonitorDataCommandInput extends GetAppMonitorDataRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAppMonitorDataCommand}.
13
17
  */
14
18
  export interface GetAppMonitorDataCommandOutput extends GetAppMonitorDataResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the raw performance events that RUM has collected from your web application,
18
23
  * so that you can do your own processing or analysis of this data.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetAppMonitorDataCommandOutput extends GetAppMonitorDataRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetAppMonitorDataCommandInput - {@link GetAppMonitorDataCommandInput}
35
+ * @returns {@link GetAppMonitorDataCommandOutput}
29
36
  * @see {@link GetAppMonitorDataCommandInput} for command's `input` shape.
30
37
  * @see {@link GetAppMonitorDataCommandOutput} for command's `response` shape.
31
38
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetAppMonitorDataCommandOutput extends GetAppMonitorDataRespons
50
57
  export declare class GetAppMonitorDataCommand extends $Command<GetAppMonitorDataCommandInput, GetAppMonitorDataCommandOutput, RUMClientResolvedConfig> {
51
58
  readonly input: GetAppMonitorDataCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetAppMonitorDataCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAppMonitorDataCommandInput, GetAppMonitorDataCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }