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 |
- Operations
- BatchCreateRumMetricDefinitions
- BatchDeleteRumMetricDefinitions
- BatchGetRumMetricDefinitions
- CreateAppMonitor
- DeleteAppMonitor
- DeleteRumMetricsDestination
- GetAppMonitor
- GetAppMonitorData
- ListAppMonitors
- ListRumMetricsDestinations
- ListTagsForResource
- PutRumEvents
- PutRumMetricsDestination
- TagResource
- UntagResource
- UpdateAppMonitor
- UpdateRumMetricDefinition
- Types
Synopsis
- batchCreateRumMetricDefinitions_destinationArn :: Lens' BatchCreateRumMetricDefinitions (Maybe Text)
- batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text
- batchCreateRumMetricDefinitions_destination :: Lens' BatchCreateRumMetricDefinitions MetricDestination
- batchCreateRumMetricDefinitions_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest]
- batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition])
- batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int
- batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError]
- batchDeleteRumMetricDefinitions_destinationArn :: Lens' BatchDeleteRumMetricDefinitions (Maybe Text)
- batchDeleteRumMetricDefinitions_appMonitorName :: Lens' BatchDeleteRumMetricDefinitions Text
- batchDeleteRumMetricDefinitions_destination :: Lens' BatchDeleteRumMetricDefinitions MetricDestination
- batchDeleteRumMetricDefinitions_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitions [Text]
- batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitionsResponse (Maybe [Text])
- batchDeleteRumMetricDefinitionsResponse_httpStatus :: Lens' BatchDeleteRumMetricDefinitionsResponse Int
- batchDeleteRumMetricDefinitionsResponse_errors :: Lens' BatchDeleteRumMetricDefinitionsResponse [BatchDeleteRumMetricDefinitionsError]
- batchGetRumMetricDefinitions_destinationArn :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
- batchGetRumMetricDefinitions_maxResults :: Lens' BatchGetRumMetricDefinitions (Maybe Natural)
- batchGetRumMetricDefinitions_nextToken :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
- batchGetRumMetricDefinitions_appMonitorName :: Lens' BatchGetRumMetricDefinitions Text
- batchGetRumMetricDefinitions_destination :: Lens' BatchGetRumMetricDefinitions MetricDestination
- batchGetRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe [MetricDefinition])
- batchGetRumMetricDefinitionsResponse_nextToken :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe Text)
- batchGetRumMetricDefinitionsResponse_httpStatus :: Lens' BatchGetRumMetricDefinitionsResponse Int
- createAppMonitor_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration)
- createAppMonitor_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents)
- createAppMonitor_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool)
- createAppMonitor_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text))
- createAppMonitor_domain :: Lens' CreateAppMonitor Text
- createAppMonitor_name :: Lens' CreateAppMonitor Text
- createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text)
- createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int
- deleteAppMonitor_name :: Lens' DeleteAppMonitor Text
- deleteAppMonitorResponse_httpStatus :: Lens' DeleteAppMonitorResponse Int
- deleteRumMetricsDestination_destinationArn :: Lens' DeleteRumMetricsDestination (Maybe Text)
- deleteRumMetricsDestination_appMonitorName :: Lens' DeleteRumMetricsDestination Text
- deleteRumMetricsDestination_destination :: Lens' DeleteRumMetricsDestination MetricDestination
- deleteRumMetricsDestinationResponse_httpStatus :: Lens' DeleteRumMetricsDestinationResponse Int
- getAppMonitor_name :: Lens' GetAppMonitor Text
- getAppMonitorResponse_appMonitor :: Lens' GetAppMonitorResponse (Maybe AppMonitor)
- getAppMonitorResponse_httpStatus :: Lens' GetAppMonitorResponse Int
- getAppMonitorData_filters :: Lens' GetAppMonitorData (Maybe [QueryFilter])
- getAppMonitorData_maxResults :: Lens' GetAppMonitorData (Maybe Natural)
- getAppMonitorData_nextToken :: Lens' GetAppMonitorData (Maybe Text)
- getAppMonitorData_name :: Lens' GetAppMonitorData Text
- getAppMonitorData_timeRange :: Lens' GetAppMonitorData TimeRange
- getAppMonitorDataResponse_events :: Lens' GetAppMonitorDataResponse (Maybe [Text])
- getAppMonitorDataResponse_nextToken :: Lens' GetAppMonitorDataResponse (Maybe Text)
- getAppMonitorDataResponse_httpStatus :: Lens' GetAppMonitorDataResponse Int
- listAppMonitors_maxResults :: Lens' ListAppMonitors (Maybe Natural)
- listAppMonitors_nextToken :: Lens' ListAppMonitors (Maybe Text)
- listAppMonitorsResponse_appMonitorSummaries :: Lens' ListAppMonitorsResponse (Maybe [AppMonitorSummary])
- listAppMonitorsResponse_nextToken :: Lens' ListAppMonitorsResponse (Maybe Text)
- listAppMonitorsResponse_httpStatus :: Lens' ListAppMonitorsResponse Int
- listRumMetricsDestinations_maxResults :: Lens' ListRumMetricsDestinations (Maybe Natural)
- listRumMetricsDestinations_nextToken :: Lens' ListRumMetricsDestinations (Maybe Text)
- listRumMetricsDestinations_appMonitorName :: Lens' ListRumMetricsDestinations Text
- listRumMetricsDestinationsResponse_destinations :: Lens' ListRumMetricsDestinationsResponse (Maybe [MetricDestinationSummary])
- listRumMetricsDestinationsResponse_nextToken :: Lens' ListRumMetricsDestinationsResponse (Maybe Text)
- listRumMetricsDestinationsResponse_httpStatus :: Lens' ListRumMetricsDestinationsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text)
- putRumEvents_appMonitorDetails :: Lens' PutRumEvents AppMonitorDetails
- putRumEvents_batchId :: Lens' PutRumEvents Text
- putRumEvents_id :: Lens' PutRumEvents Text
- putRumEvents_rumEvents :: Lens' PutRumEvents [RumEvent]
- putRumEvents_userDetails :: Lens' PutRumEvents UserDetails
- putRumEventsResponse_httpStatus :: Lens' PutRumEventsResponse Int
- putRumMetricsDestination_destinationArn :: Lens' PutRumMetricsDestination (Maybe Text)
- putRumMetricsDestination_iamRoleArn :: Lens' PutRumMetricsDestination (Maybe Text)
- putRumMetricsDestination_appMonitorName :: Lens' PutRumMetricsDestination Text
- putRumMetricsDestination_destination :: Lens' PutRumMetricsDestination MetricDestination
- putRumMetricsDestinationResponse_httpStatus :: Lens' PutRumMetricsDestinationResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateAppMonitor_appMonitorConfiguration :: Lens' UpdateAppMonitor (Maybe AppMonitorConfiguration)
- updateAppMonitor_customEvents :: Lens' UpdateAppMonitor (Maybe CustomEvents)
- updateAppMonitor_cwLogEnabled :: Lens' UpdateAppMonitor (Maybe Bool)
- updateAppMonitor_domain :: Lens' UpdateAppMonitor (Maybe Text)
- updateAppMonitor_name :: Lens' UpdateAppMonitor Text
- updateAppMonitorResponse_httpStatus :: Lens' UpdateAppMonitorResponse Int
- updateRumMetricDefinition_destinationArn :: Lens' UpdateRumMetricDefinition (Maybe Text)
- updateRumMetricDefinition_appMonitorName :: Lens' UpdateRumMetricDefinition Text
- updateRumMetricDefinition_destination :: Lens' UpdateRumMetricDefinition MetricDestination
- updateRumMetricDefinition_metricDefinition :: Lens' UpdateRumMetricDefinition MetricDefinitionRequest
- updateRumMetricDefinition_metricDefinitionId :: Lens' UpdateRumMetricDefinition Text
- updateRumMetricDefinitionResponse_httpStatus :: Lens' UpdateRumMetricDefinitionResponse Int
- appMonitor_appMonitorConfiguration :: Lens' AppMonitor (Maybe AppMonitorConfiguration)
- appMonitor_created :: Lens' AppMonitor (Maybe Text)
- appMonitor_customEvents :: Lens' AppMonitor (Maybe CustomEvents)
- appMonitor_dataStorage :: Lens' AppMonitor (Maybe DataStorage)
- appMonitor_domain :: Lens' AppMonitor (Maybe Text)
- appMonitor_id :: Lens' AppMonitor (Maybe Text)
- appMonitor_lastModified :: Lens' AppMonitor (Maybe Text)
- appMonitor_name :: Lens' AppMonitor (Maybe Text)
- appMonitor_state :: Lens' AppMonitor (Maybe StateEnum)
- appMonitor_tags :: Lens' AppMonitor (Maybe (HashMap Text Text))
- appMonitorConfiguration_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool)
- appMonitorConfiguration_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool)
- appMonitorConfiguration_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text)
- appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text)
- appMonitorConfiguration_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double)
- appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry])
- appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text)
- appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text)
- appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text)
- appMonitorSummary_created :: Lens' AppMonitorSummary (Maybe Text)
- appMonitorSummary_id :: Lens' AppMonitorSummary (Maybe Text)
- appMonitorSummary_lastModified :: Lens' AppMonitorSummary (Maybe Text)
- appMonitorSummary_name :: Lens' AppMonitorSummary (Maybe Text)
- appMonitorSummary_state :: Lens' AppMonitorSummary (Maybe StateEnum)
- batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text
- batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text
- batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest
- batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text
- batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text
- batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text
- customEvents_status :: Lens' CustomEvents (Maybe CustomEventsStatus)
- cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool)
- cwLog_cwLogGroup :: Lens' CwLog (Maybe Text)
- dataStorage_cwLog :: Lens' DataStorage (Maybe CwLog)
- metricDefinition_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text))
- metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_unitLabel :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text
- metricDefinition_name :: Lens' MetricDefinition Text
- metricDefinitionRequest_dimensionKeys :: Lens' MetricDefinitionRequest (Maybe (HashMap Text Text))
- metricDefinitionRequest_eventPattern :: Lens' MetricDefinitionRequest (Maybe Text)
- metricDefinitionRequest_unitLabel :: Lens' MetricDefinitionRequest (Maybe Text)
- metricDefinitionRequest_valueKey :: Lens' MetricDefinitionRequest (Maybe Text)
- metricDefinitionRequest_name :: Lens' MetricDefinitionRequest Text
- metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination)
- metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text)
- metricDestinationSummary_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text)
- queryFilter_name :: Lens' QueryFilter (Maybe Text)
- queryFilter_values :: Lens' QueryFilter (Maybe [Text])
- rumEvent_metadata :: Lens' RumEvent (Maybe Text)
- rumEvent_details :: Lens' RumEvent Text
- rumEvent_id :: Lens' RumEvent Text
- rumEvent_timestamp :: Lens' RumEvent UTCTime
- rumEvent_type :: Lens' RumEvent Text
- timeRange_before :: Lens' TimeRange (Maybe Integer)
- timeRange_after :: Lens' TimeRange Integer
- userDetails_sessionId :: Lens' UserDetails (Maybe Text)
- userDetails_userId :: Lens' UserDetails (Maybe Text)
Operations
BatchCreateRumMetricDefinitions
batchCreateRumMetricDefinitions_destinationArn :: Lens' BatchCreateRumMetricDefinitions (Maybe Text) Source #
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.
batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text Source #
The name of the CloudWatch RUM app monitor that is to send the metrics.
batchCreateRumMetricDefinitions_destination :: Lens' BatchCreateRumMetricDefinitions MetricDestination Source #
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_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest] Source #
An array of structures which define the metrics that you want to send.
batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition]) Source #
An array of structures that define the extended metrics.
batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int Source #
The response's http status code.
batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError] Source #
An array of error objects, if the operation caused any errors.
BatchDeleteRumMetricDefinitions
batchDeleteRumMetricDefinitions_destinationArn :: Lens' BatchDeleteRumMetricDefinitions (Maybe Text) Source #
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.
batchDeleteRumMetricDefinitions_appMonitorName :: Lens' BatchDeleteRumMetricDefinitions Text Source #
The name of the CloudWatch RUM app monitor that is sending these metrics.
batchDeleteRumMetricDefinitions_destination :: Lens' BatchDeleteRumMetricDefinitions MetricDestination Source #
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_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitions [Text] Source #
An array of structures which define the metrics that you want to stop sending.
batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitionsResponse (Maybe [Text]) Source #
The IDs of the metric definitions that were deleted.
batchDeleteRumMetricDefinitionsResponse_httpStatus :: Lens' BatchDeleteRumMetricDefinitionsResponse Int Source #
The response's http status code.
batchDeleteRumMetricDefinitionsResponse_errors :: Lens' BatchDeleteRumMetricDefinitionsResponse [BatchDeleteRumMetricDefinitionsError] Source #
An array of error objects, if the operation caused any errors.
BatchGetRumMetricDefinitions
batchGetRumMetricDefinitions_destinationArn :: Lens' BatchGetRumMetricDefinitions (Maybe Text) Source #
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.
batchGetRumMetricDefinitions_maxResults :: Lens' BatchGetRumMetricDefinitions (Maybe Natural) Source #
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_nextToken :: Lens' BatchGetRumMetricDefinitions (Maybe Text) Source #
Use the token returned by the previous operation to request the next page of results.
batchGetRumMetricDefinitions_appMonitorName :: Lens' BatchGetRumMetricDefinitions Text Source #
The name of the CloudWatch RUM app monitor that is sending the metrics.
batchGetRumMetricDefinitions_destination :: Lens' BatchGetRumMetricDefinitions MetricDestination Source #
The type of destination that you want to view metrics for. Valid values
are CloudWatch
and Evidently
.
batchGetRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe [MetricDefinition]) Source #
An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.
batchGetRumMetricDefinitionsResponse_nextToken :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe Text) Source #
A token that you can use in a subsequent operation to retrieve the next set of results.
batchGetRumMetricDefinitionsResponse_httpStatus :: Lens' BatchGetRumMetricDefinitionsResponse Int Source #
The response's http status code.
CreateAppMonitor
createAppMonitor_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration) Source #
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_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents) Source #
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_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool) Source #
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_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text)) Source #
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_domain :: Lens' CreateAppMonitor Text Source #
The top-level internet domain name for which your application has administrative authority.
createAppMonitor_name :: Lens' CreateAppMonitor Text Source #
A name for the app monitor.
createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text) Source #
The unique ID of the new app monitor.
createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int Source #
The response's http status code.
DeleteAppMonitor
deleteAppMonitor_name :: Lens' DeleteAppMonitor Text Source #
The name of the app monitor to delete.
deleteAppMonitorResponse_httpStatus :: Lens' DeleteAppMonitorResponse Int Source #
The response's http status code.
DeleteRumMetricsDestination
deleteRumMetricsDestination_destinationArn :: Lens' DeleteRumMetricsDestination (Maybe Text) Source #
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.
deleteRumMetricsDestination_appMonitorName :: Lens' DeleteRumMetricsDestination Text Source #
The name of the app monitor that is sending metrics to the destination that you want to delete.
deleteRumMetricsDestination_destination :: Lens' DeleteRumMetricsDestination MetricDestination Source #
The type of destination to delete. Valid values are CloudWatch
and
Evidently
.
deleteRumMetricsDestinationResponse_httpStatus :: Lens' DeleteRumMetricsDestinationResponse Int Source #
The response's http status code.
GetAppMonitor
getAppMonitor_name :: Lens' GetAppMonitor Text Source #
The app monitor to retrieve information for.
getAppMonitorResponse_appMonitor :: Lens' GetAppMonitorResponse (Maybe AppMonitor) Source #
A structure containing all the configuration information for the app monitor.
getAppMonitorResponse_httpStatus :: Lens' GetAppMonitorResponse Int Source #
The response's http status code.
GetAppMonitorData
getAppMonitorData_filters :: Lens' GetAppMonitorData (Maybe [QueryFilter]) Source #
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.
getAppMonitorData_maxResults :: Lens' GetAppMonitorData (Maybe Natural) Source #
The maximum number of results to return in one operation.
getAppMonitorData_nextToken :: Lens' GetAppMonitorData (Maybe Text) Source #
Use the token returned by the previous operation to request the next page of results.
getAppMonitorData_name :: Lens' GetAppMonitorData Text Source #
The name of the app monitor that collected the data that you want to retrieve.
getAppMonitorData_timeRange :: Lens' GetAppMonitorData TimeRange Source #
A structure that defines the time range that you want to retrieve results from.
getAppMonitorDataResponse_events :: Lens' GetAppMonitorDataResponse (Maybe [Text]) Source #
The events that RUM collected that match your request.
getAppMonitorDataResponse_nextToken :: Lens' GetAppMonitorDataResponse (Maybe Text) Source #
A token that you can use in a subsequent operation to retrieve the next set of results.
getAppMonitorDataResponse_httpStatus :: Lens' GetAppMonitorDataResponse Int Source #
The response's http status code.
ListAppMonitors
listAppMonitors_maxResults :: Lens' ListAppMonitors (Maybe Natural) Source #
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.
listAppMonitors_nextToken :: Lens' ListAppMonitors (Maybe Text) Source #
Use the token returned by the previous operation to request the next page of results.
listAppMonitorsResponse_appMonitorSummaries :: Lens' ListAppMonitorsResponse (Maybe [AppMonitorSummary]) Source #
An array of structures that contain information about the returned app monitors.
listAppMonitorsResponse_nextToken :: Lens' ListAppMonitorsResponse (Maybe Text) Source #
A token that you can use in a subsequent operation to retrieve the next set of results.
listAppMonitorsResponse_httpStatus :: Lens' ListAppMonitorsResponse Int Source #
The response's http status code.
ListRumMetricsDestinations
listRumMetricsDestinations_maxResults :: Lens' ListRumMetricsDestinations (Maybe Natural) Source #
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_nextToken :: Lens' ListRumMetricsDestinations (Maybe Text) Source #
Use the token returned by the previous operation to request the next page of results.
listRumMetricsDestinations_appMonitorName :: Lens' ListRumMetricsDestinations Text Source #
The name of the app monitor associated with the destinations that you want to retrieve.
listRumMetricsDestinationsResponse_destinations :: Lens' ListRumMetricsDestinationsResponse (Maybe [MetricDestinationSummary]) Source #
The list of CloudWatch RUM extended metrics destinations associated with the app monitor that you specified.
listRumMetricsDestinationsResponse_nextToken :: Lens' ListRumMetricsDestinationsResponse (Maybe Text) Source #
A token that you can use in a subsequent operation to retrieve the next set of results.
listRumMetricsDestinationsResponse_httpStatus :: Lens' ListRumMetricsDestinationsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource that you want to see the tags of.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse Text Source #
The ARN of the resource that you are viewing.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text) Source #
The list of tag keys and values associated with the resource you specified.
PutRumEvents
putRumEvents_appMonitorDetails :: Lens' PutRumEvents AppMonitorDetails Source #
A structure that contains information about the app monitor that collected this telemetry information.
putRumEvents_batchId :: Lens' PutRumEvents Text Source #
A unique identifier for this batch of RUM event data.
putRumEvents_id :: Lens' PutRumEvents Text Source #
The ID of the app monitor that is sending this data.
putRumEvents_rumEvents :: Lens' PutRumEvents [RumEvent] Source #
An array of structures that contain the telemetry event data.
putRumEvents_userDetails :: Lens' PutRumEvents UserDetails Source #
A structure that contains information about the user session that this batch of events was collected from.
putRumEventsResponse_httpStatus :: Lens' PutRumEventsResponse Int Source #
The response's http status code.
PutRumMetricsDestination
putRumMetricsDestination_destinationArn :: Lens' PutRumMetricsDestination (Maybe Text) Source #
Use this parameter only if Destination
is Evidently
. This parameter
specifies the ARN of the Evidently experiment that will receive the
extended metrics.
putRumMetricsDestination_iamRoleArn :: Lens' PutRumMetricsDestination (Maybe Text) Source #
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.
putRumMetricsDestination_appMonitorName :: Lens' PutRumMetricsDestination Text Source #
The name of the CloudWatch RUM app monitor that will send the metrics.
putRumMetricsDestination_destination :: Lens' PutRumMetricsDestination MetricDestination Source #
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.
putRumMetricsDestinationResponse_httpStatus :: Lens' PutRumMetricsDestinationResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the CloudWatch RUM resource that you're adding tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The list of key-value pairs to associate with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the CloudWatch RUM resource that you're removing tags from.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of tag keys to remove from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateAppMonitor
updateAppMonitor_appMonitorConfiguration :: Lens' UpdateAppMonitor (Maybe AppMonitorConfiguration) Source #
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_customEvents :: Lens' UpdateAppMonitor (Maybe CustomEvents) Source #
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_cwLogEnabled :: Lens' UpdateAppMonitor (Maybe Bool) Source #
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_domain :: Lens' UpdateAppMonitor (Maybe Text) Source #
The top-level internet domain name for which your application has administrative authority.
updateAppMonitor_name :: Lens' UpdateAppMonitor Text Source #
The name of the app monitor to update.
updateAppMonitorResponse_httpStatus :: Lens' UpdateAppMonitorResponse Int Source #
The response's http status code.
UpdateRumMetricDefinition
updateRumMetricDefinition_destinationArn :: Lens' UpdateRumMetricDefinition (Maybe Text) Source #
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.
updateRumMetricDefinition_appMonitorName :: Lens' UpdateRumMetricDefinition Text Source #
The name of the CloudWatch RUM app monitor that sends these metrics.
updateRumMetricDefinition_destination :: Lens' UpdateRumMetricDefinition MetricDestination Source #
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_metricDefinition :: Lens' UpdateRumMetricDefinition MetricDefinitionRequest Source #
A structure that contains the new definition that you want to use for this metric.
updateRumMetricDefinition_metricDefinitionId :: Lens' UpdateRumMetricDefinition Text Source #
The ID of the metric definition to update.
updateRumMetricDefinitionResponse_httpStatus :: Lens' UpdateRumMetricDefinitionResponse Int Source #
The response's http status code.
Types
AppMonitor
appMonitor_appMonitorConfiguration :: Lens' AppMonitor (Maybe AppMonitorConfiguration) Source #
A structure that contains much of the configuration data for the app monitor.
appMonitor_created :: Lens' AppMonitor (Maybe Text) Source #
The date and time that this app monitor was created.
appMonitor_customEvents :: Lens' AppMonitor (Maybe CustomEvents) Source #
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.
appMonitor_dataStorage :: Lens' AppMonitor (Maybe 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.
appMonitor_domain :: Lens' AppMonitor (Maybe Text) Source #
The top-level internet domain name for which your application has administrative authority.
appMonitor_id :: Lens' AppMonitor (Maybe Text) Source #
The unique ID of this app monitor.
appMonitor_lastModified :: Lens' AppMonitor (Maybe Text) Source #
The date and time of the most recent changes to this app monitor's configuration.
appMonitor_name :: Lens' AppMonitor (Maybe Text) Source #
The name of the app monitor.
appMonitor_state :: Lens' AppMonitor (Maybe StateEnum) Source #
The current state of the app monitor.
appMonitor_tags :: Lens' AppMonitor (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this app monitor.
AppMonitorConfiguration
appMonitorConfiguration_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool) Source #
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.
appMonitorConfiguration_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool) Source #
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?
appMonitorConfiguration_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
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.
appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
appMonitorConfiguration_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text) Source #
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.
appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text) Source #
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
appMonitorConfiguration_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
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.
appMonitorConfiguration_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double) Source #
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.
appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry]) Source #
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.
AppMonitorDetails
appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text) Source #
The unique ID of the app monitor.
appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text) Source #
The name of the app monitor.
appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text) Source #
The version of the app monitor.
AppMonitorSummary
appMonitorSummary_created :: Lens' AppMonitorSummary (Maybe Text) Source #
The date and time that the app monitor was created.
appMonitorSummary_id :: Lens' AppMonitorSummary (Maybe Text) Source #
The unique ID of this app monitor.
appMonitorSummary_lastModified :: Lens' AppMonitorSummary (Maybe Text) Source #
The date and time of the most recent changes to this app monitor's configuration.
appMonitorSummary_name :: Lens' AppMonitorSummary (Maybe Text) Source #
The name of this app monitor.
appMonitorSummary_state :: Lens' AppMonitorSummary (Maybe StateEnum) Source #
The current state of this app monitor.
BatchCreateRumMetricDefinitionsError
batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text Source #
The error code.
batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text Source #
The error message for this metric definition.
batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest Source #
The metric definition that caused this error.
BatchDeleteRumMetricDefinitionsError
batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text Source #
The error code.
batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text Source #
The error message for this metric definition.
batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text Source #
The ID of the metric definition that caused this error.
CustomEvents
customEvents_status :: Lens' CustomEvents (Maybe CustomEventsStatus) Source #
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
cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool) Source #
Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.
cwLog_cwLogGroup :: Lens' CwLog (Maybe Text) Source #
The name of the log group where the copies are stored.
DataStorage
dataStorage_cwLog :: Lens' DataStorage (Maybe CwLog) Source #
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
metricDefinition_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text)) Source #
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.
metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text) Source #
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.
metricDefinition_unitLabel :: Lens' MetricDefinition (Maybe Text) Source #
Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text) Source #
The field within the event object that the metric value is sourced from.
metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text Source #
The ID of this metric definition.
metricDefinition_name :: Lens' MetricDefinition Text Source #
The name of the metric that is defined in this structure.
MetricDefinitionRequest
metricDefinitionRequest_dimensionKeys :: Lens' MetricDefinitionRequest (Maybe (HashMap Text Text)) Source #
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
.
metricDefinitionRequest_eventPattern :: Lens' MetricDefinitionRequest (Maybe Text) Source #
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.
metricDefinitionRequest_unitLabel :: Lens' MetricDefinitionRequest (Maybe Text) Source #
The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
metricDefinitionRequest_valueKey :: Lens' MetricDefinitionRequest (Maybe Text) Source #
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.
metricDefinitionRequest_name :: Lens' MetricDefinitionRequest Text Source #
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
metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination) Source #
Specifies whether the destination is CloudWatch
or Evidently
.
metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text) Source #
If the destination is Evidently
, this specifies the ARN of the
Evidently experiment that receives the metrics.
metricDestinationSummary_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text) Source #
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
queryFilter_name :: Lens' QueryFilter (Maybe Text) Source #
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
queryFilter_values :: Lens' QueryFilter (Maybe [Text]) Source #
The values of the Name
that are to be be included in the returned
results.
RumEvent
rumEvent_metadata :: Lens' RumEvent (Maybe Text) Source #
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.
rumEvent_type :: Lens' RumEvent Text Source #
The JSON schema that denotes the type of event this is, such as a page load or a new session.
TimeRange
timeRange_before :: Lens' TimeRange (Maybe Integer) Source #
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.
timeRange_after :: Lens' TimeRange Integer Source #
The beginning of the time range to retrieve performance events from.
UserDetails
userDetails_sessionId :: Lens' UserDetails (Maybe Text) Source #
The session ID that the performance events are from.
userDetails_userId :: Lens' UserDetails (Maybe Text) Source #
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.