| 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.Types
Contents
- Service Configuration
- Errors
- CustomEventsStatus
- MetricDestination
- StateEnum
- Telemetry
- AppMonitor
- AppMonitorConfiguration
- AppMonitorDetails
- AppMonitorSummary
- BatchCreateRumMetricDefinitionsError
- BatchDeleteRumMetricDefinitionsError
- CustomEvents
- CwLog
- DataStorage
- MetricDefinition
- MetricDefinitionRequest
- MetricDestinationSummary
- QueryFilter
- RumEvent
- TimeRange
- UserDetails
Description
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
- 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' {}
- newAppMonitor :: AppMonitor
- 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))
- data AppMonitorConfiguration = AppMonitorConfiguration' {
- allowCookies :: Maybe Bool
- enableXRay :: Maybe Bool
- excludedPages :: Maybe [Text]
- favoritePages :: Maybe [Text]
- guestRoleArn :: Maybe Text
- identityPoolId :: Maybe Text
- includedPages :: Maybe [Text]
- sessionSampleRate :: Maybe Double
- telemetries :: Maybe [Telemetry]
- newAppMonitorConfiguration :: AppMonitorConfiguration
- 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])
- data AppMonitorDetails = AppMonitorDetails' {}
- newAppMonitorDetails :: AppMonitorDetails
- appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text)
- appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text)
- appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text)
- data AppMonitorSummary = AppMonitorSummary' {}
- newAppMonitorSummary :: AppMonitorSummary
- 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)
- data BatchCreateRumMetricDefinitionsError = BatchCreateRumMetricDefinitionsError' {}
- newBatchCreateRumMetricDefinitionsError :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
- batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text
- batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text
- batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest
- data BatchDeleteRumMetricDefinitionsError = BatchDeleteRumMetricDefinitionsError' {}
- newBatchDeleteRumMetricDefinitionsError :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
- batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text
- batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text
- batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text
- data CustomEvents = CustomEvents' {}
- newCustomEvents :: CustomEvents
- customEvents_status :: Lens' CustomEvents (Maybe CustomEventsStatus)
- data CwLog = CwLog' {
- cwLogEnabled :: Maybe Bool
- cwLogGroup :: Maybe Text
- newCwLog :: CwLog
- cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool)
- cwLog_cwLogGroup :: Lens' CwLog (Maybe Text)
- data DataStorage = DataStorage' {}
- newDataStorage :: DataStorage
- dataStorage_cwLog :: Lens' DataStorage (Maybe CwLog)
- data MetricDefinition = MetricDefinition' {}
- newMetricDefinition :: Text -> Text -> MetricDefinition
- 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
- data MetricDefinitionRequest = MetricDefinitionRequest' {}
- newMetricDefinitionRequest :: Text -> MetricDefinitionRequest
- 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
- data MetricDestinationSummary = MetricDestinationSummary' {}
- newMetricDestinationSummary :: MetricDestinationSummary
- metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination)
- metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text)
- metricDestinationSummary_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text)
- data QueryFilter = QueryFilter' {}
- newQueryFilter :: QueryFilter
- queryFilter_name :: Lens' QueryFilter (Maybe Text)
- queryFilter_values :: Lens' QueryFilter (Maybe [Text])
- data RumEvent = RumEvent' {}
- newRumEvent :: Text -> Text -> UTCTime -> Text -> RumEvent
- 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
- data TimeRange = TimeRange' {}
- newTimeRange :: Integer -> TimeRange
- timeRange_before :: Lens' TimeRange (Maybe Integer)
- timeRange_after :: Lens' TimeRange Integer
- data UserDetails = UserDetails' {}
- newUserDetails :: UserDetails
- userDetails_sessionId :: Lens' UserDetails (Maybe Text)
- userDetails_userId :: Lens' UserDetails (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon CloudWatch RUM SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permissions to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
This operation attempted to create a resource that already exists.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Internal service exception.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Resource not found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
This request exceeds a service quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was throttled because of quota limits.
_ValidationException :: AsError a => Fold a ServiceError Source #
One of the arguments for the request is not valid.
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' | |
Fields
| |
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.
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
data AppMonitorConfiguration Source #
This structure contains much of the configuration data for the app monitor.
See: newAppMonitorConfiguration smart constructor.
Constructors
| AppMonitorConfiguration' | |
Fields
| |
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.
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.
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.
Constructors
| AppMonitorDetails' | |
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.
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
data AppMonitorSummary Source #
A structure that includes some data about app monitors and their settings.
See: newAppMonitorSummary smart constructor.
Constructors
| AppMonitorSummary' | |
Fields
| |
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.
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
data BatchCreateRumMetricDefinitionsError Source #
A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.
See: newBatchCreateRumMetricDefinitionsError smart constructor.
Constructors
| BatchCreateRumMetricDefinitionsError' | |
Fields
| |
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.
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
data BatchDeleteRumMetricDefinitionsError Source #
A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.
See: newBatchDeleteRumMetricDefinitionsError smart constructor.
Constructors
| BatchDeleteRumMetricDefinitionsError' | |
Fields
| |
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.
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
data CustomEvents Source #
A structure that contains information about custom events for this app monitor.
See: newCustomEvents smart constructor.
Constructors
| CustomEvents' | |
Fields
| |
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.
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
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.
Constructors
| CwLog' | |
Fields
| |
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.
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
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' | |
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.
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
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' | |
Fields
| |
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.
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
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' | |
Fields
| |
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
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
data MetricDestinationSummary Source #
A structure that displays information about one destination that CloudWatch RUM sends extended metrics to.
See: newMetricDestinationSummary smart constructor.
Constructors
| MetricDestinationSummary' | |
Fields
| |
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.
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
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' | |
Fields
| |
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.
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
A structure that contains the information for one performance event that RUM collects from a user session with your application.
See: newRumEvent smart constructor.
Constructors
| RumEvent' | |
Fields
| |
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.
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
A structure that defines the time range that you want to retrieve results from.
See: newTimeRange smart constructor.
Constructors
| TimeRange' | |
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.
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
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' | |
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.
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.