GetAppMonitor - CloudWatch RUM

GetAppMonitor

Retrieves the complete configuration information for one app monitor.

Request Syntax

GET /appmonitor/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name

The app monitor to retrieve information for.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AppMonitor": { "AppMonitorConfiguration": { "AllowCookies": boolean, "EnableXRay": boolean, "ExcludedPages": [ "string" ], "FavoritePages": [ "string" ], "GuestRoleArn": "string", "IdentityPoolId": "string", "IncludedPages": [ "string" ], "SessionSampleRate": number, "Telemetries": [ "string" ] }, "Created": "string", "DataStorage": { "CwLog": { "CwLogEnabled": boolean, "CwLogGroup": "string" } }, "Domain": "string", "Id": "string", "LastModified": "string", "Name": "string", "State": "string", "Tags": { "string" : "string" } } }

Response Elements

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

The following data is returned in JSON format by the service.

AppMonitor

A structure containing all the configuration information for the app monitor.

Type: AppMonitor object

Errors

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

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

Internal service exception.

HTTP Status Code: 500

ResourceNotFoundException

Resource not found.

HTTP Status Code: 404

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

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: