UpdateAppMonitor - CloudWatch RUM


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.

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 TagResource.

To create a new app monitor, use CreateAppMonitor.

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 How do I find a code snippet that I've already generated?

Request Syntax

PATCH /appmonitor/Name HTTP/1.1 Content-type: application/json { "AppMonitorConfiguration": { "AllowCookies": boolean, "EnableXRay": boolean, "ExcludedPages": [ "string" ], "FavoritePages": [ "string" ], "GuestRoleArn": "string", "IdentityPoolId": "string", "IncludedPages": [ "string" ], "SessionSampleRate": number, "Telemetries": [ "string" ] }, "CustomEvents": { "Status": "string" }, "CwLogEnabled": boolean, "Domain": "string" }

URI Request Parameters

The request uses the following URI parameters.


The name of the app monitor to update.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(?!\.)[\.\-_#A-Za-z0-9]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.


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 AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to AWS.

Type: AppMonitorConfiguration object

Required: No


Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.

For more information about custom events, see Send custom events.

Type: CustomEvents object

Required: No


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 Amazon CloudWatch Logs charges.

Type: Boolean

Required: No


The top-level internet domain name for which your application has administrative authority.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


You don't have sufficient permissions to perform this action.

HTTP Status Code: 403


This operation attempted to create a resource that already exists.

HTTP Status Code: 409


Internal service exception.

HTTP Status Code: 500


Resource not found.

HTTP Status Code: 404


The request was throttled because of quota limits.

HTTP Status Code: 429


One of the arguments for the request is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: