Serialized Form (AWS Java SDK for CloudWatch RUM 1.12.300 API)

Package com.amazonaws.services.cloudwatchrum.model
- Class com.amazonaws.services.cloudwatchrum.model.AccessDeniedException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.amazonaws.services.cloudwatchrum.model.AppMonitor extends Object implements Serializable
 - Serialized Fields
 - appMonitorConfiguration
```
AppMonitorConfiguration appMonitorConfiguration
```
 A structure that contains much of the configuration data for the app monitor.
 - created
```
String created
```
 The date and time that this app monitor was created.
 - dataStorage
```
DataStorage dataStorage
```
 A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.
 - domain
```
String domain
```
 The top-level internet domain name for which your application has administrative authority.
 - id
```
String id
```
 The unique ID of this app monitor.
 - lastModified
```
String lastModified
```
 The date and time of the most recent changes to this app monitor's configuration.
 - name
```
String name
```
 The name of the app monitor.
 - state
```
String state
```
 The current state of the app monitor.
 - tags
```
Map<K,V> tags
```
 The list of tag keys and values associated with this app monitor.
- Class com.amazonaws.services.cloudwatchrum.model.AppMonitorConfiguration extends Object implements Serializable
 - Serialized Fields
 - allowCookies
```
Boolean allowCookies
```
 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.
 - enableXRay
```
Boolean enableXRay
```
 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?
 - excludedPages
```
List<E> excludedPages
```
 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.
 - favoritePages
```
List<E> favoritePages
```
 A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
 - guestRoleArn
```
String guestRoleArn
```
 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.
 - identityPoolId
```
String identityPoolId
```
 The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
 - includedPages
```
List<E> includedPages
```
 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 <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.
 - sessionSampleRate
```
Double sessionSampleRate
```
 Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs.
 
 The number you specify is the percentage of user sessions that will be used.
 
 If you omit this parameter, the default of 10 is used.
 - telemetries
```
List<E> telemetries
```
 An array that lists the types of telemetry data that this app monitor is to collect.
 
 errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.
 
 performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.
 
 http indicates that RUM collects data about HTTP errors thrown by your application.
- Class com.amazonaws.services.cloudwatchrum.model.AppMonitorDetails extends Object implements Serializable
 - Serialized Fields
 - id
```
String id
```
 The unique ID of the app monitor.
 - name
```
String name
```
 The name of the app monitor.
 - version
```
String version
```
 The version of the app monitor.
- Class com.amazonaws.services.cloudwatchrum.model.AppMonitorSummary extends Object implements Serializable
 - Serialized Fields
 - created
```
String created
```
 The date and time that the app monitor was created.
 - id
```
String id
```
 The unique ID of this app monitor.
 - lastModified
```
String lastModified
```
 The date and time of the most recent changes to this app monitor's configuration.
 - name
```
String name
```
 The name of this app monitor.
 - state
```
String state
```
 The current state of this app monitor.
- Class com.amazonaws.services.cloudwatchrum.model.AWSCloudWatchRUMException extends AmazonServiceException implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.amazonaws.services.cloudwatchrum.model.ConflictException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - resourceName
```
String resourceName
```
 The name of the resource that is associated with the error.
 - resourceType
```
String resourceType
```
 The type of the resource that is associated with the error.
- Class com.amazonaws.services.cloudwatchrum.model.CreateAppMonitorRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - appMonitorConfiguration
```
AppMonitorConfiguration appMonitorConfiguration
```
 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
```
Boolean cwLogEnabled
```
 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.
 - domain
```
String domain
```
 The top-level internet domain name for which your application has administrative authority.
 - name
```
String name
```
 A name for the app monitor.
 - tags
```
Map<K,V> tags
```
 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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.
- Class com.amazonaws.services.cloudwatchrum.model.CreateAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
 - Serialized Fields
 - id
```
String id
```
 The unique ID of the new app monitor.
- Class com.amazonaws.services.cloudwatchrum.model.CwLog extends Object implements Serializable
 - Serialized Fields
 - cwLogEnabled
```
Boolean cwLogEnabled
```
 Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.
 - cwLogGroup
```
String cwLogGroup
```
 The name of the log group where the copies are stored.
