| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Rum
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchCreateRumMetricDefinitions
- BatchDeleteRumMetricDefinitions
- BatchGetRumMetricDefinitions (Paginated)
- CreateAppMonitor
- DeleteAppMonitor
- DeleteRumMetricsDestination
- GetAppMonitor
- GetAppMonitorData (Paginated)
- ListAppMonitors (Paginated)
- ListRumMetricsDestinations (Paginated)
- ListTagsForResource
- PutRumEvents
- PutRumMetricsDestination
- TagResource
- UntagResource
- UpdateAppMonitor
- UpdateRumMetricDefinition
- Types
- CustomEventsStatus
- MetricDestination
- StateEnum
- Telemetry
- AppMonitor
- AppMonitorConfiguration
- AppMonitorDetails
- AppMonitorSummary
- BatchCreateRumMetricDefinitionsError
- BatchDeleteRumMetricDefinitionsError
- CustomEvents
- CwLog
- DataStorage
- MetricDefinition
- MetricDefinitionRequest
- MetricDestinationSummary
- QueryFilter
- RumEvent
- TimeRange
- UserDetails
Description
Derived from API version 2018-05-10 of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchCreateRumMetricDefinitions = BatchCreateRumMetricDefinitions' (Maybe Text) Text MetricDestination [MetricDefinitionRequest]
- newBatchCreateRumMetricDefinitions :: Text -> MetricDestination -> BatchCreateRumMetricDefinitions
- data BatchCreateRumMetricDefinitionsResponse = BatchCreateRumMetricDefinitionsResponse' (Maybe [MetricDefinition]) Int [BatchCreateRumMetricDefinitionsError]
- newBatchCreateRumMetricDefinitionsResponse :: Int -> BatchCreateRumMetricDefinitionsResponse
- data BatchDeleteRumMetricDefinitions = BatchDeleteRumMetricDefinitions' (Maybe Text) Text MetricDestination [Text]
- newBatchDeleteRumMetricDefinitions :: Text -> MetricDestination -> BatchDeleteRumMetricDefinitions
- data BatchDeleteRumMetricDefinitionsResponse = BatchDeleteRumMetricDefinitionsResponse' (Maybe [Text]) Int [BatchDeleteRumMetricDefinitionsError]
- newBatchDeleteRumMetricDefinitionsResponse :: Int -> BatchDeleteRumMetricDefinitionsResponse
- data BatchGetRumMetricDefinitions = BatchGetRumMetricDefinitions' (Maybe Text) (Maybe Natural) (Maybe Text) Text MetricDestination
- newBatchGetRumMetricDefinitions :: Text -> MetricDestination -> BatchGetRumMetricDefinitions
- data BatchGetRumMetricDefinitionsResponse = BatchGetRumMetricDefinitionsResponse' (Maybe [MetricDefinition]) (Maybe Text) Int
- newBatchGetRumMetricDefinitionsResponse :: Int -> BatchGetRumMetricDefinitionsResponse
- data CreateAppMonitor = CreateAppMonitor' (Maybe AppMonitorConfiguration) (Maybe CustomEvents) (Maybe Bool) (Maybe (HashMap Text Text)) Text Text
- newCreateAppMonitor :: Text -> Text -> CreateAppMonitor
- data CreateAppMonitorResponse = CreateAppMonitorResponse' (Maybe Text) Int
- newCreateAppMonitorResponse :: Int -> CreateAppMonitorResponse
- data DeleteAppMonitor = DeleteAppMonitor' Text
- newDeleteAppMonitor :: Text -> DeleteAppMonitor
- data DeleteAppMonitorResponse = DeleteAppMonitorResponse' Int
- newDeleteAppMonitorResponse :: Int -> DeleteAppMonitorResponse
- data DeleteRumMetricsDestination = DeleteRumMetricsDestination' (Maybe Text) Text MetricDestination
- newDeleteRumMetricsDestination :: Text -> MetricDestination -> DeleteRumMetricsDestination
- data DeleteRumMetricsDestinationResponse = DeleteRumMetricsDestinationResponse' Int
- newDeleteRumMetricsDestinationResponse :: Int -> DeleteRumMetricsDestinationResponse
- data GetAppMonitor = GetAppMonitor' Text
- newGetAppMonitor :: Text -> GetAppMonitor
- data GetAppMonitorResponse = GetAppMonitorResponse' (Maybe AppMonitor) Int
- newGetAppMonitorResponse :: Int -> GetAppMonitorResponse
- data GetAppMonitorData = GetAppMonitorData' (Maybe [QueryFilter]) (Maybe Natural) (Maybe Text) Text TimeRange
- newGetAppMonitorData :: Text -> TimeRange -> GetAppMonitorData
- data GetAppMonitorDataResponse = GetAppMonitorDataResponse' (Maybe [Text]) (Maybe Text) Int
- newGetAppMonitorDataResponse :: Int -> GetAppMonitorDataResponse
- data ListAppMonitors = ListAppMonitors' (Maybe Natural) (Maybe Text)
- newListAppMonitors :: ListAppMonitors
- data ListAppMonitorsResponse = ListAppMonitorsResponse' (Maybe [AppMonitorSummary]) (Maybe Text) Int
- newListAppMonitorsResponse :: Int -> ListAppMonitorsResponse
- data ListRumMetricsDestinations = ListRumMetricsDestinations' (Maybe Natural) (Maybe Text) Text
- newListRumMetricsDestinations :: Text -> ListRumMetricsDestinations
- data ListRumMetricsDestinationsResponse = ListRumMetricsDestinationsResponse' (Maybe [MetricDestinationSummary]) (Maybe Text) Int
- newListRumMetricsDestinationsResponse :: Int -> ListRumMetricsDestinationsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' Int Text (HashMap Text Text)
- newListTagsForResourceResponse :: Int -> Text -> ListTagsForResourceResponse
- data PutRumEvents = PutRumEvents' AppMonitorDetails Text Text [RumEvent] UserDetails
- newPutRumEvents :: AppMonitorDetails -> Text -> Text -> UserDetails -> PutRumEvents
- data PutRumEventsResponse = PutRumEventsResponse' Int
- newPutRumEventsResponse :: Int -> PutRumEventsResponse
- data PutRumMetricsDestination = PutRumMetricsDestination' (Maybe Text) (Maybe Text) Text MetricDestination
- newPutRumMetricsDestination :: Text -> MetricDestination -> PutRumMetricsDestination
- data PutRumMetricsDestinationResponse = PutRumMetricsDestinationResponse' Int
- newPutRumMetricsDestinationResponse :: Int -> PutRumMetricsDestinationResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAppMonitor = UpdateAppMonitor' (Maybe AppMonitorConfiguration) (Maybe CustomEvents) (Maybe Bool) (Maybe Text) Text
- newUpdateAppMonitor :: Text -> UpdateAppMonitor
- data UpdateAppMonitorResponse = UpdateAppMonitorResponse' Int
- newUpdateAppMonitorResponse :: Int -> UpdateAppMonitorResponse
- data UpdateRumMetricDefinition = UpdateRumMetricDefinition' (Maybe Text) Text MetricDestination MetricDefinitionRequest Text
- newUpdateRumMetricDefinition :: Text -> MetricDestination -> MetricDefinitionRequest -> Text -> UpdateRumMetricDefinition
- data UpdateRumMetricDefinitionResponse = UpdateRumMetricDefinitionResponse' Int
- newUpdateRumMetricDefinitionResponse :: Int -> UpdateRumMetricDefinitionResponse
- newtype CustomEventsStatus where
- newtype MetricDestination where
- MetricDestination' { }
- pattern MetricDestination_CloudWatch :: MetricDestination
- pattern MetricDestination_Evidently :: MetricDestination
- newtype StateEnum where
- StateEnum' { }
- pattern StateEnum_ACTIVE :: StateEnum
- pattern StateEnum_CREATED :: StateEnum
- pattern StateEnum_DELETING :: StateEnum
- newtype Telemetry where
- Telemetry' { }
- pattern Telemetry_Errors :: Telemetry
- pattern Telemetry_Http :: Telemetry
- pattern Telemetry_Performance :: Telemetry
- data AppMonitor = AppMonitor' (Maybe AppMonitorConfiguration) (Maybe Text) (Maybe CustomEvents) (Maybe DataStorage) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StateEnum) (Maybe (HashMap Text Text))
- newAppMonitor :: AppMonitor
- data AppMonitorConfiguration = AppMonitorConfiguration' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Double) (Maybe [Telemetry])
- newAppMonitorConfiguration :: AppMonitorConfiguration
- data AppMonitorDetails = AppMonitorDetails' (Maybe Text) (Maybe Text) (Maybe Text)
- newAppMonitorDetails :: AppMonitorDetails
- data AppMonitorSummary = AppMonitorSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StateEnum)
- newAppMonitorSummary :: AppMonitorSummary
- data BatchCreateRumMetricDefinitionsError = BatchCreateRumMetricDefinitionsError' Text Text MetricDefinitionRequest
- newBatchCreateRumMetricDefinitionsError :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
- data BatchDeleteRumMetricDefinitionsError = BatchDeleteRumMetricDefinitionsError' Text Text Text
- newBatchDeleteRumMetricDefinitionsError :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
- data CustomEvents = CustomEvents' (Maybe CustomEventsStatus)
- newCustomEvents :: CustomEvents
- data CwLog = CwLog' (Maybe Bool) (Maybe Text)
- newCwLog :: CwLog
- data DataStorage = DataStorage' (Maybe CwLog)
- newDataStorage :: DataStorage
- data MetricDefinition = MetricDefinition' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newMetricDefinition :: Text -> Text -> MetricDefinition
- data MetricDefinitionRequest = MetricDefinitionRequest' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newMetricDefinitionRequest :: Text -> MetricDefinitionRequest
- data MetricDestinationSummary = MetricDestinationSummary' (Maybe MetricDestination) (Maybe Text) (Maybe Text)
- newMetricDestinationSummary :: MetricDestinationSummary
- data QueryFilter = QueryFilter' (Maybe Text) (Maybe [Text])
- newQueryFilter :: QueryFilter
- data RumEvent = RumEvent' (Maybe Text) Text Text POSIX Text
- newRumEvent :: Text -> Text -> UTCTime -> Text -> RumEvent
- data TimeRange = TimeRange' (Maybe Integer) Integer
- newTimeRange :: Integer -> TimeRange
- data UserDetails = UserDetails' (Maybe Text) (Maybe Text)
- newUserDetails :: UserDetails
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon CloudWatch RUM SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Rum.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permissions to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
This operation attempted to create a resource that already exists.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Internal service exception.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Resource not found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
This request exceeds a service quota.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was throttled because of quota limits.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
One of the arguments for the request is not valid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchCreateRumMetricDefinitions
data BatchCreateRumMetricDefinitions Source #
See: newBatchCreateRumMetricDefinitions smart constructor.
Constructors
| BatchCreateRumMetricDefinitions' (Maybe Text) Text MetricDestination [MetricDefinitionRequest] |
Instances
newBatchCreateRumMetricDefinitions Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> BatchCreateRumMetricDefinitions |
Create a value of BatchCreateRumMetricDefinitions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_destinationArn - 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.
$sel:appMonitorName:BatchCreateRumMetricDefinitions', batchCreateRumMetricDefinitions_appMonitorName - The name of the CloudWatch RUM app monitor that is to send the metrics.
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_destination - 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.
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_metricDefinitions - An array of structures which define the metrics that you want to send.
data BatchCreateRumMetricDefinitionsResponse Source #
See: newBatchCreateRumMetricDefinitionsResponse smart constructor.
Constructors
| BatchCreateRumMetricDefinitionsResponse' (Maybe [MetricDefinition]) Int [BatchCreateRumMetricDefinitionsError] |
Instances
newBatchCreateRumMetricDefinitionsResponse Source #
Arguments
| :: Int | |
| -> BatchCreateRumMetricDefinitionsResponse |
Create a value of BatchCreateRumMetricDefinitionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitionsResponse_metricDefinitions - An array of structures that define the extended metrics.
$sel:httpStatus:BatchCreateRumMetricDefinitionsResponse', batchCreateRumMetricDefinitionsResponse_httpStatus - The response's http status code.
$sel:errors:BatchCreateRumMetricDefinitionsResponse', batchCreateRumMetricDefinitionsResponse_errors - An array of error objects, if the operation caused any errors.
BatchDeleteRumMetricDefinitions
data BatchDeleteRumMetricDefinitions Source #
See: newBatchDeleteRumMetricDefinitions smart constructor.
Constructors
| BatchDeleteRumMetricDefinitions' (Maybe Text) Text MetricDestination [Text] |
Instances
newBatchDeleteRumMetricDefinitions Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> BatchDeleteRumMetricDefinitions |
Create a value of BatchDeleteRumMetricDefinitions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_destinationArn - 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.
$sel:appMonitorName:BatchDeleteRumMetricDefinitions', batchDeleteRumMetricDefinitions_appMonitorName - The name of the CloudWatch RUM app monitor that is sending these
metrics.
BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_destination - 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.
BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_metricDefinitionIds - An array of structures which define the metrics that you want to stop
sending.
data BatchDeleteRumMetricDefinitionsResponse Source #
See: newBatchDeleteRumMetricDefinitionsResponse smart constructor.
Constructors
| BatchDeleteRumMetricDefinitionsResponse' (Maybe [Text]) Int [BatchDeleteRumMetricDefinitionsError] |
Instances
newBatchDeleteRumMetricDefinitionsResponse Source #
Arguments
| :: Int | |
| -> BatchDeleteRumMetricDefinitionsResponse |
Create a value of BatchDeleteRumMetricDefinitionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds - The IDs of the metric definitions that were deleted.
$sel:httpStatus:BatchDeleteRumMetricDefinitionsResponse', batchDeleteRumMetricDefinitionsResponse_httpStatus - The response's http status code.
$sel:errors:BatchDeleteRumMetricDefinitionsResponse', batchDeleteRumMetricDefinitionsResponse_errors - An array of error objects, if the operation caused any errors.
BatchGetRumMetricDefinitions (Paginated)
data BatchGetRumMetricDefinitions Source #
See: newBatchGetRumMetricDefinitions smart constructor.
Constructors
| BatchGetRumMetricDefinitions' (Maybe Text) (Maybe Natural) (Maybe Text) Text MetricDestination |
Instances
newBatchGetRumMetricDefinitions Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> BatchGetRumMetricDefinitions |
Create a value of BatchGetRumMetricDefinitions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchGetRumMetricDefinitions, batchGetRumMetricDefinitions_destinationArn - 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.
$sel:maxResults:BatchGetRumMetricDefinitions', batchGetRumMetricDefinitions_maxResults - 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.
BatchGetRumMetricDefinitions, batchGetRumMetricDefinitions_nextToken - Use the token returned by the previous operation to request the next
page of results.
$sel:appMonitorName:BatchGetRumMetricDefinitions', batchGetRumMetricDefinitions_appMonitorName - The name of the CloudWatch RUM app monitor that is sending the metrics.
BatchGetRumMetricDefinitions, batchGetRumMetricDefinitions_destination - The type of destination that you want to view metrics for. Valid values
are CloudWatch and Evidently.
data BatchGetRumMetricDefinitionsResponse Source #
See: newBatchGetRumMetricDefinitionsResponse smart constructor.
Constructors
| BatchGetRumMetricDefinitionsResponse' (Maybe [MetricDefinition]) (Maybe Text) Int |
Instances
newBatchGetRumMetricDefinitionsResponse Source #
Arguments
| :: Int | |
| -> BatchGetRumMetricDefinitionsResponse |
Create a value of BatchGetRumMetricDefinitionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDefinitions:BatchGetRumMetricDefinitionsResponse', batchGetRumMetricDefinitionsResponse_metricDefinitions - An array of structures that display information about the metrics that
are sent by the specified app monitor to the specified destination.
BatchGetRumMetricDefinitions, batchGetRumMetricDefinitionsResponse_nextToken - A token that you can use in a subsequent operation to retrieve the next
set of results.
$sel:httpStatus:BatchGetRumMetricDefinitionsResponse', batchGetRumMetricDefinitionsResponse_httpStatus - The response's http status code.
CreateAppMonitor
data CreateAppMonitor Source #
See: newCreateAppMonitor smart constructor.
Constructors
| CreateAppMonitor' (Maybe AppMonitorConfiguration) (Maybe CustomEvents) (Maybe Bool) (Maybe (HashMap Text Text)) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateAppMonitor |
Create a value of CreateAppMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAppMonitor, createAppMonitor_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.
CreateAppMonitor, createAppMonitor_customEvents - 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.
CreateAppMonitor, createAppMonitor_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.
CreateAppMonitor, createAppMonitor_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 Tagging Amazon Web Services resources.
CreateAppMonitor, createAppMonitor_domain - The top-level internet domain name for which your application has
administrative authority.
CreateAppMonitor, createAppMonitor_name - A name for the app monitor.
data CreateAppMonitorResponse Source #
See: newCreateAppMonitorResponse smart constructor.
Constructors
| CreateAppMonitorResponse' (Maybe Text) Int |
Instances
newCreateAppMonitorResponse Source #
Create a value of CreateAppMonitorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAppMonitorResponse, createAppMonitorResponse_id - The unique ID of the new app monitor.
$sel:httpStatus:CreateAppMonitorResponse', createAppMonitorResponse_httpStatus - The response's http status code.
DeleteAppMonitor
data DeleteAppMonitor Source #
See: newDeleteAppMonitor smart constructor.
Constructors
| DeleteAppMonitor' Text |
Instances
Arguments
| :: Text | |
| -> DeleteAppMonitor |
Create a value of DeleteAppMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAppMonitor, deleteAppMonitor_name - The name of the app monitor to delete.
data DeleteAppMonitorResponse Source #
See: newDeleteAppMonitorResponse smart constructor.
Constructors
| DeleteAppMonitorResponse' Int |
Instances
newDeleteAppMonitorResponse Source #
Create a value of DeleteAppMonitorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAppMonitorResponse', deleteAppMonitorResponse_httpStatus - The response's http status code.
DeleteRumMetricsDestination
data DeleteRumMetricsDestination Source #
See: newDeleteRumMetricsDestination smart constructor.
Constructors
| DeleteRumMetricsDestination' (Maybe Text) Text MetricDestination |
Instances
newDeleteRumMetricsDestination Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> DeleteRumMetricsDestination |
Create a value of DeleteRumMetricsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteRumMetricsDestination, deleteRumMetricsDestination_destinationArn - 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.
$sel:appMonitorName:DeleteRumMetricsDestination', deleteRumMetricsDestination_appMonitorName - The name of the app monitor that is sending metrics to the destination
that you want to delete.
DeleteRumMetricsDestination, deleteRumMetricsDestination_destination - The type of destination to delete. Valid values are CloudWatch and
Evidently.
data DeleteRumMetricsDestinationResponse Source #
See: newDeleteRumMetricsDestinationResponse smart constructor.
Constructors
| DeleteRumMetricsDestinationResponse' Int |
Instances
newDeleteRumMetricsDestinationResponse Source #
Arguments
| :: Int | |
| -> DeleteRumMetricsDestinationResponse |
Create a value of DeleteRumMetricsDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteRumMetricsDestinationResponse', deleteRumMetricsDestinationResponse_httpStatus - The response's http status code.
GetAppMonitor
data GetAppMonitor Source #
See: newGetAppMonitor smart constructor.
Constructors
| GetAppMonitor' Text |
Instances
Arguments
| :: Text | |
| -> GetAppMonitor |
Create a value of GetAppMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAppMonitor, getAppMonitor_name - The app monitor to retrieve information for.
data GetAppMonitorResponse Source #
See: newGetAppMonitorResponse smart constructor.
Constructors
| GetAppMonitorResponse' (Maybe AppMonitor) Int |
Instances
newGetAppMonitorResponse Source #
Create a value of GetAppMonitorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appMonitor:GetAppMonitorResponse', getAppMonitorResponse_appMonitor - A structure containing all the configuration information for the app
monitor.
$sel:httpStatus:GetAppMonitorResponse', getAppMonitorResponse_httpStatus - The response's http status code.
GetAppMonitorData (Paginated)
data GetAppMonitorData Source #
See: newGetAppMonitorData smart constructor.
Constructors
| GetAppMonitorData' (Maybe [QueryFilter]) (Maybe Natural) (Maybe Text) Text TimeRange |
Instances
Create a value of GetAppMonitorData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:GetAppMonitorData', getAppMonitorData_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.
$sel:maxResults:GetAppMonitorData', getAppMonitorData_maxResults - The maximum number of results to return in one operation.
GetAppMonitorData, getAppMonitorData_nextToken - Use the token returned by the previous operation to request the next
page of results.
GetAppMonitorData, getAppMonitorData_name - The name of the app monitor that collected the data that you want to
retrieve.
$sel:timeRange:GetAppMonitorData', getAppMonitorData_timeRange - A structure that defines the time range that you want to retrieve
results from.
data GetAppMonitorDataResponse Source #
See: newGetAppMonitorDataResponse smart constructor.
Instances
newGetAppMonitorDataResponse Source #
Create a value of GetAppMonitorDataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:GetAppMonitorDataResponse', getAppMonitorDataResponse_events - The events that RUM collected that match your request.
GetAppMonitorData, getAppMonitorDataResponse_nextToken - A token that you can use in a subsequent operation to retrieve the next
set of results.
$sel:httpStatus:GetAppMonitorDataResponse', getAppMonitorDataResponse_httpStatus - The response's http status code.
ListAppMonitors (Paginated)
data ListAppMonitors Source #
See: newListAppMonitors smart constructor.
Constructors
| ListAppMonitors' (Maybe Natural) (Maybe Text) |
Instances
newListAppMonitors :: ListAppMonitors Source #
Create a value of ListAppMonitors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAppMonitors', listAppMonitors_maxResults - The maximum number of results to return in one operation. The default is
50. The maximum that you can specify is 100.
ListAppMonitors, listAppMonitors_nextToken - Use the token returned by the previous operation to request the next
page of results.
data ListAppMonitorsResponse Source #
See: newListAppMonitorsResponse smart constructor.
Constructors
| ListAppMonitorsResponse' (Maybe [AppMonitorSummary]) (Maybe Text) Int |
Instances
newListAppMonitorsResponse Source #
Create a value of ListAppMonitorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appMonitorSummaries:ListAppMonitorsResponse', listAppMonitorsResponse_appMonitorSummaries - An array of structures that contain information about the returned app
monitors.
ListAppMonitors, listAppMonitorsResponse_nextToken - A token that you can use in a subsequent operation to retrieve the next
set of results.
$sel:httpStatus:ListAppMonitorsResponse', listAppMonitorsResponse_httpStatus - The response's http status code.
ListRumMetricsDestinations (Paginated)
data ListRumMetricsDestinations Source #
See: newListRumMetricsDestinations smart constructor.
Instances
newListRumMetricsDestinations Source #
Create a value of ListRumMetricsDestinations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRumMetricsDestinations', listRumMetricsDestinations_maxResults - 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.
ListRumMetricsDestinations, listRumMetricsDestinations_nextToken - Use the token returned by the previous operation to request the next
page of results.
$sel:appMonitorName:ListRumMetricsDestinations', listRumMetricsDestinations_appMonitorName - The name of the app monitor associated with the destinations that you
want to retrieve.
data ListRumMetricsDestinationsResponse Source #
See: newListRumMetricsDestinationsResponse smart constructor.
Constructors
| ListRumMetricsDestinationsResponse' (Maybe [MetricDestinationSummary]) (Maybe Text) Int |
Instances
newListRumMetricsDestinationsResponse Source #
Arguments
| :: Int | |
| -> ListRumMetricsDestinationsResponse |
Create a value of ListRumMetricsDestinationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinations:ListRumMetricsDestinationsResponse', listRumMetricsDestinationsResponse_destinations - The list of CloudWatch RUM extended metrics destinations associated with
the app monitor that you specified.
ListRumMetricsDestinations, listRumMetricsDestinationsResponse_nextToken - A token that you can use in a subsequent operation to retrieve the next
set of results.
$sel:httpStatus:ListRumMetricsDestinationsResponse', listRumMetricsDestinationsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResource_resourceArn - The ARN of the resource that you want to see the tags of.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> ListTagsForResourceResponse |
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTagsForResource, listTagsForResourceResponse_resourceArn - The ARN of the resource that you are viewing.
ListTagsForResourceResponse, listTagsForResourceResponse_tags - The list of tag keys and values associated with the resource you
specified.
PutRumEvents
data PutRumEvents Source #
See: newPutRumEvents smart constructor.
Constructors
| PutRumEvents' AppMonitorDetails Text Text [RumEvent] UserDetails |
Instances
Arguments
| :: AppMonitorDetails | |
| -> Text | |
| -> Text | |
| -> UserDetails | |
| -> PutRumEvents |
Create a value of PutRumEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appMonitorDetails:PutRumEvents', putRumEvents_appMonitorDetails - A structure that contains information about the app monitor that
collected this telemetry information.
$sel:batchId:PutRumEvents', putRumEvents_batchId - A unique identifier for this batch of RUM event data.
PutRumEvents, putRumEvents_id - The ID of the app monitor that is sending this data.
$sel:rumEvents:PutRumEvents', putRumEvents_rumEvents - An array of structures that contain the telemetry event data.
$sel:userDetails:PutRumEvents', putRumEvents_userDetails - A structure that contains information about the user session that this
batch of events was collected from.
data PutRumEventsResponse Source #
See: newPutRumEventsResponse smart constructor.
Constructors
| PutRumEventsResponse' Int |
Instances
newPutRumEventsResponse Source #
Arguments
| :: Int | |
| -> PutRumEventsResponse |
Create a value of PutRumEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutRumEventsResponse', putRumEventsResponse_httpStatus - The response's http status code.
PutRumMetricsDestination
data PutRumMetricsDestination Source #
See: newPutRumMetricsDestination smart constructor.
Constructors
| PutRumMetricsDestination' (Maybe Text) (Maybe Text) Text MetricDestination |
Instances
newPutRumMetricsDestination Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> PutRumMetricsDestination |
Create a value of PutRumMetricsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutRumMetricsDestination, putRumMetricsDestination_destinationArn - Use this parameter only if Destination is Evidently. This parameter
specifies the ARN of the Evidently experiment that will receive the
extended metrics.
PutRumMetricsDestination, putRumMetricsDestination_iamRoleArn - This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not 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.
$sel:appMonitorName:PutRumMetricsDestination', putRumMetricsDestination_appMonitorName - The name of the CloudWatch RUM app monitor that will send the metrics.
PutRumMetricsDestination, putRumMetricsDestination_destination - 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.
data PutRumMetricsDestinationResponse Source #
See: newPutRumMetricsDestinationResponse smart constructor.
Constructors
| PutRumMetricsDestinationResponse' Int |
Instances
newPutRumMetricsDestinationResponse Source #
Create a value of PutRumMetricsDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutRumMetricsDestinationResponse', putRumMetricsDestinationResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The ARN of the CloudWatch RUM resource that you're adding tags to.
TagResource, tagResource_tags - The list of key-value pairs to associate with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the CloudWatch RUM resource that you're removing tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateAppMonitor
data UpdateAppMonitor Source #
See: newUpdateAppMonitor smart constructor.
Constructors
| UpdateAppMonitor' (Maybe AppMonitorConfiguration) (Maybe CustomEvents) (Maybe Bool) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateAppMonitor |
Create a value of UpdateAppMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAppMonitor, updateAppMonitor_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.
UpdateAppMonitor, updateAppMonitor_customEvents - 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.
UpdateAppMonitor, updateAppMonitor_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.
UpdateAppMonitor, updateAppMonitor_domain - The top-level internet domain name for which your application has
administrative authority.
UpdateAppMonitor, updateAppMonitor_name - The name of the app monitor to update.
data UpdateAppMonitorResponse Source #
See: newUpdateAppMonitorResponse smart constructor.
Constructors
| UpdateAppMonitorResponse' Int |
Instances
newUpdateAppMonitorResponse Source #
Create a value of UpdateAppMonitorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAppMonitorResponse', updateAppMonitorResponse_httpStatus - The response's http status code.
UpdateRumMetricDefinition
data UpdateRumMetricDefinition Source #
See: newUpdateRumMetricDefinition smart constructor.
Constructors
| UpdateRumMetricDefinition' (Maybe Text) Text MetricDestination MetricDefinitionRequest Text |
Instances
newUpdateRumMetricDefinition Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> MetricDefinitionRequest | |
| -> Text | |
| -> UpdateRumMetricDefinition |
Create a value of UpdateRumMetricDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRumMetricDefinition, updateRumMetricDefinition_destinationArn - 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.
$sel:appMonitorName:UpdateRumMetricDefinition', updateRumMetricDefinition_appMonitorName - The name of the CloudWatch RUM app monitor that sends these metrics.
UpdateRumMetricDefinition, updateRumMetricDefinition_destination - 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.
UpdateRumMetricDefinition, updateRumMetricDefinition_metricDefinition - A structure that contains the new definition that you want to use for
this metric.
UpdateRumMetricDefinition, updateRumMetricDefinition_metricDefinitionId - The ID of the metric definition to update.
data UpdateRumMetricDefinitionResponse Source #
See: newUpdateRumMetricDefinitionResponse smart constructor.
Constructors
| UpdateRumMetricDefinitionResponse' Int |
Instances
newUpdateRumMetricDefinitionResponse Source #
Arguments
| :: Int | |
| -> UpdateRumMetricDefinitionResponse |
Create a value of UpdateRumMetricDefinitionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRumMetricDefinitionResponse', updateRumMetricDefinitionResponse_httpStatus - The response's http status code.
Types
CustomEventsStatus
newtype CustomEventsStatus Source #
Constructors
| CustomEventsStatus' | |
Fields | |
Bundled Patterns
| pattern CustomEventsStatus_DISABLED :: CustomEventsStatus | |
| pattern CustomEventsStatus_ENABLED :: CustomEventsStatus |
Instances
MetricDestination
newtype MetricDestination Source #
Constructors
| MetricDestination' | |
Fields | |
Bundled Patterns
| pattern MetricDestination_CloudWatch :: MetricDestination | |
| pattern MetricDestination_Evidently :: MetricDestination |
Instances
StateEnum
Constructors
| StateEnum' | |
Fields | |
Bundled Patterns
| pattern StateEnum_ACTIVE :: StateEnum | |
| pattern StateEnum_CREATED :: StateEnum | |
| pattern StateEnum_DELETING :: StateEnum |
Instances
Telemetry
Constructors
| Telemetry' | |
Fields | |
Bundled Patterns
| pattern Telemetry_Errors :: Telemetry | |
| pattern Telemetry_Http :: Telemetry | |
| pattern Telemetry_Performance :: Telemetry |
Instances
AppMonitor
data AppMonitor Source #
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.
See: newAppMonitor smart constructor.
Constructors
| AppMonitor' (Maybe AppMonitorConfiguration) (Maybe Text) (Maybe CustomEvents) (Maybe DataStorage) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StateEnum) (Maybe (HashMap Text Text)) |
Instances
newAppMonitor :: AppMonitor Source #
Create a value of AppMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appMonitorConfiguration:AppMonitor', appMonitor_appMonitorConfiguration - A structure that contains much of the configuration data for the app
monitor.
$sel:created:AppMonitor', appMonitor_created - The date and time that this app monitor was created.
$sel:customEvents:AppMonitor', appMonitor_customEvents - 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.
$sel:dataStorage:AppMonitor', appMonitor_dataStorage - A structure that contains information about whether this app monitor
stores a copy of the telemetry data that RUM collects using CloudWatch
Logs.
$sel:domain:AppMonitor', appMonitor_domain - The top-level internet domain name for which your application has
administrative authority.
$sel:id:AppMonitor', appMonitor_id - The unique ID of this app monitor.
$sel:lastModified:AppMonitor', appMonitor_lastModified - The date and time of the most recent changes to this app monitor's
configuration.
$sel:name:AppMonitor', appMonitor_name - The name of the app monitor.
$sel:state:AppMonitor', appMonitor_state - The current state of the app monitor.
$sel:tags:AppMonitor', appMonitor_tags - The list of tag keys and values associated with this app monitor.
AppMonitorConfiguration
data AppMonitorConfiguration Source #
This structure contains much of the configuration data for the app monitor.
See: newAppMonitorConfiguration smart constructor.
Constructors
| AppMonitorConfiguration' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Double) (Maybe [Telemetry]) |
Instances
newAppMonitorConfiguration :: AppMonitorConfiguration Source #
Create a value of AppMonitorConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowCookies:AppMonitorConfiguration', appMonitorConfiguration_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.
$sel:enableXRay:AppMonitorConfiguration', appMonitorConfiguration_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?
$sel:excludedPages:AppMonitorConfiguration', appMonitorConfiguration_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.
$sel:favoritePages:AppMonitorConfiguration', appMonitorConfiguration_favoritePages - A list of pages in your application that are to be displayed with a
"favorite" icon in the CloudWatch RUM console.
$sel:guestRoleArn:AppMonitorConfiguration', appMonitorConfiguration_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.
$sel:identityPoolId:AppMonitorConfiguration', appMonitorConfiguration_identityPoolId - The ID of the Amazon Cognito identity pool that is used to authorize the
sending of data to RUM.
$sel:includedPages:AppMonitorConfiguration', appMonitorConfiguration_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 ExcludedPages and IncludedPages in the same
operation.
$sel:sessionSampleRate:AppMonitorConfiguration', appMonitorConfiguration_sessionSampleRate - 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.
$sel:telemetries:AppMonitorConfiguration', appMonitorConfiguration_telemetries - An array that lists the types of telemetry data that this app monitor is
to collect.
errorsindicates that RUM collects data about unhandled JavaScript errors raised by your application.performanceindicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.httpindicates that RUM collects data about HTTP errors thrown by your application.
AppMonitorDetails
data AppMonitorDetails Source #
A structure that contains information about the RUM app monitor.
See: newAppMonitorDetails smart constructor.
Instances
newAppMonitorDetails :: AppMonitorDetails Source #
Create a value of AppMonitorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:AppMonitorDetails', appMonitorDetails_id - The unique ID of the app monitor.
$sel:name:AppMonitorDetails', appMonitorDetails_name - The name of the app monitor.
$sel:version:AppMonitorDetails', appMonitorDetails_version - The version of the app monitor.
AppMonitorSummary
data AppMonitorSummary Source #
A structure that includes some data about app monitors and their settings.
See: newAppMonitorSummary smart constructor.
Constructors
| AppMonitorSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StateEnum) |
Instances
newAppMonitorSummary :: AppMonitorSummary Source #
Create a value of AppMonitorSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:created:AppMonitorSummary', appMonitorSummary_created - The date and time that the app monitor was created.
$sel:id:AppMonitorSummary', appMonitorSummary_id - The unique ID of this app monitor.
$sel:lastModified:AppMonitorSummary', appMonitorSummary_lastModified - The date and time of the most recent changes to this app monitor's
configuration.
$sel:name:AppMonitorSummary', appMonitorSummary_name - The name of this app monitor.
$sel:state:AppMonitorSummary', appMonitorSummary_state - The current state of this app monitor.
BatchCreateRumMetricDefinitionsError
data BatchCreateRumMetricDefinitionsError Source #
A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.
See: newBatchCreateRumMetricDefinitionsError smart constructor.
Instances
newBatchCreateRumMetricDefinitionsError Source #
Arguments
| :: Text | |
| -> Text | |
| -> MetricDefinitionRequest | |
| -> BatchCreateRumMetricDefinitionsError |
Create a value of BatchCreateRumMetricDefinitionsError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchCreateRumMetricDefinitionsError', batchCreateRumMetricDefinitionsError_errorCode - The error code.
$sel:errorMessage:BatchCreateRumMetricDefinitionsError', batchCreateRumMetricDefinitionsError_errorMessage - The error message for this metric definition.
$sel:metricDefinition:BatchCreateRumMetricDefinitionsError', batchCreateRumMetricDefinitionsError_metricDefinition - The metric definition that caused this error.
BatchDeleteRumMetricDefinitionsError
data BatchDeleteRumMetricDefinitionsError Source #
A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.
See: newBatchDeleteRumMetricDefinitionsError smart constructor.
Constructors
| BatchDeleteRumMetricDefinitionsError' Text Text Text |
Instances
newBatchDeleteRumMetricDefinitionsError Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text |
|
| -> BatchDeleteRumMetricDefinitionsError |
Create a value of BatchDeleteRumMetricDefinitionsError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchDeleteRumMetricDefinitionsError', batchDeleteRumMetricDefinitionsError_errorCode - The error code.
$sel:errorMessage:BatchDeleteRumMetricDefinitionsError', batchDeleteRumMetricDefinitionsError_errorMessage - The error message for this metric definition.
$sel:metricDefinitionId:BatchDeleteRumMetricDefinitionsError', batchDeleteRumMetricDefinitionsError_metricDefinitionId - The ID of the metric definition that caused this error.
CustomEvents
data CustomEvents Source #
A structure that contains information about custom events for this app monitor.
See: newCustomEvents smart constructor.
Constructors
| CustomEvents' (Maybe CustomEventsStatus) |
Instances
newCustomEvents :: CustomEvents Source #
Create a value of CustomEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:CustomEvents', customEvents_status - Specifies whether this app monitor allows the web client to define and
send custom events. The default is for custom events to be DISABLED.
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.
See: newCwLog smart constructor.
Instances
| FromJSON CwLog Source # | |
| Generic CwLog Source # | |
| Read CwLog Source # | |
| Show CwLog Source # | |
| NFData CwLog Source # | |
Defined in Amazonka.Rum.Types.CwLog | |
| Eq CwLog Source # | |
| Hashable CwLog Source # | |
Defined in Amazonka.Rum.Types.CwLog | |
| type Rep CwLog Source # | |
Defined in Amazonka.Rum.Types.CwLog type Rep CwLog = D1 ('MetaData "CwLog" "Amazonka.Rum.Types.CwLog" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "CwLog'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cwLogEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cwLogGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of CwLog with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cwLogEnabled:CwLog', cwLog_cwLogEnabled - Indicated whether the app monitor stores copies of the data that RUM
collects in CloudWatch Logs.
$sel:cwLogGroup:CwLog', cwLog_cwLogGroup - The name of the log group where the copies are stored.
DataStorage
data DataStorage Source #
A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.
See: newDataStorage smart constructor.
Constructors
| DataStorage' (Maybe CwLog) |
Instances
newDataStorage :: DataStorage Source #
Create a value of DataStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cwLog:DataStorage', dataStorage_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.
MetricDefinition
data MetricDefinition Source #
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.
See: newMetricDefinition smart constructor.
Constructors
| MetricDefinition' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MetricDefinition |
Create a value of MetricDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionKeys:MetricDefinition', metricDefinition_dimensionKeys - 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.
$sel:eventPattern:MetricDefinition', metricDefinition_eventPattern - 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.
$sel:unitLabel:MetricDefinition', metricDefinition_unitLabel - Use this field only if you are sending this metric to CloudWatch. It
defines the CloudWatch metric unit that this metric is measured in.
$sel:valueKey:MetricDefinition', metricDefinition_valueKey - The field within the event object that the metric value is sourced from.
$sel:metricDefinitionId:MetricDefinition', metricDefinition_metricDefinitionId - The ID of this metric definition.
$sel:name:MetricDefinition', metricDefinition_name - The name of the metric that is defined in this structure.
MetricDefinitionRequest
data MetricDefinitionRequest Source #
Use this structure to define one extended metric that RUM will send to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.
Only certain combinations of values for Name, ValueKey, and
EventPattern are valid. In addition to what is displayed in the list
below, the EventPattern can also include information used by the
DimensionKeys field.
- If
NameisPerformanceNavigationDuration, thenValueKeymust beevent_details.durationand theEventPatternmust include{"event_type":["com.amazon.rum.performance_navigation_event"]} - If
NameisPerformanceResourceDuration, thenValueKeymust beevent_details.durationand theEventPatternmust include{"event_type":["com.amazon.rum.performance_resource_event"]} - If
NameisNavigationSatisfiedTransaction, thenValueKeymust be null and theEventPatternmust include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">",2000] }] } } - If
NameisNavigationToleratedTransaction, thenValueKeymust be null and theEventPatternmust include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } } - If
NameisNavigationFrustratedTransaction, thenValueKeymust be null and theEventPatternmust include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",8000] }] } } - If
NameisWebVitalsCumulativeLayoutShift, thenValueKeymust beevent_details.valueand theEventPatternmust include{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]} - If
NameisWebVitalsFirstInputDelay, thenValueKeymust beevent_details.valueand theEventPatternmust include{"event_type":["com.amazon.rum.first_input_delay_event"]} - If
NameisWebVitalsLargestContentfulPaint, thenValueKeymust beevent_details.valueand theEventPatternmust include{"event_type":["com.amazon.rum.largest_contentful_paint_event"]} - If
NameisJsErrorCount, thenValueKeymust be null and theEventPatternmust include{"event_type":["com.amazon.rum.js_error_event"]} - If
NameisHttpErrorCount, thenValueKeymust be null and theEventPatternmust include{"event_type":["com.amazon.rum.http_event"]} - If
NameisSessionCount, thenValueKeymust be null and theEventPatternmust include{"event_type":["com.amazon.rum.session_start_event"]}
See: newMetricDefinitionRequest smart constructor.
Constructors
| MetricDefinitionRequest' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
newMetricDefinitionRequest Source #
Create a value of MetricDefinitionRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionKeys:MetricDefinitionRequest', metricDefinitionRequest_dimensionKeys - 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. Valid values for the entries in this field are the following:
"metadata.pageId": "PageId"
"metadata.browserName": "BrowserName"
"metadata.deviceType": "DeviceType"
"metadata.osName": "OSName"
"metadata.countryCode": "CountryCode"
"event_details.fileType": "FileType"
All dimensions listed in this field must also be included in
EventPattern.
$sel:eventPattern:MetricDefinitionRequest', metricDefinitionRequest_eventPattern - 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:
'{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }''{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }''{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
If the metrics destination' is CloudWatch and the event also matches
a value in DimensionKeys, then the metric is published with the
specified dimensions.
$sel:unitLabel:MetricDefinitionRequest', metricDefinitionRequest_unitLabel - The CloudWatch metric unit to use for this metric. If you omit this
field, the metric is recorded with no unit.
$sel:valueKey:MetricDefinitionRequest', metricDefinitionRequest_valueKey - 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 just 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 and Evidently will handle data extraction from the event.
$sel:name:MetricDefinitionRequest', metricDefinitionRequest_name - The name for the metric that is defined in this structure. Valid values
are the following:
PerformanceNavigationDuration
PerformanceResourceDuration
NavigationSatisfiedTransaction
NavigationToleratedTransaction
NavigationFrustratedTransaction
WebVitalsCumulativeLayoutShift
WebVitalsFirstInputDelay
WebVitalsLargestContentfulPaint
JsErrorCount
HttpErrorCount
SessionCount
MetricDestinationSummary
data MetricDestinationSummary Source #
A structure that displays information about one destination that CloudWatch RUM sends extended metrics to.
See: newMetricDestinationSummary smart constructor.
Constructors
| MetricDestinationSummary' (Maybe MetricDestination) (Maybe Text) (Maybe Text) |
Instances
newMetricDestinationSummary :: MetricDestinationSummary Source #
Create a value of MetricDestinationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:MetricDestinationSummary', metricDestinationSummary_destination - Specifies whether the destination is CloudWatch or Evidently.
$sel:destinationArn:MetricDestinationSummary', metricDestinationSummary_destinationArn - If the destination is Evidently, this specifies the ARN of the
Evidently experiment that receives the metrics.
$sel:iamRoleArn:MetricDestinationSummary', metricDestinationSummary_iamRoleArn - 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.
QueryFilter
data QueryFilter Source #
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.
See: newQueryFilter smart constructor.
Constructors
| QueryFilter' (Maybe Text) (Maybe [Text]) |
Instances
newQueryFilter :: QueryFilter Source #
Create a value of QueryFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:QueryFilter', queryFilter_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
$sel:values:QueryFilter', queryFilter_values - The values of the Name that are to be be included in the returned
results.
RumEvent
A structure that contains the information for one performance event that RUM collects from a user session with your application.
See: newRumEvent smart constructor.
Instances
Create a value of RumEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metadata:RumEvent', rumEvent_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.
$sel:details:RumEvent', rumEvent_details - A string containing details about the event.
$sel:id:RumEvent', rumEvent_id - A unique ID for this event.
$sel:timestamp:RumEvent', rumEvent_timestamp - The exact time that this event occurred.
$sel:type':RumEvent', rumEvent_type - The JSON schema that denotes the type of event this is, such as a page
load or a new session.
TimeRange
A structure that defines the time range that you want to retrieve results from.
See: newTimeRange smart constructor.
Constructors
| TimeRange' (Maybe Integer) Integer |
Instances
| ToJSON TimeRange Source # | |
Defined in Amazonka.Rum.Types.TimeRange | |
| Generic TimeRange Source # | |
| Read TimeRange Source # | |
| Show TimeRange Source # | |
| NFData TimeRange Source # | |
Defined in Amazonka.Rum.Types.TimeRange | |
| Eq TimeRange Source # | |
| Hashable TimeRange Source # | |
Defined in Amazonka.Rum.Types.TimeRange | |
| type Rep TimeRange Source # | |
Defined in Amazonka.Rum.Types.TimeRange type Rep TimeRange = D1 ('MetaData "TimeRange" "Amazonka.Rum.Types.TimeRange" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "TimeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) | |
Create a value of TimeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:before:TimeRange', timeRange_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.
$sel:after:TimeRange', timeRange_after - The beginning of the time range to retrieve performance events from.
UserDetails
data UserDetails Source #
A structure that contains information about the user session that this batch of events was collected from.
See: newUserDetails smart constructor.
Constructors
| UserDetails' (Maybe Text) (Maybe Text) |
Instances
newUserDetails :: UserDetails Source #
Create a value of UserDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:UserDetails', userDetails_sessionId - The session ID that the performance events are from.
$sel:userId:UserDetails', userDetails_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.