@aws-sdk/client-rum 3.379.1 → 3.385.0

package/dist-types/models/models_0.d.ts

@@ -40,26 +40,31 @@ export type Telemetry = (typeof Telemetry)[keyof typeof Telemetry];
  */
 export interface AppMonitorConfiguration {
     /**
+     * @public
      * <p>The ID of the Amazon Cognito identity pool
      *          that is used to authorize the sending of data to RUM.</p>
      */
     IdentityPoolId?: string;
     /**
+     * @public
      * <p>A list of URLs in your website or application to exclude from RUM data collection.</p>
      *          <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
      */
     ExcludedPages?: string[];
     /**
+     * @public
      * <p>If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. </p>
      *          <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
      */
     IncludedPages?: string[];
     /**
+     * @public
      * <p>A list of pages in your application that are to be displayed with a "favorite" icon
      *          in the CloudWatch RUM console.</p>
      */
     FavoritePages?: string[];
     /**
+     * @public
      * <p>Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you
      *       more data but also incurs more costs.</p>
      *          <p>The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting
@@ -68,11 +73,13 @@ export interface AppMonitorConfiguration {
      */
     SessionSampleRate?: number;
     /**
+     * @public
      * <p>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool
      *       that is used to authorize the sending of data to RUM.</p>
      */
     GuestRoleArn?: string;
     /**
+     * @public
      * <p>If you set this to <code>true</code>, the RUM web client sets two cookies, a session
      *          cookie and a user cookie. The cookies allow the RUM web client to collect data relating to
      *          the number of users an application has and the behavior of the application across a
@@ -80,6 +87,7 @@ export interface AppMonitorConfiguration {
      */
     AllowCookies?: boolean;
     /**
+     * @public
      * <p>An array that lists the types of telemetry data that this app monitor is to collect.</p>
      *          <ul>
      *             <li>
@@ -100,6 +108,7 @@ export interface AppMonitorConfiguration {
      */
     Telemetries?: (Telemetry | string)[];
     /**
+     * @public
      * <p>If you set this to <code>true</code>, RUM enables X-Ray tracing for
      *          the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed
      *          HTTP requests. It also records an X-Ray segment for allowed HTTP requests.
@@ -127,6 +136,7 @@ export type CustomEventsStatus = (typeof CustomEventsStatus)[keyof typeof Custom
  */
 export interface CustomEvents {
     /**
+     * @public
      * <p>Specifies whether this app monitor allows the web client to define and send
      *          custom events. The default is for custom events to be <code>DISABLED</code>.</p>
      */
@@ -139,11 +149,13 @@ export interface CustomEvents {
  */
 export interface CwLog {
     /**
+     * @public
      * <p>Indicated whether the app monitor stores copies of the data
      *          that RUM collects in CloudWatch Logs.</p>
      */
     CwLogEnabled?: boolean;
     /**
+     * @public
      * <p>The name of the log group where the copies are stored.</p>
      */
     CwLogGroup?: string;
@@ -155,6 +167,7 @@ export interface CwLog {
  */
 export interface DataStorage {
     /**
+     * @public
      * <p>A structure that contains the information about whether the app monitor stores copies of the data
      *          that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.</p>
      */
@@ -181,43 +194,53 @@ export type StateEnum = (typeof StateEnum)[keyof typeof StateEnum];
  */
 export interface AppMonitor {
     /**
+     * @public
      * <p>The name of the app monitor.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The top-level internet domain name for which your application has administrative authority.</p>
      */
     Domain?: string;
     /**
+     * @public
      * <p>The unique ID of this app monitor.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The date and time that this app monitor was created.</p>
      */
     Created?: string;
     /**
+     * @public
      * <p>The date and time of the most recent changes to this app monitor's configuration.</p>
      */
     LastModified?: string;
     /**
+     * @public
      * <p>The list of tag keys and values associated with this app monitor.</p>
      */
     Tags?: Record<string, string>;
     /**
+     * @public
      * <p>The current state of the app monitor.</p>
      */
     State?: StateEnum | string;
     /**
+     * @public
      * <p>A structure that contains much of the configuration data for the app monitor.</p>
      */
     AppMonitorConfiguration?: AppMonitorConfiguration;
     /**
+     * @public
      * <p>A structure that contains information about whether this app monitor stores a copy of
      *          the telemetry data that RUM collects using CloudWatch Logs.</p>
      */
     DataStorage?: DataStorage;
     /**
+     * @public
      * <p>Specifies whether this app monitor allows the web client to define and send
      *       custom events.</p>
      *          <p>For more information about custom events, see
@@ -231,14 +254,17 @@ export interface AppMonitor {
  */
 export interface AppMonitorDetails {
     /**
+     * @public
      * <p>The name of the app monitor.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The unique ID of the app monitor.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The version of the app monitor.</p>
      */
     version?: string;
@@ -482,6 +508,7 @@ export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDe
  */
 export interface MetricDefinitionRequest {
     /**
+     * @public
      * <p>The name for the metric that is defined in this structure. For custom metrics, you can specify
      *          any name that you like. For extended metrics, valid values are the following:</p>
      *          <ul>
@@ -545,6 +572,7 @@ export interface MetricDefinitionRequest {
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>The field within the event object that the metric value is sourced from.</p>
      *          <p>If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you
      *          just want to count the number of events that the filter catches. </p>
@@ -553,11 +581,13 @@ export interface MetricDefinitionRequest {
      */
     ValueKey?: string;
     /**
+     * @public
      * <p>The CloudWatch metric unit to use for this metric. If you omit this field, the metric
      *       is recorded with no unit.</p>
      */
     UnitLabel?: string;
     /**
+     * @public
      * <p>Use this field only if you are sending the metric to CloudWatch.</p>
      *          <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
      *          metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:</p>
@@ -599,6 +629,7 @@ export interface MetricDefinitionRequest {
      */
     DimensionKeys?: Record<string, string>;
     /**
+     * @public
      * <p>The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session
      *          against the pattern, and events that match the pattern are sent to the metric destination.</p>
      *          <p>When you define extended metrics, the metric definition is not valid if <code>EventPattern</code>
@@ -651,6 +682,7 @@ export interface MetricDefinitionRequest {
      */
     EventPattern?: string;
     /**
+     * @public
      * <p>If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
      *          metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.</p>
      *          <p>You cannot use any string that starts with <code>AWS/</code> for your namespace.</p>
@@ -662,10 +694,12 @@ export interface MetricDefinitionRequest {
  */
 export interface BatchCreateRumMetricDefinitionsRequest {
     /**
+     * @public
      * <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
      *          you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
      *          that will receive
@@ -673,6 +707,7 @@ export interface BatchCreateRumMetricDefinitionsRequest {
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter.</p>
      *          <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
@@ -680,6 +715,7 @@ export interface BatchCreateRumMetricDefinitionsRequest {
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>An array of structures which define the metrics that you want to send.</p>
      */
     MetricDefinitions: MetricDefinitionRequest[] | undefined;
@@ -692,14 +728,17 @@ export interface BatchCreateRumMetricDefinitionsRequest {
  */
 export interface BatchCreateRumMetricDefinitionsError {
     /**
+     * @public
      * <p>The metric definition that caused this error.</p>
      */
     MetricDefinition: MetricDefinitionRequest | undefined;
     /**
+     * @public
      * <p>The error code.</p>
      */
     ErrorCode: string | undefined;
     /**
+     * @public
      * <p>The error message for this metric definition.</p>
      */
     ErrorMessage: string | undefined;
@@ -713,29 +752,35 @@ export interface BatchCreateRumMetricDefinitionsError {
  */
 export interface MetricDefinition {
     /**
+     * @public
      * <p>The ID of this metric definition.</p>
      */
     MetricDefinitionId: string | undefined;
     /**
+     * @public
      * <p>The name of the metric that is defined in this structure.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>The field within the event object that the metric value is sourced from.</p>
      */
     ValueKey?: string;
     /**
+     * @public
      * <p>Use this field only if you are sending this metric to CloudWatch. It defines
      *          the CloudWatch metric unit that this metric is measured in. </p>
      */
     UnitLabel?: string;
     /**
+     * @public
      * <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
      *          metric in CloudWatch The value of this field is used only if the metric destination is <code>CloudWatch</code>.
      *          If the metric destination is <code>Evidently</code>, the value of <code>DimensionKeys</code> is ignored.</p>
      */
     DimensionKeys?: Record<string, string>;
     /**
+     * @public
      * <p>The pattern that defines the metric. RUM checks events that happen in a user's session
      *       against the pattern, and events that match the pattern are sent to the metric destination.</p>
      *          <p>If the metrics destination
@@ -744,6 +789,7 @@ export interface MetricDefinition {
      */
     EventPattern?: string;
     /**
+     * @public
      * <p>If this metric definition is for a custom metric instead of an extended metric, this field displays
      *       the metric namespace that the custom metric is published to.</p>
      */
@@ -754,10 +800,12 @@ export interface MetricDefinition {
  */
 export interface BatchCreateRumMetricDefinitionsResponse {
     /**
+     * @public
      * <p>An array of error objects, if the operation caused any errors.</p>
      */
     Errors: BatchCreateRumMetricDefinitionsError[] | undefined;
     /**
+     * @public
      * <p>An array of structures that define the extended metrics.</p>
      */
     MetricDefinitions?: MetricDefinition[];
@@ -770,10 +818,12 @@ export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The name of the resource that is associated with the error.</p>
      */
     resourceName: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that is associated with the error.</p>
      */
     resourceType?: string;
@@ -791,6 +841,7 @@ export declare class InternalServerException extends __BaseException {
     readonly $fault: "server";
     $retryable: {};
     /**
+     * @public
      * <p>The value of a parameter in the request caused an error.</p>
      */
     retryAfterSeconds?: number;
@@ -807,10 +858,12 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The name of the resource that is associated with the error.</p>
      */
     resourceName: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that is associated with the error.</p>
      */
     resourceType?: string;
@@ -842,14 +895,17 @@ export declare class ThrottlingException extends __BaseException {
         throttling: boolean;
     };
     /**
+     * @public
      * <p>The ID of the service that is associated with the error.</p>
      */
     serviceCode?: string;
     /**
+     * @public
      * <p>The ID of the service quota that was exceeded.</p>
      */
     quotaCode?: string;
     /**
+     * @public
      * <p>The value of a parameter in the request caused an error.</p>
      */
     retryAfterSeconds?: number;
@@ -875,10 +931,12 @@ export declare class ValidationException extends __BaseException {
  */
 export interface BatchDeleteRumMetricDefinitionsRequest {
     /**
+     * @public
      * <p>The name of the CloudWatch RUM app monitor that is sending these metrics.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>Defines the destination where you want to stop sending the specified metrics. Valid values are <code>CloudWatch</code> and
      *          <code>Evidently</code>. If
      *          you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
@@ -886,6 +944,7 @@ export interface BatchDeleteRumMetricDefinitionsRequest {
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter. </p>
      *          <p>This parameter specifies
@@ -893,6 +952,7 @@ export interface BatchDeleteRumMetricDefinitionsRequest {
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>An array of structures which define the metrics that you want to stop sending.</p>
      */
     MetricDefinitionIds: string[] | undefined;
@@ -905,14 +965,17 @@ export interface BatchDeleteRumMetricDefinitionsRequest {
  */
 export interface BatchDeleteRumMetricDefinitionsError {
     /**
+     * @public
      * <p>The ID of the metric definition that caused this error.</p>
      */
     MetricDefinitionId: string | undefined;
     /**
+     * @public
      * <p>The error code.</p>
      */
     ErrorCode: string | undefined;
     /**
+     * @public
      * <p>The error message for this metric definition.</p>
      */
     ErrorMessage: string | undefined;
@@ -922,10 +985,12 @@ export interface BatchDeleteRumMetricDefinitionsError {
  */
 export interface BatchDeleteRumMetricDefinitionsResponse {
     /**
+     * @public
      * <p>An array of error objects, if the operation caused any errors.</p>
      */
     Errors: BatchDeleteRumMetricDefinitionsError[] | undefined;
     /**
+     * @public
      * <p>The IDs of the metric definitions that were deleted.</p>
      */
     MetricDefinitionIds?: string[];
@@ -935,15 +1000,18 @@ export interface BatchDeleteRumMetricDefinitionsResponse {
  */
 export interface BatchGetRumMetricDefinitionsRequest {
     /**
+     * @public
      * <p>The name of the CloudWatch RUM app monitor that is sending the metrics.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>The type of destination that you want to view metrics for. Valid values are <code>CloudWatch</code>
      *          and <code>Evidently</code>.</p>
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter.</p>
      *          <p>This parameter
@@ -951,6 +1019,7 @@ export interface BatchGetRumMetricDefinitionsRequest {
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
      *          specify is 100.</p>
      *          <p>To retrieve the remaining results, make another call with the returned
@@ -958,6 +1027,7 @@ export interface BatchGetRumMetricDefinitionsRequest {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>Use the token returned by the previous operation to request the next page of results.</p>
      */
     NextToken?: string;
@@ -967,11 +1037,13 @@ export interface BatchGetRumMetricDefinitionsRequest {
  */
 export interface BatchGetRumMetricDefinitionsResponse {
     /**
+     * @public
      * <p>An array of structures that display information about the metrics that are sent by the specified
      *          app monitor to the specified destination.</p>
      */
     MetricDefinitions?: MetricDefinition[];
     /**
+     * @public
      * <p>A token that you can use in a subsequent operation to
      *          retrieve the next set of results.</p>
      */
@@ -982,14 +1054,17 @@ export interface BatchGetRumMetricDefinitionsResponse {
  */
 export interface CreateAppMonitorRequest {
     /**
+     * @public
      * <p>A name for the app monitor.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>The top-level internet domain name for which your application has administrative authority.</p>
      */
     Domain: string | undefined;
     /**
+     * @public
      * <p>Assigns one or more tags (key-value pairs) to the app monitor.</p>
      *          <p>Tags can help you organize and categorize your resources. You can also use them to scope user
      *          permissions by granting a user
@@ -1000,6 +1075,7 @@ export interface CreateAppMonitorRequest {
      */
     Tags?: Record<string, string>;
     /**
+     * @public
      * <p>A structure that contains much of the configuration data for the app monitor. If you are using
      *          Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
      *          Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
@@ -1010,6 +1086,7 @@ export interface CreateAppMonitorRequest {
      */
     AppMonitorConfiguration?: AppMonitorConfiguration;
     /**
+     * @public
      * <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
      *          sends a copy of this telemetry data to Amazon CloudWatch Logs
      *          in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
@@ -1018,6 +1095,7 @@ export interface CreateAppMonitorRequest {
      */
     CwLogEnabled?: boolean;
     /**
+     * @public
      * <p>Specifies whether this app monitor allows the web client to define and send
      *          custom events. If you omit this parameter, custom events are <code>DISABLED</code>.</p>
      *          <p>For more information about custom events, see
@@ -1030,6 +1108,7 @@ export interface CreateAppMonitorRequest {
  */
 export interface CreateAppMonitorResponse {
     /**
+     * @public
      * <p>The unique ID of the new app monitor.</p>
      */
     Id?: string;
@@ -1039,6 +1118,7 @@ export interface CreateAppMonitorResponse {
  */
 export interface DeleteAppMonitorRequest {
     /**
+     * @public
      * <p>The name of the app monitor to delete.</p>
      */
     Name: string | undefined;
@@ -1053,14 +1133,17 @@ export interface DeleteAppMonitorResponse {
  */
 export interface DeleteRumMetricsDestinationRequest {
     /**
+     * @public
      * <p>The name of the app monitor that is sending metrics to the destination that you want to delete.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>The type of destination to delete. Valid values are <code>CloudWatch</code> and <code>Evidently</code>.</p>
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter. This parameter
      *          specifies the ARN of the Evidently experiment that corresponds to the destination to delete.</p>
@@ -1077,6 +1160,7 @@ export interface DeleteRumMetricsDestinationResponse {
  */
 export interface GetAppMonitorRequest {
     /**
+     * @public
      * <p>The app monitor to retrieve information for.</p>
      */
     Name: string | undefined;
@@ -1086,6 +1170,7 @@ export interface GetAppMonitorRequest {
  */
 export interface GetAppMonitorResponse {
     /**
+     * @public
      * <p>A structure containing all the configuration information for the app monitor.</p>
      */
     AppMonitor?: AppMonitor;
@@ -1105,6 +1190,7 @@ export interface GetAppMonitorResponse {
  */
 export interface QueryFilter {
     /**
+     * @public
      * <p>The name of a key to search for.
      *       The filter returns only the events that match the <code>Name</code>
      *          and <code>Values</code> that you specify.
@@ -1115,6 +1201,7 @@ export interface QueryFilter {
      */
     Name?: string;
     /**
+     * @public
      * <p>The values of the <code>Name</code> that are to be be included in the returned results.</p>
      */
     Values?: string[];
@@ -1125,10 +1212,12 @@ export interface QueryFilter {
  */
 export interface TimeRange {
     /**
+     * @public
      * <p>The beginning of the time range to retrieve performance events from.</p>
      */
     After: number | undefined;
     /**
+     * @public
      * <p>The end of the time range to retrieve performance events from. If you omit this, the time
      *       range extends to the time that this operation is performed.</p>
      */
@@ -1139,23 +1228,28 @@ export interface TimeRange {
  */
 export interface GetAppMonitorDataRequest {
     /**
+     * @public
      * <p>The name of the app monitor that collected the data that you want to retrieve.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>A structure that defines the time range that you want to retrieve results from.</p>
      */
     TimeRange: TimeRange | undefined;
     /**
+     * @public
      * <p>An array of structures that you can use to filter the results to those that match one or
      *          more sets of key-value pairs that you specify.</p>
      */
     Filters?: QueryFilter[];
     /**
+     * @public
      * <p>The maximum number of results to return in one operation. </p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>Use the token returned by the previous operation to request the next page of results.</p>
      */
     NextToken?: string;
@@ -1165,10 +1259,12 @@ export interface GetAppMonitorDataRequest {
  */
 export interface GetAppMonitorDataResponse {
     /**
+     * @public
      * <p>The events that RUM collected that match your request.</p>
      */
     Events?: string[];
     /**
+     * @public
      * <p>A token that you can use in a subsequent operation to retrieve the next set of
      *          results.</p>
      */
@@ -1179,11 +1275,13 @@ export interface GetAppMonitorDataResponse {
  */
 export interface ListAppMonitorsRequest {
     /**
+     * @public
      * <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
      *       specify is 100.</p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>Use the token returned by the previous operation to request the next page of results.</p>
      */
     NextToken?: string;
@@ -1194,22 +1292,27 @@ export interface ListAppMonitorsRequest {
  */
 export interface AppMonitorSummary {
     /**
+     * @public
      * <p>The name of this app monitor.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The unique ID of this app monitor.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The date and time that the app monitor was created.</p>
      */
     Created?: string;
     /**
+     * @public
      * <p>The date and time of the most recent changes to this app monitor's configuration.</p>
      */
     LastModified?: string;
     /**
+     * @public
      * <p>The current state of this app monitor.</p>
      */
     State?: StateEnum | string;
@@ -1219,11 +1322,13 @@ export interface AppMonitorSummary {
  */
 export interface ListAppMonitorsResponse {
     /**
+     * @public
      * <p>A token that you can use in a subsequent operation to retrieve the next set of
      *          results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>An array of structures that contain information about the returned app monitors.</p>
      */
     AppMonitorSummaries?: AppMonitorSummary[];
@@ -1233,10 +1338,12 @@ export interface ListAppMonitorsResponse {
  */
 export interface ListRumMetricsDestinationsRequest {
     /**
+     * @public
      * <p>The name of the app monitor associated with the destinations that you want to retrieve.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
      *          specify is 100.</p>
      *          <p>To retrieve the remaining results, make another call with the returned
@@ -1244,6 +1351,7 @@ export interface ListRumMetricsDestinationsRequest {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>Use the token returned by the previous operation to request the next page of results.</p>
      */
     NextToken?: string;
@@ -1255,15 +1363,18 @@ export interface ListRumMetricsDestinationsRequest {
  */
 export interface MetricDestinationSummary {
     /**
+     * @public
      * <p>Specifies whether the destination is <code>CloudWatch</code> or <code>Evidently</code>.</p>
      */
     Destination?: MetricDestination | string;
     /**
+     * @public
      * <p>If the destination is <code>Evidently</code>, this specifies the ARN of the Evidently experiment that receives
      *        the metrics.</p>
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>This field appears only when the destination is <code>Evidently</code>. It specifies
      *          the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.</p>
      */
@@ -1274,11 +1385,13 @@ export interface MetricDestinationSummary {
  */
 export interface ListRumMetricsDestinationsResponse {
     /**
+     * @public
      * <p>The list of CloudWatch RUM extended metrics destinations associated with the app monitor that
      *       you specified.</p>
      */
     Destinations?: MetricDestinationSummary[];
     /**
+     * @public
      * <p>A token that you can use in a subsequent operation to
      *          retrieve the next set of results.</p>
      */
@@ -1289,10 +1402,12 @@ export interface ListRumMetricsDestinationsResponse {
  */
 export interface PutRumMetricsDestinationRequest {
     /**
+     * @public
      * <p>The name of the CloudWatch RUM app monitor that will send the metrics.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>Defines the destination to send the metrics to. Valid values are <code>CloudWatch</code> and
      *          <code>Evidently</code>. If
      *          you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
@@ -1300,11 +1415,13 @@ export interface PutRumMetricsDestinationRequest {
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>Use this parameter only if <code>Destination</code> is <code>Evidently</code>. This parameter specifies
      *       the ARN of the Evidently experiment that will receive the extended metrics.</p>
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter.</p>
      *          <p>This parameter specifies
@@ -1323,14 +1440,17 @@ export interface PutRumMetricsDestinationResponse {
  */
 export interface UpdateAppMonitorRequest {
     /**
+     * @public
      * <p>The name of the app monitor to update.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>The top-level internet domain name for which your application has administrative authority.</p>
      */
     Domain?: string;
     /**
+     * @public
      * <p>A structure that contains much of the configuration data for the app monitor. If you are using
      *          Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
      *          Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
@@ -1340,6 +1460,7 @@ export interface UpdateAppMonitorRequest {
      */
     AppMonitorConfiguration?: AppMonitorConfiguration;
     /**
+     * @public
      * <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
      *          sends a copy of this telemetry data to Amazon CloudWatch Logs
      *          in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
@@ -1347,6 +1468,7 @@ export interface UpdateAppMonitorRequest {
      */
     CwLogEnabled?: boolean;
     /**
+     * @public
      * <p>Specifies whether this app monitor allows the web client to define and send
      *          custom events. The default is for custom events to be <code>DISABLED</code>.</p>
      *          <p>For more information about custom events, see
@@ -1364,10 +1486,12 @@ export interface UpdateAppMonitorResponse {
  */
 export interface UpdateRumMetricDefinitionRequest {
     /**
+     * @public
      * <p>The name of the CloudWatch RUM app monitor that sends these metrics.</p>
      */
     AppMonitorName: string | undefined;
     /**
+     * @public
      * <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
      *          you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
      *          that will receive
@@ -1375,6 +1499,7 @@ export interface UpdateRumMetricDefinitionRequest {
      */
     Destination: MetricDestination | string | undefined;
     /**
+     * @public
      * <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
      *          <code>CloudWatch</code>, do not use this parameter.</p>
      *          <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
@@ -1382,10 +1507,12 @@ export interface UpdateRumMetricDefinitionRequest {
      */
     DestinationArn?: string;
     /**
+     * @public
      * <p>A structure that contains the new definition that you want to use for this metric.</p>
      */
     MetricDefinition: MetricDefinitionRequest | undefined;
     /**
+     * @public
      * <p>The ID of the metric definition to update.</p>
      */
     MetricDefinitionId: string | undefined;
@@ -1400,6 +1527,7 @@ export interface UpdateRumMetricDefinitionResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource that you want to see the tags of.</p>
      */
     ResourceArn: string | undefined;
@@ -1409,10 +1537,12 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>The ARN of the resource that you are viewing.</p>
      */
     ResourceArn: string | undefined;
     /**
+     * @public
      * <p>The list of tag keys and values associated with the resource you specified.</p>
      */
     Tags: Record<string, string> | undefined;
@@ -1424,24 +1554,29 @@ export interface ListTagsForResourceResponse {
  */
 export interface RumEvent {
     /**
+     * @public
      * <p>A unique ID for this event.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The exact time that this event occurred.</p>
      */
     timestamp: Date | undefined;
     /**
+     * @public
      * <p>The JSON schema that denotes the type of event this is, such as a page load or a new session.</p>
      */
     type: string | undefined;
     /**
+     * @public
      * <p>Metadata about this event, which contains a JSON serialization of the identity of the user for
      *          this session. The user information comes from information such as the HTTP user-agent request header
      *          and document interface.</p>
      */
     metadata?: __LazyJsonString | string;
     /**
+     * @public
      * <p>A string containing details about the event.</p>
      */
     details: __LazyJsonString | string | undefined;
@@ -1452,11 +1587,13 @@ export interface RumEvent {
  */
 export interface UserDetails {
     /**
+     * @public
      * <p>The ID of the user for this user session. This ID is generated by RUM and does not include any
      *       personally identifiable information about the user.</p>
      */
     userId?: string;
     /**
+     * @public
      * <p>The session ID that the performance events are from.</p>
      */
     sessionId?: string;
@@ -1466,22 +1603,27 @@ export interface UserDetails {
  */
 export interface PutRumEventsRequest {
     /**
+     * @public
      * <p>The ID of the app monitor that is sending this data.</p>
      */
     Id: string | undefined;
     /**
+     * @public
      * <p>A unique identifier for this batch of RUM event data.</p>
      */
     BatchId: string | undefined;
     /**
+     * @public
      * <p>A structure that contains information about the app monitor that collected this telemetry information.</p>
      */
     AppMonitorDetails: AppMonitorDetails | undefined;
     /**
+     * @public
      * <p>A structure that contains information about the user session that this batch of events was collected from.</p>
      */
     UserDetails: UserDetails | undefined;
     /**
+     * @public
      * <p>An array of structures that contain the telemetry event data.</p>
      */
     RumEvents: RumEvent[] | undefined;
@@ -1496,10 +1638,12 @@ export interface PutRumEventsResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the CloudWatch RUM resource that you're adding tags to.</p>
      */
     ResourceArn: string | undefined;
     /**
+     * @public
      * <p>The list of key-value pairs to associate with the resource.</p>
      */
     Tags: Record<string, string> | undefined;
@@ -1514,10 +1658,12 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the CloudWatch RUM resource that you're removing tags from.</p>
      */
     ResourceArn: string | undefined;
     /**
+     * @public
      * <p>The list of tag keys to remove from the resource.</p>
      */
     TagKeys: string[] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rum",
   "description": "AWS SDK for JavaScript Rum Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",