- Class com.amazonaws.services.cloudwatchrum.model.DataStorage extends Object implements Serializable
 - Serialized Fields
 - cwLog
```
CwLog cwLog
```
 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.
- Class com.amazonaws.services.cloudwatchrum.model.DeleteAppMonitorRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - name
```
String name
```
 The name of the app monitor to delete.
- Class com.amazonaws.services.cloudwatchrum.model.DeleteAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorDataRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - filters
```
List<E> filters
```
 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
```
Integer maxResults
```
 The maximum number of results to return in one operation.
 - name
```
String name
```
 The name of the app monitor that collected the data that you want to retrieve.
 - nextToken
```
String nextToken
```
 Use the token returned by the previous operation to request the next page of results.
 - timeRange
```
TimeRange timeRange
```
 A structure that defines the time range that you want to retrieve results from.
- Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
 - Serialized Fields
 - events
```
List<E> events
```
 The events that RUM collected that match your request.
 - nextToken
```
String nextToken
```
 A token that you can use in a subsequent operation to retrieve the next set of results.
- Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - name
```
String name
```
 The app monitor to retrieve information for.
- Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
 - Serialized Fields
 - appMonitor
```
AppMonitor appMonitor
```
 A structure containing all the configuration information for the app monitor.
- Class com.amazonaws.services.cloudwatchrum.model.InternalServerException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - retryAfterSeconds
```
Integer retryAfterSeconds
```
 The value of a parameter in the request caused an error.
- Class com.amazonaws.services.cloudwatchrum.model.ListAppMonitorsRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - maxResults
```
Integer maxResults
```
 The maximum number of results to return in one operation.
 - nextToken
```
String nextToken
```
 Use the token returned by the previous operation to request the next page of results.
- Class com.amazonaws.services.cloudwatchrum.model.ListAppMonitorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
 - Serialized Fields
 - appMonitorSummaries
```
List<E> appMonitorSummaries
```
 An array of structures that contain information about the returned app monitors.
 - nextToken
```
String nextToken
```
 A token that you can use in a subsequent operation to retrieve the next set of results.
- Class com.amazonaws.services.cloudwatchrum.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - resourceArn
```
String resourceArn
```
 The ARN of the resource that you want to see the tags of.
- Class com.amazonaws.services.cloudwatchrum.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
 - Serialized Fields
 - resourceArn
```
String resourceArn
```
 The ARN of the resource that you are viewing.
 - tags
```
Map<K,V> tags
```
 The list of tag keys and values associated with the resource you specified.
- Class com.amazonaws.services.cloudwatchrum.model.PutRumEventsRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - appMonitorDetails
```
AppMonitorDetails appMonitorDetails
```
 A structure that contains information about the app monitor that collected this telemetry information.
 - batchId
```
String batchId
```
 A unique identifier for this batch of RUM event data.
 - id
```
String id
```
 The ID of the app monitor that is sending this data.
 - rumEvents
```
List<E> rumEvents
```
 An array of structures that contain the telemetry event data.
 - userDetails
```
UserDetails userDetails
```
 A structure that contains information about the user session that this batch of events was collected from.
- Class com.amazonaws.services.cloudwatchrum.model.PutRumEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchrum.model.QueryFilter extends Object implements Serializable
 - Serialized Fields
 - name
```
String name
```
 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
```
List<E> values
```
 The values of the Name that are to be be included in the returned results.
- Class com.amazonaws.services.cloudwatchrum.model.ResourceNotFoundException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - resourceName
```
String resourceName
```
 The name of the resource that is associated with the error.
 - resourceType
```
String resourceType
```
 The type of the resource that is associated with the error.
- Class com.amazonaws.services.cloudwatchrum.model.RumEvent extends Object implements Serializable
 - Serialized Fields
 - details
```
String details
```
 A string containing details about the event.
 - id
```
String id
```
 A unique ID for this event.
 - metadata
```
String metadata
```
 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.
 - timestamp
```
Date timestamp
```
 The exact time that this event occurred.
 - type
```
String type
```
 The JSON schema that denotes the type of event this is, such as a page load or a new session.
