@aws-sdk/client-rum 3.934.0 → 3.935.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 (32) hide show
  1. package/README.md +1 -8
  2. package/dist-cjs/index.js +6 -31
  3. package/dist-es/index.js +1 -1
  4. package/dist-es/models/errors.js +153 -0
  5. package/dist-es/models/models_0.js +5 -153
  6. package/dist-es/schemas/schemas_0.js +7 -5
  7. package/dist-types/RUM.d.ts +1 -8
  8. package/dist-types/RUMClient.d.ts +1 -8
  9. package/dist-types/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +1 -41
  10. package/dist-types/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +1 -6
  11. package/dist-types/commands/CreateAppMonitorCommand.d.ts +2 -9
  12. package/dist-types/commands/DeleteRumMetricsDestinationCommand.d.ts +1 -2
  13. package/dist-types/commands/GetAppMonitorCommand.d.ts +1 -0
  14. package/dist-types/commands/GetAppMonitorDataCommand.d.ts +1 -2
  15. package/dist-types/commands/ListAppMonitorsCommand.d.ts +1 -0
  16. package/dist-types/commands/ListRumMetricsDestinationsCommand.d.ts +1 -3
  17. package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -2
  18. package/dist-types/commands/PutRumEventsCommand.d.ts +1 -4
  19. package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts +1 -3
  20. package/dist-types/commands/TagResourceCommand.d.ts +1 -14
  21. package/dist-types/commands/UpdateAppMonitorCommand.d.ts +1 -11
  22. package/dist-types/commands/UpdateRumMetricDefinitionCommand.d.ts +1 -2
  23. package/dist-types/index.d.ts +3 -9
  24. package/dist-types/models/errors.d.ts +178 -0
  25. package/dist-types/models/models_0.d.ts +114 -864
  26. package/dist-types/ts3.4/index.d.ts +2 -1
  27. package/dist-types/ts3.4/models/errors.d.ts +98 -0
  28. package/dist-types/ts3.4/models/models_0.d.ts +11 -101
  29. package/package.json +12 -12
  30. package/dist-es/models/index.js +0 -1
  31. package/dist-types/models/index.d.ts +0 -1
  32. package/dist-types/ts3.4/models/index.d.ts +0 -1
