{ "smithy": "2.0", "shapes": { "com.amazonaws.rum#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.rum#Alias": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.rum#AppMonitor": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor.

" } }, "Domain": { "target": "com.amazonaws.rum#AppMonitorDomain", "traits": { "smithy.api#documentation": "

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

" } }, "DomainList": { "target": "com.amazonaws.rum#AppMonitorDomainList", "traits": { "smithy.api#documentation": "

List the domain names for which your application has administrative authority.

" } }, "Id": { "target": "com.amazonaws.rum#AppMonitorId", "traits": { "smithy.api#documentation": "

The unique ID of this app monitor.

" } }, "Created": { "target": "com.amazonaws.rum#ISOTimestampString", "traits": { "smithy.api#documentation": "

The date and time that this app monitor was created.

" } }, "LastModified": { "target": "com.amazonaws.rum#ISOTimestampString", "traits": { "smithy.api#documentation": "

The date and time of the most recent changes to this app monitor's configuration.

" } }, "Tags": { "target": "com.amazonaws.rum#TagMap", "traits": { "smithy.api#documentation": "

The list of tag keys and values associated with this app monitor.

" } }, "State": { "target": "com.amazonaws.rum#StateEnum", "traits": { "smithy.api#documentation": "

The current state of the app monitor.

" } }, "AppMonitorConfiguration": { "target": "com.amazonaws.rum#AppMonitorConfiguration", "traits": { "smithy.api#documentation": "

A structure that contains much of the configuration data for the app monitor.

" } }, "DataStorage": { "target": "com.amazonaws.rum#DataStorage", "traits": { "smithy.api#documentation": "

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

" } }, "CustomEvents": { "target": "com.amazonaws.rum#CustomEvents", "traits": { "smithy.api#documentation": "

Specifies whether this app monitor allows the web client to define and send custom events.

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

" } }, "DeobfuscationConfiguration": { "target": "com.amazonaws.rum#DeobfuscationConfiguration", "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

" } }, "Platform": { "target": "com.amazonaws.rum#AppMonitorPlatform", "traits": { "smithy.api#documentation": "

The platform type for this app monitor. Valid values are Web for web applications , Android for Android applications, and iOS for IOS applications.

" } } }, "traits": { "smithy.api#documentation": "

A RUM app monitor collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

" } }, "com.amazonaws.rum#AppMonitorConfiguration": { "type": "structure", "members": { "IdentityPoolId": { "target": "com.amazonaws.rum#IdentityPoolId", "traits": { "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

" } }, "ExcludedPages": { "target": "com.amazonaws.rum#Pages", "traits": { "smithy.api#documentation": "

A list of URLs in your website or application to exclude from RUM data collection.

You can't include both ExcludedPages and IncludedPages in the same operation.

" } }, "IncludedPages": { "target": "com.amazonaws.rum#Pages", "traits": { "smithy.api#documentation": "

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

You can't include both ExcludedPages and IncludedPages in the same operation.

" } }, "FavoritePages": { "target": "com.amazonaws.rum#FavoritePages", "traits": { "smithy.api#documentation": "

A list of pages in your application that are to be displayed with a \"favorite\" icon in the CloudWatch RUM console.

" } }, "SessionSampleRate": { "target": "com.amazonaws.rum#SessionSampleRate", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

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.

The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

" } }, "GuestRoleArn": { "target": "com.amazonaws.rum#Arn", "traits": { "smithy.api#documentation": "

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.

It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

If this issue affects you, you can take one of the following steps:

" } }, "AllowCookies": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

If you set this to true, 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 sequence of events. Cookies are stored in the top-level domain of the current page.

" } }, "Telemetries": { "target": "com.amazonaws.rum#Telemetries", "traits": { "smithy.api#documentation": "

An array that lists the types of telemetry data that this app monitor is to collect.

" } }, "EnableXRay": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

If you set this to true, 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. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

" } } }, "traits": { "smithy.api#documentation": "

This structure contains much of the configuration data for the app monitor.

" } }, "com.amazonaws.rum#AppMonitorDetails": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the app monitor.

" } }, "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique ID of the app monitor.

" } }, "version": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the app monitor.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about the RUM app monitor.

" } }, "com.amazonaws.rum#AppMonitorDomain": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 253 }, "smithy.api#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\\.\\*-]{4,253}$)(?!.*\\.-)(?!.*-\\.)(?!.*\\.\\.)(?!.*[^\\.]{64,})^(\\*\\.)?(?![-\\.\\*])[^\\*]{1,}\\.(\\*|(?!.*--)(?=.*[a-zA-Z])[^\\*]{1,}[^\\*-])$" } }, "com.amazonaws.rum#AppMonitorDomainList": { "type": "list", "member": { "target": "com.amazonaws.rum#AppMonitorDomain" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.rum#AppMonitorId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" } }, "com.amazonaws.rum#AppMonitorName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?!\\.)[\\.\\-_#A-Za-z0-9]+$" } }, "com.amazonaws.rum#AppMonitorPlatform": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "WEB", "value": "Web" }, { "name": "ANDROID", "value": "Android" }, { "name": "IOS", "value": "iOS" } ] } }, "com.amazonaws.rum#AppMonitorResource": { "type": "resource", "identifiers": { "Name": { "target": "com.amazonaws.rum#AppMonitorName" } }, "read": { "target": "com.amazonaws.rum#GetAppMonitor" }, "update": { "target": "com.amazonaws.rum#UpdateAppMonitor" }, "delete": { "target": "com.amazonaws.rum#DeleteAppMonitor" }, "list": { "target": "com.amazonaws.rum#ListAppMonitors" }, "operations": [ { "target": "com.amazonaws.rum#BatchCreateRumMetricDefinitions" }, { "target": "com.amazonaws.rum#BatchDeleteRumMetricDefinitions" }, { "target": "com.amazonaws.rum#BatchGetRumMetricDefinitions" }, { "target": "com.amazonaws.rum#CreateAppMonitor" }, { "target": "com.amazonaws.rum#DeleteResourcePolicy" }, { "target": "com.amazonaws.rum#DeleteRumMetricsDestination" }, { "target": "com.amazonaws.rum#GetAppMonitorData" }, { "target": "com.amazonaws.rum#GetResourcePolicy" }, { "target": "com.amazonaws.rum#ListRumMetricsDestinations" }, { "target": "com.amazonaws.rum#PutResourcePolicy" }, { "target": "com.amazonaws.rum#PutRumMetricsDestination" }, { "target": "com.amazonaws.rum#UpdateRumMetricDefinition" } ], "traits": { "aws.api#arn": { "template": "appmonitor/{Name}" } } }, "com.amazonaws.rum#AppMonitorSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of this app monitor.

" } }, "Id": { "target": "com.amazonaws.rum#AppMonitorId", "traits": { "smithy.api#documentation": "

The unique ID of this app monitor.

" } }, "Created": { "target": "com.amazonaws.rum#ISOTimestampString", "traits": { "smithy.api#documentation": "

The date and time that the app monitor was created.

" } }, "LastModified": { "target": "com.amazonaws.rum#ISOTimestampString", "traits": { "smithy.api#documentation": "

The date and time of the most recent changes to this app monitor's configuration.

" } }, "State": { "target": "com.amazonaws.rum#StateEnum", "traits": { "smithy.api#documentation": "

The current state of this app monitor.

" } }, "Platform": { "target": "com.amazonaws.rum#AppMonitorPlatform", "traits": { "smithy.api#documentation": "

The platform type for this app monitor. Valid values are Web for web applications, Android for Android applications, and iOS for IOS applications.

" } } }, "traits": { "smithy.api#documentation": "

A structure that includes some data about app monitors and their settings.

" } }, "com.amazonaws.rum#AppMonitorSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rum#AppMonitorSummary" } }, "com.amazonaws.rum#Arn": { "type": "string", "traits": { "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*" } }, "com.amazonaws.rum#BatchCreateRumMetricDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.rum#BatchCreateRumMetricDefinitionsRequest" }, "output": { "target": "com.amazonaws.rum#BatchCreateRumMetricDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.

By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.

In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both.

The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

The maximum number of metric definitions that one destination can contain is 2000.

Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.

You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/BatchCreateRumMetricDefinitions.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/rummetrics/{AppMonitorName}/metrics" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#BatchCreateRumMetricDefinitionsError": { "type": "structure", "members": { "MetricDefinition": { "target": "com.amazonaws.rum#MetricDefinitionRequest", "traits": { "smithy.api#documentation": "

The metric definition that caused this error.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error code.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error message for this metric definition.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.

" } }, "com.amazonaws.rum#BatchCreateRumMetricDefinitionsErrors": { "type": "list", "member": { "target": "com.amazonaws.rum#BatchCreateRumMetricDefinitionsError" } }, "com.amazonaws.rum#BatchCreateRumMetricDefinitionsRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch RUM app monitor that is to send the metrics.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

" } }, "MetricDefinitions": { "target": "com.amazonaws.rum#MetricDefinitionsRequest", "traits": { "smithy.api#documentation": "

An array of structures which define the metrics that you want to send.

", "smithy.api#required": {} } } } }, "com.amazonaws.rum#BatchCreateRumMetricDefinitionsResponse": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.rum#BatchCreateRumMetricDefinitionsErrors", "traits": { "smithy.api#documentation": "

An array of error objects, if the operation caused any errors.

", "smithy.api#required": {} } }, "MetricDefinitions": { "target": "com.amazonaws.rum#MetricDefinitions", "traits": { "smithy.api#documentation": "

An array of structures that define the extended metrics.

" } } } }, "com.amazonaws.rum#BatchDeleteRumMetricDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsRequest" }, "output": { "target": "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes the specified metrics from being sent to an extended metrics destination.

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/BatchDeleteRumMetricDefinitions.html" }, "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/rummetrics/{AppMonitorName}/metrics" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsError": { "type": "structure", "members": { "MetricDefinitionId": { "target": "com.amazonaws.rum#MetricDefinitionId", "traits": { "smithy.api#documentation": "

The ID of the metric definition that caused this error.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error code.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The error message for this metric definition.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.

" } }, "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsErrors": { "type": "list", "member": { "target": "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsError" } }, "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch RUM app monitor that is sending these metrics.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

Defines the destination where you want to stop sending the specified metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

", "smithy.api#httpQuery": "destination", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted.

", "smithy.api#httpQuery": "destinationArn" } }, "MetricDefinitionIds": { "target": "com.amazonaws.rum#MetricDefinitionIds", "traits": { "smithy.api#documentation": "

An array of structures which define the metrics that you want to stop sending.

", "smithy.api#httpQuery": "metricDefinitionIds", "smithy.api#required": {} } } } }, "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsResponse": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.rum#BatchDeleteRumMetricDefinitionsErrors", "traits": { "smithy.api#documentation": "

An array of error objects, if the operation caused any errors.

", "smithy.api#required": {} } }, "MetricDefinitionIds": { "target": "com.amazonaws.rum#MetricDefinitionIds", "traits": { "smithy.api#documentation": "

The IDs of the metric definitions that were deleted.

" } } } }, "com.amazonaws.rum#BatchGetRumMetricDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.rum#BatchGetRumMetricDefinitionsRequest" }, "output": { "target": "com.amazonaws.rum#BatchGetRumMetricDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/BatchGetRumMetricDefinitions.html" }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/rummetrics/{AppMonitorName}/metrics" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "MetricDefinitions" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#BatchGetRumMetricDefinitionsRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch RUM app monitor that is sending the metrics.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

", "smithy.api#httpQuery": "destination", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

", "smithy.api#httpQuery": "destinationArn" } }, "MaxResults": { "target": "com.amazonaws.rum#MaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Use the token returned by the previous operation to request the next page of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.rum#BatchGetRumMetricDefinitionsResponse": { "type": "structure", "members": { "MetricDefinitions": { "target": "com.amazonaws.rum#MetricDefinitions", "traits": { "smithy.api#documentation": "

An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A token that you can use in a subsequent operation to retrieve the next set of results.

" } } } }, "com.amazonaws.rum#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the resource that is associated with the error.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource that is associated with the error.

" } } }, "traits": { "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.rum#CreateAppMonitor": { "type": "operation", "input": { "target": "com.amazonaws.rum#CreateAppMonitorRequest" }, "output": { "target": "com.amazonaws.rum#CreateAppMonitorResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.

After you create an app monitor, sign in to the CloudWatch RUM console to get the 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?

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/CreateAppMonitor.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/appmonitor" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#CreateAppMonitorRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

A name for the app monitor.

", "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.rum#AppMonitorDomain", "traits": { "smithy.api#documentation": "

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

" } }, "DomainList": { "target": "com.amazonaws.rum#AppMonitorDomainList", "traits": { "smithy.api#documentation": "

List the domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list.

" } }, "Tags": { "target": "com.amazonaws.rum#TagMap", "traits": { "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the app monitor.

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.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging Amazon Web Services resources.

" } }, "AppMonitorConfiguration": { "target": "com.amazonaws.rum#AppMonitorConfiguration", "traits": { "smithy.api#documentation": "

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 Amazon Web Services.

If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

" } }, "CwLogEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

If you omit this parameter, the default is false.

" } }, "CustomEvents": { "target": "com.amazonaws.rum#CustomEvents", "traits": { "smithy.api#documentation": "

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

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

" } }, "DeobfuscationConfiguration": { "target": "com.amazonaws.rum#DeobfuscationConfiguration", "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

" } }, "Platform": { "target": "com.amazonaws.rum#AppMonitorPlatform", "traits": { "smithy.api#documentation": "

The platform type for the app monitor. Valid values are Web for web applications, Android for Android applications, and iOS for IOS applications. If you omit this parameter, the default is Web.

" } } } }, "com.amazonaws.rum#CreateAppMonitorResponse": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.rum#AppMonitorId", "traits": { "smithy.api#documentation": "

The unique ID of the new app monitor.

" } } } }, "com.amazonaws.rum#CustomEvents": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.rum#CustomEventsStatus", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about custom events for this app monitor.

" } }, "com.amazonaws.rum#CustomEventsStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED" }, { "name": "DISABLED", "value": "DISABLED" } ] } }, "com.amazonaws.rum#CwLog": { "type": "structure", "members": { "CwLogEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.

" } }, "CwLogGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the log group where the copies are stored.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.rum#DataStorage": { "type": "structure", "members": { "CwLog": { "target": "com.amazonaws.rum#CwLog", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

" } }, "com.amazonaws.rum#DeleteAppMonitor": { "type": "operation", "input": { "target": "com.amazonaws.rum#DeleteAppMonitorRequest" }, "output": { "target": "com.amazonaws.rum#DeleteAppMonitorResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an existing app monitor. This immediately stops the collection of data.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/appmonitor/{Name}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#DeleteAppMonitorRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.rum#DeleteAppMonitorResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.rum#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.rum#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#InvalidPolicyRevisionIdException" }, { "target": "com.amazonaws.rum#PolicyNotFoundException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes the association of a resource-based policy from an app monitor.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/appmonitor/{Name}/policy" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#DeleteResourcePolicyRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The app monitor that you want to remove the resource policy from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PolicyRevisionId": { "target": "com.amazonaws.rum#PolicyRevisionId", "traits": { "smithy.api#documentation": "

Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the revision ID that you provide doesn't match the latest policy revision ID, the request will be rejected with an InvalidPolicyRevisionIdException error.

", "smithy.api#httpQuery": "policyRevisionId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rum#DeleteResourcePolicyResponse": { "type": "structure", "members": { "PolicyRevisionId": { "target": "com.amazonaws.rum#PolicyRevisionId", "traits": { "smithy.api#documentation": "

The revision ID of the policy that was removed, if it had one.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rum#DeleteRumMetricsDestination": { "type": "operation", "input": { "target": "com.amazonaws.rum#DeleteRumMetricsDestinationRequest" }, "output": { "target": "com.amazonaws.rum#DeleteRumMetricsDestinationResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/rummetrics/{AppMonitorName}/metricsdestination" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#DeleteRumMetricsDestinationRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor that is sending metrics to the destination that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

The type of destination to delete. Valid values are CloudWatch and Evidently.

", "smithy.api#httpQuery": "destination", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination to delete.

", "smithy.api#httpQuery": "destinationArn" } } } }, "com.amazonaws.rum#DeleteRumMetricsDestinationResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#DeobfuscationConfiguration": { "type": "structure", "members": { "JavaScriptSourceMaps": { "target": "com.amazonaws.rum#JavaScriptSourceMaps", "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

" } }, "com.amazonaws.rum#DeobfuscationS3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,62}(?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" } }, "com.amazonaws.rum#DeobfuscationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED" }, { "name": "DISABLED", "value": "DISABLED" } ] } }, "com.amazonaws.rum#DestinationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*" } }, "com.amazonaws.rum#DimensionKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 280 } } }, "com.amazonaws.rum#DimensionKeysMap": { "type": "map", "key": { "target": "com.amazonaws.rum#DimensionKey" }, "value": { "target": "com.amazonaws.rum#DimensionName" }, "traits": { "smithy.api#length": { "min": 0, "max": 29 } } }, "com.amazonaws.rum#DimensionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?!:).*[^\\s].*" } }, "com.amazonaws.rum#EventData": { "type": "string" }, "com.amazonaws.rum#EventDataList": { "type": "list", "member": { "target": "com.amazonaws.rum#EventData" } }, "com.amazonaws.rum#EventPattern": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4000 } } }, "com.amazonaws.rum#FavoritePages": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.rum#GetAppMonitor": { "type": "operation", "input": { "target": "com.amazonaws.rum#GetAppMonitorRequest" }, "output": { "target": "com.amazonaws.rum#GetAppMonitorResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the complete configuration information for one app monitor.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/appmonitor/{Name}" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#GetAppMonitorData": { "type": "operation", "input": { "target": "com.amazonaws.rum#GetAppMonitorDataRequest" }, "output": { "target": "com.amazonaws.rum#GetAppMonitorDataResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/appmonitor/{Name}/data" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Events" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#GetAppMonitorDataRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor that collected the data that you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TimeRange": { "target": "com.amazonaws.rum#TimeRange", "traits": { "smithy.api#documentation": "

A structure that defines the time range that you want to retrieve results from.

", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.rum#QueryFilters", "traits": { "smithy.api#documentation": "

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.

" } }, "MaxResults": { "target": "com.amazonaws.rum#MaxQueryResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of results to return in one operation.

" } }, "NextToken": { "target": "com.amazonaws.rum#Token", "traits": { "smithy.api#documentation": "

Use the token returned by the previous operation to request the next page of results.

" } } } }, "com.amazonaws.rum#GetAppMonitorDataResponse": { "type": "structure", "members": { "Events": { "target": "com.amazonaws.rum#EventDataList", "traits": { "smithy.api#documentation": "

The events that RUM collected that match your request.

" } }, "NextToken": { "target": "com.amazonaws.rum#Token", "traits": { "smithy.api#documentation": "

A token that you can use in a subsequent operation to retrieve the next set of results.

" } } } }, "com.amazonaws.rum#GetAppMonitorRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The app monitor to retrieve information for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.rum#GetAppMonitorResponse": { "type": "structure", "members": { "AppMonitor": { "target": "com.amazonaws.rum#AppMonitor", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.rum#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.rum#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.rum#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#PolicyNotFoundException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Use this operation to retrieve information about a resource-based policy that is attached to an app monitor.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/appmonitor/{Name}/policy" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#GetResourcePolicyRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor that is associated with the resource-based policy that you want to view.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rum#GetResourcePolicyResponse": { "type": "structure", "members": { "PolicyDocument": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The JSON policy document that you requested.

" } }, "PolicyRevisionId": { "target": "com.amazonaws.rum#PolicyRevisionId", "traits": { "smithy.api#documentation": "

The revision ID information for this version of the policy document that you requested.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rum#ISOTimestampString": { "type": "string", "traits": { "smithy.api#length": { "min": 19, "max": 19 } } }, "com.amazonaws.rum#IamRoleArn": { "type": "string", "traits": { "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*" } }, "com.amazonaws.rum#IdentityPoolId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "[\\w-]+:[0-9a-f-]+" } }, "com.amazonaws.rum#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The value of a parameter in the request caused an error.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

Internal service exception.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.rum#InvalidPolicyRevisionIdException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The policy revision ID that you provided doeesn't match the latest policy revision ID.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rum#JavaScriptSourceMaps": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.rum#DeobfuscationStatus", "traits": { "smithy.api#documentation": "

Specifies whether JavaScript error stack traces should be unminified for this app monitor. The default is for JavaScript error stack trace unminification to be DISABLED.

", "smithy.api#required": {} } }, "S3Uri": { "target": "com.amazonaws.rum#DeobfuscationS3Uri", "traits": { "smithy.api#documentation": "

The S3Uri of the bucket or folder that stores the source map files. It is required if status is ENABLED.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.

" } }, "com.amazonaws.rum#JsonValue": { "type": "string", "traits": { "smithy.api#mediaType": "application/json" } }, "com.amazonaws.rum#ListAppMonitors": { "type": "operation", "input": { "target": "com.amazonaws.rum#ListAppMonitorsRequest" }, "output": { "target": "com.amazonaws.rum#ListAppMonitorsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/appmonitors" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "AppMonitorSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#ListAppMonitorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.rum#MaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Use the token returned by the previous operation to request the next page of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.rum#ListAppMonitorsResponse": { "type": "structure", "members": { "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A token that you can use in a subsequent operation to retrieve the next set of results.

" } }, "AppMonitorSummaries": { "target": "com.amazonaws.rum#AppMonitorSummaryList", "traits": { "smithy.api#documentation": "

An array of structures that contain information about the returned app monitors.

" } } } }, "com.amazonaws.rum#ListRumMetricsDestinations": { "type": "operation", "input": { "target": "com.amazonaws.rum#ListRumMetricsDestinationsRequest" }, "output": { "target": "com.amazonaws.rum#ListRumMetricsDestinationsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.

For more information about extended metrics, see AddRumMetrics.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/rummetrics/{AppMonitorName}/metricsdestination" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Destinations" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#ListRumMetricsDestinationsRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor associated with the destinations that you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "MaxResults": { "target": "com.amazonaws.rum#MaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Use the token returned by the previous operation to request the next page of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.rum#ListRumMetricsDestinationsResponse": { "type": "structure", "members": { "Destinations": { "target": "com.amazonaws.rum#MetricDestinationSummaryList", "traits": { "smithy.api#documentation": "

The list of CloudWatch RUM extended metrics destinations associated with the app monitor that you specified.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A token that you can use in a subsequent operation to retrieve the next set of results.

" } } } }, "com.amazonaws.rum#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.rum#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.rum#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Displays the tags associated with a CloudWatch RUM resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.rum#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rum#Arn", "traits": { "smithy.api#documentation": "

The ARN of the resource that you want to see the tags of.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.rum#ListTagsForResourceResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rum#Arn", "traits": { "smithy.api#documentation": "

The ARN of the resource that you are viewing.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rum#TagMap", "traits": { "smithy.api#documentation": "

The list of tag keys and values associated with the resource you specified.

", "smithy.api#required": {} } } } }, "com.amazonaws.rum#MalformedPolicyDocumentException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The policy document that you specified is not formatted correctly.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rum#MaxQueryResults": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.rum#MaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.rum#MetricDefinition": { "type": "structure", "members": { "MetricDefinitionId": { "target": "com.amazonaws.rum#MetricDefinitionId", "traits": { "smithy.api#documentation": "

The ID of this metric definition.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.rum#MetricName", "traits": { "smithy.api#documentation": "

The name of the metric that is defined in this structure.

", "smithy.api#required": {} } }, "ValueKey": { "target": "com.amazonaws.rum#ValueKey", "traits": { "smithy.api#documentation": "

The field within the event object that the metric value is sourced from.

" } }, "UnitLabel": { "target": "com.amazonaws.rum#UnitLabel", "traits": { "smithy.api#documentation": "

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

" } }, "DimensionKeys": { "target": "com.amazonaws.rum#DimensionKeysMap", "traits": { "smithy.api#documentation": "

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 CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

" } }, "EventPattern": { "target": "com.amazonaws.rum#EventPattern", "traits": { "smithy.api#documentation": "

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.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

" } }, "Namespace": { "target": "com.amazonaws.rum#Namespace", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.

" } }, "com.amazonaws.rum#MetricDefinitionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.rum#MetricDefinitionIds": { "type": "list", "member": { "target": "com.amazonaws.rum#MetricDefinitionId" } }, "com.amazonaws.rum#MetricDefinitionRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#MetricName", "traits": { "smithy.api#documentation": "

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:

", "smithy.api#required": {} } }, "ValueKey": { "target": "com.amazonaws.rum#ValueKey", "traits": { "smithy.api#documentation": "

The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw. Evidently will handle data extraction from the event.

" } }, "UnitLabel": { "target": "com.amazonaws.rum#UnitLabel", "traits": { "smithy.api#documentation": "

The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

" } }, "DimensionKeys": { "target": "com.amazonaws.rum#DimensionKeysMap", "traits": { "smithy.api#documentation": "

Use this field only if you are sending the metric to CloudWatch.

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:

For both extended metrics and custom metrics, all dimensions listed in this field must also be included in EventPattern.

" } }, "EventPattern": { "target": "com.amazonaws.rum#EventPattern", "traits": { "smithy.api#documentation": "

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.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

" } }, "Namespace": { "target": "com.amazonaws.rum#Namespace", "traits": { "smithy.api#documentation": "

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.

You cannot use any string that starts with AWS/ for your namespace.

" } } }, "traits": { "smithy.api#documentation": "

Use this structure to define one extended metric or custom metric that RUM will send to CloudWatch or CloudWatch Evidently. For more information, see Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently.

This structure is validated differently for extended metrics and custom metrics. For extended metrics that are sent to the AWS/RUM namespace, the following validations apply:

For custom metrics, the following validation rules apply:

Valid key values for first-level keys in the ValueKey, EventPattern, and DimensionKeys fields:

" } }, "com.amazonaws.rum#MetricDefinitions": { "type": "list", "member": { "target": "com.amazonaws.rum#MetricDefinition" } }, "com.amazonaws.rum#MetricDefinitionsRequest": { "type": "list", "member": { "target": "com.amazonaws.rum#MetricDefinitionRequest" } }, "com.amazonaws.rum#MetricDestination": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CloudWatch", "value": "CloudWatch" }, { "name": "Evidently", "value": "Evidently" } ] } }, "com.amazonaws.rum#MetricDestinationSummary": { "type": "structure", "members": { "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

Specifies whether the destination is CloudWatch or Evidently.

" } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives the metrics.

" } }, "IamRoleArn": { "target": "com.amazonaws.rum#IamRoleArn", "traits": { "smithy.api#documentation": "

This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.

" } } }, "traits": { "smithy.api#documentation": "

A structure that displays information about one destination that CloudWatch RUM sends extended metrics to.

" } }, "com.amazonaws.rum#MetricDestinationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rum#MetricDestinationSummary" } }, "com.amazonaws.rum#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.rum#Namespace": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 237 }, "smithy.api#pattern": "[a-zA-Z0-9-._/#:]+$" } }, "com.amazonaws.rum#Pages": { "type": "list", "member": { "target": "com.amazonaws.rum#Url" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.rum#PolicyNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource-based policy doesn't exist on this app monitor.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rum#PolicyRevisionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.rum#PolicySizeLimitExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The policy document is too large. The limit is 4 KB.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rum#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.rum#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.rum#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#InvalidPolicyRevisionIdException" }, { "target": "com.amazonaws.rum#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.rum#PolicySizeLimitExceededException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

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 Using resource-based policies with CloudWatch RUM.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/appmonitor/{Name}/policy" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#PutResourcePolicyRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor that you want to apply this resource-based policy to. To find the names of your app monitors, you can use the ListAppMonitors operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PolicyDocument": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The JSON to use as the resource policy. The document can be up to 4 KB in size. For more information about the contents and syntax for this policy, see Using resource-based policies with CloudWatch RUM.

", "smithy.api#required": {} } }, "PolicyRevisionId": { "target": "com.amazonaws.rum#PolicyRevisionId", "traits": { "smithy.api#documentation": "

A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

When you assign a policy revision ID, then later requests about that policy will be rejected with an InvalidPolicyRevisionIdException error if they don't provide the correct current revision ID.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rum#PutResourcePolicyResponse": { "type": "structure", "members": { "PolicyDocument": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The JSON policy document that you specified.

" } }, "PolicyRevisionId": { "target": "com.amazonaws.rum#PolicyRevisionId", "traits": { "smithy.api#documentation": "

The policy revision ID information that you specified.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rum#PutRumEvents": { "type": "operation", "input": { "target": "com.amazonaws.rum#PutRumEventsRequest" }, "output": { "target": "com.amazonaws.rum#PutRumEventsResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

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 PutRumEvents operations to send this data to RUM.

Each PutRumEvents operation can send a batch of events from one user session.

", "smithy.api#endpoint": { "hostPrefix": "dataplane." }, "smithy.api#http": { "method": "POST", "uri": "/appmonitors/{Id}/", "code": 200 } } }, "com.amazonaws.rum#PutRumEventsRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.rum#AppMonitorId", "traits": { "smithy.api#documentation": "

The ID of the app monitor that is sending this data.

", "smithy.api#httpLabel": {}, "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "smithy.api#required": {} } }, "BatchId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique identifier for this batch of RUM event data.

", "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "smithy.api#required": {} } }, "AppMonitorDetails": { "target": "com.amazonaws.rum#AppMonitorDetails", "traits": { "smithy.api#documentation": "

A structure that contains information about the app monitor that collected this telemetry information.

", "smithy.api#required": {} } }, "UserDetails": { "target": "com.amazonaws.rum#UserDetails", "traits": { "smithy.api#documentation": "

A structure that contains information about the user session that this batch of events was collected from.

", "smithy.api#required": {} } }, "RumEvents": { "target": "com.amazonaws.rum#RumEventList", "traits": { "smithy.api#documentation": "

An array of structures that contain the telemetry event data.

", "smithy.api#required": {} } }, "Alias": { "target": "com.amazonaws.rum#Alias", "traits": { "smithy.api#documentation": "

If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.

" } }, "SessionMetadata": { "target": "com.amazonaws.rum#JsonValue", "traits": { "smithy.api#documentation": "

A JSON serialization of attributes that apply to every event in this batch, such as the browser, device, and operating system of the end user. CloudWatch RUM merges these attributes into each event in the batch, so you send them once for the batch instead of once for each event. If an attribute appears both here and in an individual event's metadata, CloudWatch RUM uses the value in the event's metadata.

" } } } }, "com.amazonaws.rum#PutRumEventsResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#PutRumMetricsDestination": { "type": "operation", "input": { "target": "com.amazonaws.rum#PutRumMetricsDestinationRequest" }, "output": { "target": "com.amazonaws.rum#PutRumMetricsDestinationResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

For more information about extended metrics, see BatchCreateRumMetricDefinitions.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/PutRumMetricsDestination.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/rummetrics/{AppMonitorName}/metricsdestination" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#PutRumMetricsDestinationRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch RUM app monitor that will send the metrics.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

" } }, "IamRoleArn": { "target": "com.amazonaws.rum#IamRoleArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, don't use this parameter.

This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

If you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.

" } } } }, "com.amazonaws.rum#PutRumMetricsDestinationResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#QueryFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#QueryFilterKey", "traits": { "smithy.api#documentation": "

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

" } }, "Values": { "target": "com.amazonaws.rum#QueryFilterValueList", "traits": { "smithy.api#documentation": "

The values of the Name that are to be be included in the returned results.

" } } }, "traits": { "smithy.api#documentation": "

A structure that defines a key and values that you can use to filter the results. The only performance events that are returned are those that have values matching the ones that you specify in one of your QueryFilter structures.

For example, you could specify Browser as the Name and specify Chrome,Firefox as the Values to return events generated only from those browsers.

Specifying Invert as the Name works as a \"not equal to\" filter. For example, specify Invert as the Name and specify Chrome as the value to return all events except events from user sessions with the Chrome browser.

" } }, "com.amazonaws.rum#QueryFilterKey": { "type": "string" }, "com.amazonaws.rum#QueryFilterValue": { "type": "string" }, "com.amazonaws.rum#QueryFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.rum#QueryFilterValue" } }, "com.amazonaws.rum#QueryFilters": { "type": "list", "member": { "target": "com.amazonaws.rum#QueryFilter" } }, "com.amazonaws.rum#QueryTimestamp": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.rum#RUM": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.rum#ListTagsForResource" }, { "target": "com.amazonaws.rum#PutRumEvents" }, { "target": "com.amazonaws.rum#TagResource" }, { "target": "com.amazonaws.rum#UntagResource" } ], "resources": [ { "target": "com.amazonaws.rum#AppMonitorResource" } ], "traits": { "aws.api#service": { "sdkId": "RUM", "arnNamespace": "rum", "serviceName": "rum" }, "aws.auth#sigv4": { "name": "rum" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "X-Amz-Date", "Authorization", "Date", "X-Amz-Security-Token", "X-Amz-Targe", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id", "x-amzn-errormessage", "x-amz-apigw-id", "date" ] }, "smithy.api#documentation": "

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.

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.

", "smithy.api#title": "CloudWatch RUM", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://rum-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rum-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rum.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rum.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rum-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rum-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rum.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://rum.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rum.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rum.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.rum#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the resource that is associated with the error.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource that is associated with the error.

" } } }, "traits": { "smithy.api#documentation": "

Resource not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rum#RumEvent": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique ID for this event.

", "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "smithy.api#required": {} } }, "timestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The exact time that this event occurred.

", "smithy.api#required": {} } }, "type": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The JSON schema that denotes the type of event this is, such as a page load or a new session.

", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.rum#JsonValue", "traits": { "smithy.api#documentation": "

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.

" } }, "details": { "target": "com.amazonaws.rum#JsonValue", "traits": { "smithy.api#documentation": "

A string containing details about the event.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A structure that contains the information for one performance event that RUM collects from a user session with your application.

" } }, "com.amazonaws.rum#RumEventList": { "type": "list", "member": { "target": "com.amazonaws.rum#RumEvent" } }, "com.amazonaws.rum#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This request exceeds a service quota.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.rum#SessionSampleRate": { "type": "double", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1 } } }, "com.amazonaws.rum#StateEnum": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CREATED", "value": "CREATED" }, { "name": "DELETING", "value": "DELETING" }, { "name": "ACTIVE", "value": "ACTIVE" } ] } }, "com.amazonaws.rum#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.rum#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.rum#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.rum#TagMap": { "type": "map", "key": { "target": "com.amazonaws.rum#TagKey" }, "value": { "target": "com.amazonaws.rum#TagValue" } }, "com.amazonaws.rum#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.rum#TagResourceRequest" }, "output": { "target": "com.amazonaws.rum#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.

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.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource 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.

You can associate as many as 50 tags with a resource.

For more information, see Tagging Amazon Web Services resources.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rum#Arn", "traits": { "smithy.api#documentation": "

The ARN of the CloudWatch RUM resource that you're adding tags to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rum#TagMap", "traits": { "smithy.api#documentation": "

The list of key-value pairs to associate with the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.rum#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.rum#Telemetries": { "type": "list", "member": { "target": "com.amazonaws.rum#Telemetry" } }, "com.amazonaws.rum#Telemetry": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "errors", "name": "ERRORS", "documentation": "Includes JS error event plugin" }, { "value": "performance", "name": "PERFORMANCE", "documentation": "Includes navigation, paint, resource and web vital event plugins" }, { "value": "http", "name": "HTTP", "documentation": "Includes X-Ray Xhr and X-Ray Fetch plugin" } ] } }, "com.amazonaws.rum#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the service that is associated with the error.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the service quota that was exceeded.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The value of a parameter in the request caused an error.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

The request was throttled because of quota limits.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.rum#TimeRange": { "type": "structure", "members": { "After": { "target": "com.amazonaws.rum#QueryTimestamp", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The beginning of the time range to retrieve performance events from.

", "smithy.api#required": {} } }, "Before": { "target": "com.amazonaws.rum#QueryTimestamp", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

A structure that defines the time range that you want to retrieve results from.

" } }, "com.amazonaws.rum#Token": { "type": "string" }, "com.amazonaws.rum#UnitLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.rum#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.rum#UntagResourceRequest" }, "output": { "target": "com.amazonaws.rum#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/tags/{ResourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rum#Arn", "traits": { "smithy.api#documentation": "

The ARN of the CloudWatch RUM resource that you're removing tags from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.rum#TagKeyList", "traits": { "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.rum#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#UpdateAppMonitor": { "type": "operation", "input": { "target": "com.amazonaws.rum#UpdateAppMonitorRequest" }, "output": { "target": "com.amazonaws.rum#UpdateAppMonitorResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

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?

", "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/appmonitor/{Name}" } } }, "com.amazonaws.rum#UpdateAppMonitorRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the app monitor to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.rum#AppMonitorDomain", "traits": { "smithy.api#documentation": "

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

" } }, "DomainList": { "target": "com.amazonaws.rum#AppMonitorDomainList", "traits": { "smithy.api#documentation": "

List the domain names for which your application has administrative authority. The UpdateAppMonitor allows either the domain or the domain list.

" } }, "AppMonitorConfiguration": { "target": "com.amazonaws.rum#AppMonitorConfiguration", "traits": { "smithy.api#documentation": "

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 Amazon Web Services.

" } }, "CwLogEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } }, "CustomEvents": { "target": "com.amazonaws.rum#CustomEvents", "traits": { "smithy.api#documentation": "

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.

" } }, "DeobfuscationConfiguration": { "target": "com.amazonaws.rum#DeobfuscationConfiguration", "traits": { "smithy.api#documentation": "

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

" } } } }, "com.amazonaws.rum#UpdateAppMonitorResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#UpdateRumMetricDefinition": { "type": "operation", "input": { "target": "com.amazonaws.rum#UpdateRumMetricDefinitionRequest" }, "output": { "target": "com.amazonaws.rum#UpdateRumMetricDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.rum#AccessDeniedException" }, { "target": "com.amazonaws.rum#ConflictException" }, { "target": "com.amazonaws.rum#InternalServerException" }, { "target": "com.amazonaws.rum#ResourceNotFoundException" }, { "target": "com.amazonaws.rum#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rum#ThrottlingException" }, { "target": "com.amazonaws.rum#ValidationException" } ], "traits": { "smithy.api#documentation": "

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/UpdateRumMetricDefinitions.html" }, "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/rummetrics/{AppMonitorName}/metrics" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rum#UpdateRumMetricDefinitionRequest": { "type": "structure", "members": { "AppMonitorName": { "target": "com.amazonaws.rum#AppMonitorName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch RUM app monitor that sends these metrics.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Name" } }, "Destination": { "target": "com.amazonaws.rum#MetricDestination", "traits": { "smithy.api#documentation": "

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.rum#DestinationArn", "traits": { "smithy.api#documentation": "

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

" } }, "MetricDefinition": { "target": "com.amazonaws.rum#MetricDefinitionRequest", "traits": { "smithy.api#documentation": "

A structure that contains the new definition that you want to use for this metric.

", "smithy.api#required": {} } }, "MetricDefinitionId": { "target": "com.amazonaws.rum#MetricDefinitionId", "traits": { "smithy.api#documentation": "

The ID of the metric definition to update.

", "smithy.api#required": {} } } } }, "com.amazonaws.rum#UpdateRumMetricDefinitionResponse": { "type": "structure", "members": {} }, "com.amazonaws.rum#Url": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1260 }, "smithy.api#pattern": "https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&*//=]*)" } }, "com.amazonaws.rum#UserDetails": { "type": "structure", "members": { "userId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" } }, "sessionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The session ID that the performance events are from.

", "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about the user session that this batch of events was collected from.

" } }, "com.amazonaws.rum#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

One of the arguments for the request is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rum#ValueKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 280 } } } } }