- Class com.amazonaws.services.cloudwatchrum.model.ServiceQuotaExceededException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.amazonaws.services.cloudwatchrum.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - resourceArn
```
String resourceArn
```
 The ARN of the CloudWatch RUM resource that you're adding tags to.
 - tags
```
Map<K,V> tags
```
 The list of key-value pairs to associate with the resource.
- Class com.amazonaws.services.cloudwatchrum.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchrum.model.ThrottlingException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - quotaCode
```
String quotaCode
```
 The ID of the service quota that was exceeded.
 - retryAfterSeconds
```
Integer retryAfterSeconds
```
 The value of a parameter in the request caused an error.
 - serviceCode
```
String serviceCode
```
 The ID of the service that is associated with the error.
- Class com.amazonaws.services.cloudwatchrum.model.TimeRange extends Object implements Serializable
 - Serialized Fields
 - after
```
Long after
```
 The beginning of the time range to retrieve performance events from.
 - before
```
Long before
```
 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.
- Class com.amazonaws.services.cloudwatchrum.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - resourceArn
```
String resourceArn
```
 The ARN of the CloudWatch RUM resource that you're removing tags from.
 - tagKeys
```
List<E> tagKeys
```
 The list of tag keys to remove from the resource.
- Class com.amazonaws.services.cloudwatchrum.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchrum.model.UpdateAppMonitorRequest extends AmazonWebServiceRequest implements Serializable
 - Serialized Fields
 - appMonitorConfiguration
```
AppMonitorConfiguration appMonitorConfiguration
```
 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
```
Boolean cwLogEnabled
```
 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.
 - domain
```
String domain
```
 The top-level internet domain name for which your application has administrative authority.
 - name
```
String name
```
 The name of the app monitor to update.
- Class com.amazonaws.services.cloudwatchrum.model.UpdateAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchrum.model.UserDetails extends Object implements Serializable
 - Serialized Fields
 - sessionId
```
String sessionId
```
 The session ID that the performance events are from.
 - userId
```
String userId
```
 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.
- Class com.amazonaws.services.cloudwatchrum.model.ValidationException extends AWSCloudWatchRUMException implements Serializable
 
 serialVersionUID:
 
 1L

Serialized Form

Package com.amazonaws.services.cloudwatchrum.model

Class com.amazonaws.services.cloudwatchrum.model.AccessDeniedException extends AWSCloudWatchRUMException implements Serializable

Class com.amazonaws.services.cloudwatchrum.model.AppMonitor extends Object implements Serializable

Serialized Fields

appMonitorConfiguration

created

dataStorage

domain

id

lastModified

name

state

tags

Class com.amazonaws.services.cloudwatchrum.model.AppMonitorConfiguration extends Object implements Serializable

Serialized Fields

allowCookies

enableXRay

excludedPages

favoritePages

guestRoleArn

identityPoolId

includedPages

sessionSampleRate

telemetries

Class com.amazonaws.services.cloudwatchrum.model.AppMonitorDetails extends Object implements Serializable

Serialized Fields

id

name

version

Class com.amazonaws.services.cloudwatchrum.model.AppMonitorSummary extends Object implements Serializable

Serialized Fields

created

id

lastModified

name

state

Class com.amazonaws.services.cloudwatchrum.model.AWSCloudWatchRUMException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.cloudwatchrum.model.ConflictException extends AWSCloudWatchRUMException implements Serializable

Serialized Fields

resourceName

resourceType

Class com.amazonaws.services.cloudwatchrum.model.CreateAppMonitorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appMonitorConfiguration

cwLogEnabled

domain

name

tags

Class com.amazonaws.services.cloudwatchrum.model.CreateAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

id

Class com.amazonaws.services.cloudwatchrum.model.CwLog extends Object implements Serializable

Serialized Fields

cwLogEnabled

cwLogGroup

Class com.amazonaws.services.cloudwatchrum.model.DataStorage extends Object implements Serializable

Serialized Fields

cwLog

Class com.amazonaws.services.cloudwatchrum.model.DeleteAppMonitorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchrum.model.DeleteAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

maxResults

name

nextToken

timeRange

Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

events

nextToken

Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchrum.model.GetAppMonitorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

appMonitor