@@ -27,8 +27,7 @@ declare const GetAppMonitorDataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the raw performance events that RUM has collected from your web application,
31
- * so that you can do your own processing or analysis of this data.</p>
30
+ * <p>Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -51,6 +51,7 @@ declare const ListAppMonitorsCommand_base: {
51
51
  * // Created: "STRING_VALUE",
52
52
  * // LastModified: "STRING_VALUE",
53
53
  * // State: "STRING_VALUE",
54
+ * // Platform: "STRING_VALUE",
54
55
  * // },
55
56
  * // ],
56
57
  * // };
@@ -27,9 +27,7 @@ declare const ListRumMetricsDestinationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of destinations that you have created to receive RUM extended metrics,
31
- * for the specified app monitor.</p>
32
- * <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html">AddRumMetrics</a>.</p>
30
+ * <p>Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.</p> <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html">AddRumMetrics</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const PutResourcePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can
31
- * have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html">Using resource-based policies with CloudWatch RUM</a>.</p>
30
+ * <p>Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html">Using resource-based policies with CloudWatch RUM</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,10 +27,7 @@ declare const PutRumEventsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code
31
- * snippet that RUM generates for you to add to your application includes <code>PutRumEvents</code> operations to
32
- * send this data to RUM.</p>
33
- * <p>Each <code>PutRumEvents</code> operation can send a batch of events from one user session.</p>
30
+ * <p>Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes <code>PutRumEvents</code> operations to send this data to RUM.</p> <p>Each <code>PutRumEvents</code> operation can send a batch of events from one user session.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const PutRumMetricsDestinationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send
31
- * extended metrics to CloudWatch or to a CloudWatch Evidently experiment.</p>
32
- * <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html">BatchCreateRumMetricDefinitions</a>.</p>
30
+ * <p>Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.</p> <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html">BatchCreateRumMetricDefinitions</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,20 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently,
31
- * the only resources that
32
- * can be tagged app monitors.</p>
33
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
34
- * permissions by granting a user
35
- * permission to access or change only resources with certain tag values.</p>
36
- * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
37
- * <p>You can use the <code>TagResource</code> action with a resource that already has tags.
38
- * If you specify a new tag key for the resource,
39
- * this tag is appended to the list of tags associated
40
- * with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces
41
- * the previous value for that tag.</p>
42
- * <p>You can associate as many as 50 tags with a resource.</p>
43
- * <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
30
+ * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
44
31
  * @example
45
32
  * Use a bare-bones client and the command you need to make an API call.
46
33
  * ```javascript
@@ -27,17 +27,7 @@ declare const UpdateAppMonitorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor
31
- * configuration that you specify in this operation are changed. For any parameters that you omit, the existing
32
- * values are kept.</p>
33
- * <p>You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use
34
- * <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
35
- * <p>To create a new app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html">CreateAppMonitor</a>.</p>
36
- * <p>After you update an app monitor, sign in to the CloudWatch RUM console to get
37
- * the updated JavaScript code snippet to add to your web application. For more information, see
38
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html">How do I find a code snippet
39
- * that I've already generated?</a>
40
- * </p>
30
+ * <p>Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.</p> <p>You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html">TagResource</a>.</p> <p>To create a new app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html">CreateAppMonitor</a>.</p> <p>After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html">How do I find a code snippet that I've already generated?</a> </p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const UpdateRumMetricDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies one existing metric definition for CloudWatch RUM extended metrics. For
31
- * more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>.</p>
30
+ * <p>Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -1,12 +1,5 @@
1
1
  /**
2
- * <p>With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about
3
- * your web application performance from actual user sessions in real time. The data collected includes page load
4
- * times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and
5
- * also see breakdowns by the browsers and devices that your customers use.</p>
6
- * <p>You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch
7
- * RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error
8
- * messages, stack traces, and user sessions. You can also use RUM to
9
- * understand the range of end-user impact including the number of users, geolocations, and browsers used.</p>
2
+ * <p>With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.</p> <p>You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.</p>
10
3
  *
11
4
  * @packageDocumentation
12
5
  */
@@ -17,5 +10,6 @@ export type { RuntimeExtension } from "./runtimeExtensions";
17
10
  export type { RUMExtensionConfiguration } from "./extensionConfiguration";
18
11
  export * from "./commands";
19
12
  export * from "./pagination";
20
- export * from "./models";
13
+ export * from "./models/errors";
14
+ export type * from "./models/models_0";
21
15
  export { RUMServiceException } from "./models/RUMServiceException";
@@ -0,0 +1,178 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { RUMServiceException as __BaseException } from "./RUMServiceException";
3
+ /**
4
+ * <p>You don't have sufficient permissions to perform this action.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
15
+ /**
16
+ * <p>This operation attempted to create a resource that already exists.</p>
17
+ * @public
18
+ */
19
+ export declare class ConflictException extends __BaseException {
20
+ readonly name: "ConflictException";
21
+ readonly $fault: "client";
22
+ /**
23
+ * <p>The name of the resource that is associated with the error.</p>
24
+ * @public
25
+ */
26
+ resourceName: string | undefined;
27
+ /**
28
+ * <p>The type of the resource that is associated with the error.</p>
29
+ * @public
30
+ */
31
+ resourceType?: string | undefined;
32
+ /**
33
+ * @internal
34
+ */
35
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
36
+ }
37
+ /**
38
+ * <p>Internal service exception.</p>
39
+ * @public
40
+ */
41
+ export declare class InternalServerException extends __BaseException {
42
+ readonly name: "InternalServerException";
43
+ readonly $fault: "server";
44
+ $retryable: {};
45
+ /**
46
+ * <p>The value of a parameter in the request caused an error.</p>
47
+ * @public
48
+ */
49
+ retryAfterSeconds?: number | undefined;
50
+ /**
51
+ * @internal
52
+ */
53
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
54
+ }
55
+ /**
56
+ * <p>Resource not found.</p>
57
+ * @public
58
+ */
59
+ export declare class ResourceNotFoundException extends __BaseException {
60
+ readonly name: "ResourceNotFoundException";
61
+ readonly $fault: "client";
62
+ /**
63
+ * <p>The name of the resource that is associated with the error.</p>
64
+ * @public
65
+ */
66
+ resourceName: string | undefined;
67
+ /**
68
+ * <p>The type of the resource that is associated with the error.</p>
69
+ * @public
70
+ */
71
+ resourceType?: string | undefined;
72
+ /**
73
+ * @internal
74
+ */
75
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
76
+ }
77
+ /**
78
+ * <p>This request exceeds a service quota.</p>
79
+ * @public
80
+ */
81
+ export declare class ServiceQuotaExceededException extends __BaseException {
82
+ readonly name: "ServiceQuotaExceededException";
83
+ readonly $fault: "client";
84
+ /**
85
+ * @internal
86
+ */
87
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
88
+ }
89
+ /**
90
+ * <p>The request was throttled because of quota limits.</p>
91
+ * @public
92
+ */
93
+ export declare class ThrottlingException extends __BaseException {
94
+ readonly name: "ThrottlingException";
95
+ readonly $fault: "client";
96
+ $retryable: {
97
+ throttling: boolean;
98
+ };
99
+ /**
100
+ * <p>The ID of the service that is associated with the error.</p>
101
+ * @public
102
+ */
103
+ serviceCode?: string | undefined;
104
+ /**
105
+ * <p>The ID of the service quota that was exceeded.</p>
106
+ * @public
107
+ */
108
+ quotaCode?: string | undefined;
109
+ /**
110
+ * <p>The value of a parameter in the request caused an error.</p>
111
+ * @public
112
+ */
113
+ retryAfterSeconds?: number | undefined;
114
+ /**
115
+ * @internal
116
+ */
117
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
118
+ }
119
+ /**
120
+ * <p>One of the arguments for the request is not valid.</p>
121
+ * @public
122
+ */
123
+ export declare class ValidationException extends __BaseException {
124
+ readonly name: "ValidationException";
125
+ readonly $fault: "client";
126
+ /**
127
+ * @internal
128
+ */
129
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
130
+ }
131
+ /**
132
+ * <p>The policy revision ID that you provided doeesn't match the latest policy revision ID.</p>
133
+ * @public
134
+ */
135
+ export declare class InvalidPolicyRevisionIdException extends __BaseException {
136
+ readonly name: "InvalidPolicyRevisionIdException";
137
+ readonly $fault: "client";
138
+ /**
139
+ * @internal
140
+ */
141
+ constructor(opts: __ExceptionOptionType<InvalidPolicyRevisionIdException, __BaseException>);
142
+ }
143
+ /**
144
+ * <p>The resource-based policy doesn't exist on this app monitor.</p>
145
+ * @public
146
+ */
147
+ export declare class PolicyNotFoundException extends __BaseException {
148
+ readonly name: "PolicyNotFoundException";
149
+ readonly $fault: "client";
150
+ /**
151
+ * @internal
152
+ */
153
+ constructor(opts: __ExceptionOptionType<PolicyNotFoundException, __BaseException>);
154
+ }
155
+ /**
156
+ * <p>The policy document that you specified is not formatted correctly.</p>
157
+ * @public
158
+ */
159
+ export declare class MalformedPolicyDocumentException extends __BaseException {
160
+ readonly name: "MalformedPolicyDocumentException";
161
+ readonly $fault: "client";
162
+ /**
163
+ * @internal
164
+ */
165
+ constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
166
+ }
167
+ /**
168
+ * <p>The policy document is too large. The limit is 4 KB.</p>
169
+ * @public
170
+ */
171
+ export declare class PolicySizeLimitExceededException extends __BaseException {
172
+ readonly name: "PolicySizeLimitExceededException";
173
+ readonly $fault: "client";
174
+ /**
175
+ * @internal
176
+ */
177
+ constructor(opts: __ExceptionOptionType<PolicySizeLimitExceededException, __BaseException>);
178
+ }