@aws-sdk/client-rum 3.296.0 → 3.297.0

package/dist-types/commands/ListAppMonitorsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListAppMonitorsRequest, ListAppMonitorsResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link ListAppMonitorsCommand}.
  */
 export interface ListAppMonitorsCommandInput extends ListAppMonitorsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListAppMonitorsCommand}.
  */
 export interface ListAppMonitorsCommandOutput extends ListAppMonitorsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of the Amazon CloudWatch RUM app monitors in the account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListAppMonitorsCommandOutput extends ListAppMonitorsResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param ListAppMonitorsCommandInput - {@link ListAppMonitorsCommandInput}
+ * @returns {@link ListAppMonitorsCommandOutput}
  * @see {@link ListAppMonitorsCommandInput} for command's `input` shape.
  * @see {@link ListAppMonitorsCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListAppMonitorsCommandOutput extends ListAppMonitorsResponse, _
 export declare class ListAppMonitorsCommand extends $Command<ListAppMonitorsCommandInput, ListAppMonitorsCommandOutput, RUMClientResolvedConfig> {
     readonly input: ListAppMonitorsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListAppMonitorsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppMonitorsCommandInput, ListAppMonitorsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListRumMetricsDestinationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListRumMetricsDestinationsRequest, ListRumMetricsDestinationsResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link ListRumMetricsDestinationsCommand}.
  */
 export interface ListRumMetricsDestinationsCommandInput extends ListRumMetricsDestinationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListRumMetricsDestinationsCommand}.
  */
 export interface ListRumMetricsDestinationsCommandOutput extends ListRumMetricsDestinationsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -27,6 +32,8 @@ export interface ListRumMetricsDestinationsCommandOutput extends ListRumMetricsD
  * const response = await client.send(command);
  * ```
  *
+ * @param ListRumMetricsDestinationsCommandInput - {@link ListRumMetricsDestinationsCommandInput}
+ * @returns {@link ListRumMetricsDestinationsCommandOutput}
  * @see {@link ListRumMetricsDestinationsCommandInput} for command's `input` shape.
  * @see {@link ListRumMetricsDestinationsCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListRumMetricsDestinationsCommandOutput extends ListRumMetricsD
 export declare class ListRumMetricsDestinationsCommand extends $Command<ListRumMetricsDestinationsCommandInput, ListRumMetricsDestinationsCommandOutput, RUMClientResolvedConfig> {
     readonly input: ListRumMetricsDestinationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListRumMetricsDestinationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRumMetricsDestinationsCommandInput, ListRumMetricsDestinationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Displays the tags associated with a CloudWatch RUM resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, RUMClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/PutRumEventsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutRumEventsRequest, PutRumEventsResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link PutRumEventsCommand}.
  */
 export interface PutRumEventsCommandInput extends PutRumEventsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutRumEventsCommand}.
  */
 export interface PutRumEventsCommandOutput extends PutRumEventsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -28,6 +33,8 @@ export interface PutRumEventsCommandOutput extends PutRumEventsResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param PutRumEventsCommandInput - {@link PutRumEventsCommandInput}
+ * @returns {@link PutRumEventsCommandOutput}
  * @see {@link PutRumEventsCommandInput} for command's `input` shape.
  * @see {@link PutRumEventsCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -52,11 +59,20 @@ export interface PutRumEventsCommandOutput extends PutRumEventsResponse, __Metad
 export declare class PutRumEventsCommand extends $Command<PutRumEventsCommandInput, PutRumEventsCommandOutput, RUMClientResolvedConfig> {
     readonly input: PutRumEventsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutRumEventsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRumEventsCommandInput, PutRumEventsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutRumMetricsDestinationRequest, PutRumMetricsDestinationResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link PutRumMetricsDestinationCommand}.
  */
 export interface PutRumMetricsDestinationCommandInput extends PutRumMetricsDestinationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutRumMetricsDestinationCommand}.
  */
 export interface PutRumMetricsDestinationCommandOutput extends PutRumMetricsDestinationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -27,6 +32,8 @@ export interface PutRumMetricsDestinationCommandOutput extends PutRumMetricsDest
  * const response = await client.send(command);
  * ```
  *
+ * @param PutRumMetricsDestinationCommandInput - {@link PutRumMetricsDestinationCommandInput}
+ * @returns {@link PutRumMetricsDestinationCommandOutput}
  * @see {@link PutRumMetricsDestinationCommandInput} for command's `input` shape.
  * @see {@link PutRumMetricsDestinationCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -54,11 +61,20 @@ export interface PutRumMetricsDestinationCommandOutput extends PutRumMetricsDest
 export declare class PutRumMetricsDestinationCommand extends $Command<PutRumMetricsDestinationCommandInput, PutRumMetricsDestinationCommandOutput, RUMClientResolvedConfig> {
     readonly input: PutRumMetricsDestinationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutRumMetricsDestinationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRumMetricsDestinationCommandInput, PutRumMetricsDestinationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -38,6 +43,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, RUMClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, RUMClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateAppMonitorCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateAppMonitorRequest, UpdateAppMonitorResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateAppMonitorCommand}.
  */
 export interface UpdateAppMonitorCommandInput extends UpdateAppMonitorRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateAppMonitorCommand}.
  */
 export interface UpdateAppMonitorCommandOutput extends UpdateAppMonitorResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -35,6 +40,8 @@ export interface UpdateAppMonitorCommandOutput extends UpdateAppMonitorResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateAppMonitorCommandInput - {@link UpdateAppMonitorCommandInput}
+ * @returns {@link UpdateAppMonitorCommandOutput}
  * @see {@link UpdateAppMonitorCommandInput} for command's `input` shape.
  * @see {@link UpdateAppMonitorCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -62,11 +69,20 @@ export interface UpdateAppMonitorCommandOutput extends UpdateAppMonitorResponse,
 export declare class UpdateAppMonitorCommand extends $Command<UpdateAppMonitorCommandInput, UpdateAppMonitorCommandOutput, RUMClientResolvedConfig> {
     readonly input: UpdateAppMonitorCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateAppMonitorCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAppMonitorCommandInput, UpdateAppMonitorCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateRumMetricDefinitionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateRumMetricDefinitionRequest, UpdateRumMetricDefinitionResponse } from "../models/models_0";
 import { RUMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RUMClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateRumMetricDefinitionCommand}.
  */
 export interface UpdateRumMetricDefinitionCommandInput extends UpdateRumMetricDefinitionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRumMetricDefinitionCommand}.
  */
 export interface UpdateRumMetricDefinitionCommandOutput extends UpdateRumMetricDefinitionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateRumMetricDefinitionCommandOutput extends UpdateRumMetricD
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRumMetricDefinitionCommandInput - {@link UpdateRumMetricDefinitionCommandInput}
+ * @returns {@link UpdateRumMetricDefinitionCommandOutput}
  * @see {@link UpdateRumMetricDefinitionCommandInput} for command's `input` shape.
  * @see {@link UpdateRumMetricDefinitionCommandOutput} for command's `response` shape.
  * @see {@link RUMClientResolvedConfig | config} for RUMClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateRumMetricDefinitionCommandOutput extends UpdateRumMetricD
 export declare class UpdateRumMetricDefinitionCommand extends $Command<UpdateRumMetricDefinitionCommandInput, UpdateRumMetricDefinitionCommandOutput, RUMClientResolvedConfig> {
     readonly input: UpdateRumMetricDefinitionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRumMetricDefinitionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RUMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRumMetricDefinitionCommandInput, UpdateRumMetricDefinitionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from RUM service.
  */
 export declare class RUMServiceException extends __ServiceException {