-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon CloudWatch RUM SDK.
--
-- Derived from API version 2018-05-10 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information, sending requests, and receiving responses.
--
-- It is recommended to use generic lenses or optics from packages such
-- as generic-lens or optics to modify optional fields and
-- deconstruct responses.
--
-- Generated lenses can be found in Amazonka.Rum.Lens and are
-- suitable for use with a lens package such as lens or
-- lens-family-core.
--
-- See Amazonka.Rum and the AWS documentation to get
-- started.
@package amazonka-rum
@version 2.0
module Amazonka.Rum.Types.AppMonitorDetails
-- | A structure that contains information about the RUM app monitor.
--
-- See: newAppMonitorDetails smart constructor.
data AppMonitorDetails
AppMonitorDetails' :: Maybe Text -> Maybe Text -> Maybe Text -> AppMonitorDetails
-- | The unique ID of the app monitor.
[$sel:id:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | The name of the app monitor.
[$sel:name:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | The version of the app monitor.
[$sel:version:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | 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.
newAppMonitorDetails :: AppMonitorDetails
-- | The unique ID of the app monitor.
appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text)
-- | The name of the app monitor.
appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text)
-- | The version of the app monitor.
appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text)
instance GHC.Generics.Generic Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance GHC.Show.Show Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance GHC.Read.Read Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance GHC.Classes.Eq Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance Control.DeepSeq.NFData Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.AppMonitorDetails.AppMonitorDetails
module Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchDeleteRumMetricDefinitionsError smart
-- constructor.
data BatchDeleteRumMetricDefinitionsError
BatchDeleteRumMetricDefinitionsError' :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
-- | The error code.
[$sel:errorCode:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | The error message for this metric definition.
[$sel:errorMessage:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | The ID of the metric definition that caused this error.
[$sel:metricDefinitionId:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | 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.
newBatchDeleteRumMetricDefinitionsError :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
-- | The error code.
batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The ID of the metric definition that caused this error.
batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text
instance GHC.Generics.Generic Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance GHC.Show.Show Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance GHC.Read.Read Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance GHC.Classes.Eq Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
instance Control.DeepSeq.NFData Amazonka.Rum.Types.BatchDeleteRumMetricDefinitionsError.BatchDeleteRumMetricDefinitionsError
module Amazonka.Rum.Types.CustomEventsStatus
newtype CustomEventsStatus
CustomEventsStatus' :: Text -> CustomEventsStatus
[fromCustomEventsStatus] :: CustomEventsStatus -> Text
pattern CustomEventsStatus_DISABLED :: CustomEventsStatus
pattern CustomEventsStatus_ENABLED :: CustomEventsStatus
instance Amazonka.Data.XML.ToXML Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.XML.FromXML Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.Log.ToLog Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.Text.ToText Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Amazonka.Data.Text.FromText Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Control.DeepSeq.NFData Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance GHC.Generics.Generic Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance GHC.Classes.Ord Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance GHC.Classes.Eq Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance GHC.Read.Read Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
instance GHC.Show.Show Amazonka.Rum.Types.CustomEventsStatus.CustomEventsStatus
module Amazonka.Rum.Types.CustomEvents
-- | A structure that contains information about custom events for this app
-- monitor.
--
-- See: newCustomEvents smart constructor.
data CustomEvents
CustomEvents' :: Maybe CustomEventsStatus -> CustomEvents
-- | Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
[$sel:status:CustomEvents'] :: CustomEvents -> Maybe CustomEventsStatus
-- | 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.
newCustomEvents :: CustomEvents
-- | Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
customEvents_status :: Lens' CustomEvents (Maybe CustomEventsStatus)
instance GHC.Generics.Generic Amazonka.Rum.Types.CustomEvents.CustomEvents
instance GHC.Show.Show Amazonka.Rum.Types.CustomEvents.CustomEvents
instance GHC.Read.Read Amazonka.Rum.Types.CustomEvents.CustomEvents
instance GHC.Classes.Eq Amazonka.Rum.Types.CustomEvents.CustomEvents
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.CustomEvents.CustomEvents
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.CustomEvents.CustomEvents
instance Control.DeepSeq.NFData Amazonka.Rum.Types.CustomEvents.CustomEvents
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.CustomEvents.CustomEvents
module Amazonka.Rum.Types.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.
data CwLog
CwLog' :: Maybe Bool -> Maybe Text -> CwLog
-- | Indicated whether the app monitor stores copies of the data that RUM
-- collects in CloudWatch Logs.
[$sel:cwLogEnabled:CwLog'] :: CwLog -> Maybe Bool
-- | The name of the log group where the copies are stored.
[$sel:cwLogGroup:CwLog'] :: CwLog -> 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.
newCwLog :: CwLog
-- | Indicated whether the app monitor stores copies of the data that RUM
-- collects in CloudWatch Logs.
cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool)
-- | The name of the log group where the copies are stored.
cwLog_cwLogGroup :: Lens' CwLog (Maybe Text)
instance GHC.Generics.Generic Amazonka.Rum.Types.CwLog.CwLog
instance GHC.Show.Show Amazonka.Rum.Types.CwLog.CwLog
instance GHC.Read.Read Amazonka.Rum.Types.CwLog.CwLog
instance GHC.Classes.Eq Amazonka.Rum.Types.CwLog.CwLog
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.CwLog.CwLog
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.CwLog.CwLog
instance Control.DeepSeq.NFData Amazonka.Rum.Types.CwLog.CwLog
module Amazonka.Rum.Types.DataStorage
-- | 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.
data DataStorage
DataStorage' :: Maybe CwLog -> DataStorage
-- | 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.
[$sel:cwLog:DataStorage'] :: DataStorage -> Maybe CwLog
-- | 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.
newDataStorage :: DataStorage
-- | 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)
instance GHC.Generics.Generic Amazonka.Rum.Types.DataStorage.DataStorage
instance GHC.Show.Show Amazonka.Rum.Types.DataStorage.DataStorage
instance GHC.Read.Read Amazonka.Rum.Types.DataStorage.DataStorage
instance GHC.Classes.Eq Amazonka.Rum.Types.DataStorage.DataStorage
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.DataStorage.DataStorage
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.DataStorage.DataStorage
instance Control.DeepSeq.NFData Amazonka.Rum.Types.DataStorage.DataStorage
module Amazonka.Rum.Types.MetricDefinition
-- | 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.
data MetricDefinition
MetricDefinition' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> MetricDefinition
-- | 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:dimensionKeys:MetricDefinition'] :: MetricDefinition -> Maybe (HashMap Text Text)
-- | 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:eventPattern:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | 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:unitLabel:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | The field within the event object that the metric value is sourced
-- from.
[$sel:valueKey:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | The ID of this metric definition.
[$sel:metricDefinitionId:MetricDefinition'] :: MetricDefinition -> Text
-- | The name of the metric that is defined in this structure.
[$sel:name:MetricDefinition'] :: MetricDefinition -> Text
-- | 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.
newMetricDefinition :: Text -> Text -> MetricDefinition
-- | 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_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinition (Maybe Text)
-- | 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_unitLabel :: Lens' MetricDefinition (Maybe Text)
-- | The field within the event object that the metric value is sourced
-- from.
metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text)
-- | The ID of this metric definition.
metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text
-- | The name of the metric that is defined in this structure.
metricDefinition_name :: Lens' MetricDefinition Text
instance GHC.Generics.Generic Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance GHC.Show.Show Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance GHC.Read.Read Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance GHC.Classes.Eq Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.MetricDefinition.MetricDefinition
instance Control.DeepSeq.NFData Amazonka.Rum.Types.MetricDefinition.MetricDefinition
module Amazonka.Rum.Types.MetricDefinitionRequest
-- | 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 Name is PerformanceNavigationDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_navigation_event"]}
-- - If Name is PerformanceResourceDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_resource_event"]}
-- - If Name is NavigationSatisfiedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">",2000] }] } }
-- - If Name is NavigationToleratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",2000,"<"8000] }] } }
-- - If Name is NavigationFrustratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",8000] }] } }
-- - If Name is WebVitalsCumulativeLayoutShift, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}
-- - If Name is WebVitalsFirstInputDelay, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.first_input_delay_event"]}
-- - If Name is WebVitalsLargestContentfulPaint, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.largest_contentful_paint_event"]}
-- - If Name is JsErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.js_error_event"]}
-- - If Name is HttpErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.http_event"]}
-- - If Name is SessionCount, then
-- ValueKeymust be null and the EventPattern must
-- include
-- {"event_type":["com.amazon.rum.session_start_event"]}
--
--
-- See: newMetricDefinitionRequest smart constructor.
data MetricDefinitionRequest
MetricDefinitionRequest' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> MetricDefinitionRequest
-- | 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:dimensionKeys:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe (HashMap Text Text)
-- | 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:eventPattern:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | The CloudWatch metric unit to use for this metric. If you omit this
-- field, the metric is recorded with no unit.
[$sel:unitLabel:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | 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:valueKey:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | 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
--
[$sel:name:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Text
-- | 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
--
newMetricDefinitionRequest :: Text -> MetricDefinitionRequest
-- | 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_dimensionKeys :: Lens' MetricDefinitionRequest (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinitionRequest (Maybe Text)
-- | The CloudWatch metric unit to use for this metric. If you omit this
-- field, the metric is recorded with no unit.
metricDefinitionRequest_unitLabel :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_valueKey :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_name :: Lens' MetricDefinitionRequest Text
instance GHC.Generics.Generic Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance GHC.Show.Show Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance GHC.Read.Read Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance GHC.Classes.Eq Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance Control.DeepSeq.NFData Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.MetricDefinitionRequest.MetricDefinitionRequest
module Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchCreateRumMetricDefinitionsError smart
-- constructor.
data BatchCreateRumMetricDefinitionsError
BatchCreateRumMetricDefinitionsError' :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
-- | The error code.
[$sel:errorCode:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> Text
-- | The error message for this metric definition.
[$sel:errorMessage:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> Text
-- | The metric definition that caused this error.
[$sel:metricDefinition:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> MetricDefinitionRequest
-- | 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.
newBatchCreateRumMetricDefinitionsError :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
-- | The error code.
batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The metric definition that caused this error.
batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest
instance GHC.Generics.Generic Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance GHC.Show.Show Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance GHC.Read.Read Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance GHC.Classes.Eq Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
instance Control.DeepSeq.NFData Amazonka.Rum.Types.BatchCreateRumMetricDefinitionsError.BatchCreateRumMetricDefinitionsError
module Amazonka.Rum.Types.MetricDestination
newtype MetricDestination
MetricDestination' :: Text -> MetricDestination
[fromMetricDestination] :: MetricDestination -> Text
pattern MetricDestination_CloudWatch :: MetricDestination
pattern MetricDestination_Evidently :: MetricDestination
instance Amazonka.Data.XML.ToXML Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.XML.FromXML Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.Headers.ToHeader Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.Log.ToLog Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.ByteString.ToByteString Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.Text.ToText Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Amazonka.Data.Text.FromText Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Control.DeepSeq.NFData Amazonka.Rum.Types.MetricDestination.MetricDestination
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.MetricDestination.MetricDestination
instance GHC.Generics.Generic Amazonka.Rum.Types.MetricDestination.MetricDestination
instance GHC.Classes.Ord Amazonka.Rum.Types.MetricDestination.MetricDestination
instance GHC.Classes.Eq Amazonka.Rum.Types.MetricDestination.MetricDestination
instance GHC.Read.Read Amazonka.Rum.Types.MetricDestination.MetricDestination
instance GHC.Show.Show Amazonka.Rum.Types.MetricDestination.MetricDestination
module Amazonka.Rum.Types.MetricDestinationSummary
-- | A structure that displays information about one destination that
-- CloudWatch RUM sends extended metrics to.
--
-- See: newMetricDestinationSummary smart constructor.
data MetricDestinationSummary
MetricDestinationSummary' :: Maybe MetricDestination -> Maybe Text -> Maybe Text -> MetricDestinationSummary
-- | Specifies whether the destination is CloudWatch or
-- Evidently.
[$sel:destination:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe MetricDestination
-- | If the destination is Evidently, this specifies the ARN of
-- the Evidently experiment that receives the metrics.
[$sel:destinationArn:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe Text
-- | 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.
[$sel:iamRoleArn:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe Text
-- | 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.
newMetricDestinationSummary :: MetricDestinationSummary
-- | Specifies whether the destination is CloudWatch or
-- Evidently.
metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination)
-- | If the destination is Evidently, this specifies the ARN of
-- the Evidently experiment that receives the metrics.
metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text)
-- | 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_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text)
instance GHC.Generics.Generic Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance GHC.Show.Show Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance GHC.Read.Read Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance GHC.Classes.Eq Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
instance Control.DeepSeq.NFData Amazonka.Rum.Types.MetricDestinationSummary.MetricDestinationSummary
module Amazonka.Rum.Types.QueryFilter
-- | 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.
data QueryFilter
QueryFilter' :: Maybe Text -> Maybe [Text] -> QueryFilter
-- | 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:name:QueryFilter'] :: QueryFilter -> Maybe Text
-- | The values of the Name that are to be be included in the
-- returned results.
[$sel:values:QueryFilter'] :: QueryFilter -> Maybe [Text]
-- | 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.
newQueryFilter :: QueryFilter
-- | 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_name :: Lens' QueryFilter (Maybe Text)
-- | The values of the Name that are to be be included in the
-- returned results.
queryFilter_values :: Lens' QueryFilter (Maybe [Text])
instance GHC.Generics.Generic Amazonka.Rum.Types.QueryFilter.QueryFilter
instance GHC.Show.Show Amazonka.Rum.Types.QueryFilter.QueryFilter
instance GHC.Read.Read Amazonka.Rum.Types.QueryFilter.QueryFilter
instance GHC.Classes.Eq Amazonka.Rum.Types.QueryFilter.QueryFilter
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.QueryFilter.QueryFilter
instance Control.DeepSeq.NFData Amazonka.Rum.Types.QueryFilter.QueryFilter
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.QueryFilter.QueryFilter
module Amazonka.Rum.Types.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.
data RumEvent
RumEvent' :: Maybe Text -> Text -> Text -> POSIX -> Text -> RumEvent
-- | 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:metadata:RumEvent'] :: RumEvent -> Maybe Text
-- | A string containing details about the event.
[$sel:details:RumEvent'] :: RumEvent -> Text
-- | A unique ID for this event.
[$sel:id:RumEvent'] :: RumEvent -> Text
-- | The exact time that this event occurred.
[$sel:timestamp:RumEvent'] :: RumEvent -> POSIX
-- | The JSON schema that denotes the type of event this is, such as a page
-- load or a new session.
[$sel:type':RumEvent'] :: RumEvent -> Text
-- | 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.
newRumEvent :: Text -> Text -> UTCTime -> Text -> RumEvent
-- | 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_metadata :: Lens' RumEvent (Maybe Text)
-- | A string containing details about the event.
rumEvent_details :: Lens' RumEvent Text
-- | A unique ID for this event.
rumEvent_id :: Lens' RumEvent Text
-- | The exact time that this event occurred.
rumEvent_timestamp :: Lens' RumEvent UTCTime
-- | The JSON schema that denotes the type of event this is, such as a page
-- load or a new session.
rumEvent_type :: Lens' RumEvent Text
instance GHC.Generics.Generic Amazonka.Rum.Types.RumEvent.RumEvent
instance GHC.Show.Show Amazonka.Rum.Types.RumEvent.RumEvent
instance GHC.Read.Read Amazonka.Rum.Types.RumEvent.RumEvent
instance GHC.Classes.Eq Amazonka.Rum.Types.RumEvent.RumEvent
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.RumEvent.RumEvent
instance Control.DeepSeq.NFData Amazonka.Rum.Types.RumEvent.RumEvent
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.RumEvent.RumEvent
module Amazonka.Rum.Types.StateEnum
newtype StateEnum
StateEnum' :: Text -> StateEnum
[fromStateEnum] :: StateEnum -> Text
pattern StateEnum_ACTIVE :: StateEnum
pattern StateEnum_CREATED :: StateEnum
pattern StateEnum_DELETING :: StateEnum
instance Amazonka.Data.XML.ToXML Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.XML.FromXML Amazonka.Rum.Types.StateEnum.StateEnum
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Rum.Types.StateEnum.StateEnum
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.StateEnum.StateEnum
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Rum.Types.StateEnum.StateEnum
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.Headers.ToHeader Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.Log.ToLog Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.ByteString.ToByteString Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.Text.ToText Amazonka.Rum.Types.StateEnum.StateEnum
instance Amazonka.Data.Text.FromText Amazonka.Rum.Types.StateEnum.StateEnum
instance Control.DeepSeq.NFData Amazonka.Rum.Types.StateEnum.StateEnum
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.StateEnum.StateEnum
instance GHC.Generics.Generic Amazonka.Rum.Types.StateEnum.StateEnum
instance GHC.Classes.Ord Amazonka.Rum.Types.StateEnum.StateEnum
instance GHC.Classes.Eq Amazonka.Rum.Types.StateEnum.StateEnum
instance GHC.Read.Read Amazonka.Rum.Types.StateEnum.StateEnum
instance GHC.Show.Show Amazonka.Rum.Types.StateEnum.StateEnum
module Amazonka.Rum.Types.AppMonitorSummary
-- | A structure that includes some data about app monitors and their
-- settings.
--
-- See: newAppMonitorSummary smart constructor.
data AppMonitorSummary
AppMonitorSummary' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> AppMonitorSummary
-- | The date and time that the app monitor was created.
[$sel:created:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The unique ID of this app monitor.
[$sel:id:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
[$sel:lastModified:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The name of this app monitor.
[$sel:name:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The current state of this app monitor.
[$sel:state:AppMonitorSummary'] :: AppMonitorSummary -> Maybe StateEnum
-- | 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.
newAppMonitorSummary :: AppMonitorSummary
-- | The date and time that the app monitor was created.
appMonitorSummary_created :: Lens' AppMonitorSummary (Maybe Text)
-- | The unique ID of this app monitor.
appMonitorSummary_id :: Lens' AppMonitorSummary (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitorSummary_lastModified :: Lens' AppMonitorSummary (Maybe Text)
-- | The name of this app monitor.
appMonitorSummary_name :: Lens' AppMonitorSummary (Maybe Text)
-- | The current state of this app monitor.
appMonitorSummary_state :: Lens' AppMonitorSummary (Maybe StateEnum)
instance GHC.Generics.Generic Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance GHC.Show.Show Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance GHC.Read.Read Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance GHC.Classes.Eq Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
instance Control.DeepSeq.NFData Amazonka.Rum.Types.AppMonitorSummary.AppMonitorSummary
module Amazonka.Rum.Types.Telemetry
newtype Telemetry
Telemetry' :: Text -> Telemetry
[fromTelemetry] :: Telemetry -> Text
pattern Telemetry_Errors :: Telemetry
pattern Telemetry_Http :: Telemetry
pattern Telemetry_Performance :: Telemetry
instance Amazonka.Data.XML.ToXML Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.XML.FromXML Amazonka.Rum.Types.Telemetry.Telemetry
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Rum.Types.Telemetry.Telemetry
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.Telemetry.Telemetry
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Rum.Types.Telemetry.Telemetry
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.Headers.ToHeader Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.Log.ToLog Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.ByteString.ToByteString Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.Text.ToText Amazonka.Rum.Types.Telemetry.Telemetry
instance Amazonka.Data.Text.FromText Amazonka.Rum.Types.Telemetry.Telemetry
instance Control.DeepSeq.NFData Amazonka.Rum.Types.Telemetry.Telemetry
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.Telemetry.Telemetry
instance GHC.Generics.Generic Amazonka.Rum.Types.Telemetry.Telemetry
instance GHC.Classes.Ord Amazonka.Rum.Types.Telemetry.Telemetry
instance GHC.Classes.Eq Amazonka.Rum.Types.Telemetry.Telemetry
instance GHC.Read.Read Amazonka.Rum.Types.Telemetry.Telemetry
instance GHC.Show.Show Amazonka.Rum.Types.Telemetry.Telemetry
module Amazonka.Rum.Types.AppMonitorConfiguration
-- | This structure contains much of the configuration data for the app
-- monitor.
--
-- See: newAppMonitorConfiguration smart constructor.
data AppMonitorConfiguration
AppMonitorConfiguration' :: Maybe Bool -> Maybe Bool -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Double -> Maybe [Telemetry] -> AppMonitorConfiguration
-- | 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:allowCookies:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Bool
-- | 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:enableXRay:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Bool
-- | 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:excludedPages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | A list of pages in your application that are to be displayed with a
-- "favorite" icon in the CloudWatch RUM console.
[$sel:favoritePages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | 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:guestRoleArn:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Text
-- | The ID of the Amazon Cognito identity pool that is used to authorize
-- the sending of data to RUM.
[$sel:identityPoolId:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Text
-- | 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:includedPages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | 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:sessionSampleRate:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Double
-- | 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.
--
[$sel:telemetries:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Telemetry]
-- | 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.
--
--
-- - 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.
--
newAppMonitorConfiguration :: AppMonitorConfiguration
-- | 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_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | A list of pages in your application that are to be displayed with a
-- "favorite" icon in the CloudWatch RUM console.
appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text)
-- | The ID of the Amazon Cognito identity pool that is used to authorize
-- the sending of data to RUM.
appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text)
-- | 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_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double)
-- | 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.
--
appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry])
instance GHC.Generics.Generic Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance GHC.Show.Show Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance GHC.Read.Read Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance GHC.Classes.Eq Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance Control.DeepSeq.NFData Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.AppMonitorConfiguration.AppMonitorConfiguration
module Amazonka.Rum.Types.AppMonitor
-- | 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.
data AppMonitor
AppMonitor' :: Maybe AppMonitorConfiguration -> Maybe Text -> Maybe CustomEvents -> Maybe DataStorage -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> Maybe (HashMap Text Text) -> AppMonitor
-- | A structure that contains much of the configuration data for the app
-- monitor.
[$sel:appMonitorConfiguration:AppMonitor'] :: AppMonitor -> Maybe AppMonitorConfiguration
-- | The date and time that this app monitor was created.
[$sel:created:AppMonitor'] :: AppMonitor -> Maybe Text
-- | 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:customEvents:AppMonitor'] :: AppMonitor -> Maybe CustomEvents
-- | A structure that contains information about whether this app monitor
-- stores a copy of the telemetry data that RUM collects using CloudWatch
-- Logs.
[$sel:dataStorage:AppMonitor'] :: AppMonitor -> Maybe DataStorage
-- | The top-level internet domain name for which your application has
-- administrative authority.
[$sel:domain:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The unique ID of this app monitor.
[$sel:id:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
[$sel:lastModified:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The name of the app monitor.
[$sel:name:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The current state of the app monitor.
[$sel:state:AppMonitor'] :: AppMonitor -> Maybe StateEnum
-- | The list of tag keys and values associated with this app monitor.
[$sel:tags:AppMonitor'] :: AppMonitor -> Maybe (HashMap Text Text)
-- | 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.
newAppMonitor :: AppMonitor
-- | A structure that contains much of the configuration data for the app
-- monitor.
appMonitor_appMonitorConfiguration :: Lens' AppMonitor (Maybe AppMonitorConfiguration)
-- | The date and time that this app monitor was created.
appMonitor_created :: Lens' AppMonitor (Maybe Text)
-- | 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_customEvents :: Lens' AppMonitor (Maybe CustomEvents)
-- | A structure that contains information about whether this app monitor
-- stores a copy of the telemetry data that RUM collects using CloudWatch
-- Logs.
appMonitor_dataStorage :: Lens' AppMonitor (Maybe DataStorage)
-- | The top-level internet domain name for which your application has
-- administrative authority.
appMonitor_domain :: Lens' AppMonitor (Maybe Text)
-- | The unique ID of this app monitor.
appMonitor_id :: Lens' AppMonitor (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitor_lastModified :: Lens' AppMonitor (Maybe Text)
-- | The name of the app monitor.
appMonitor_name :: Lens' AppMonitor (Maybe Text)
-- | The current state of the app monitor.
appMonitor_state :: Lens' AppMonitor (Maybe StateEnum)
-- | The list of tag keys and values associated with this app monitor.
appMonitor_tags :: Lens' AppMonitor (Maybe (HashMap Text Text))
instance GHC.Generics.Generic Amazonka.Rum.Types.AppMonitor.AppMonitor
instance GHC.Show.Show Amazonka.Rum.Types.AppMonitor.AppMonitor
instance GHC.Read.Read Amazonka.Rum.Types.AppMonitor.AppMonitor
instance GHC.Classes.Eq Amazonka.Rum.Types.AppMonitor.AppMonitor
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Rum.Types.AppMonitor.AppMonitor
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.AppMonitor.AppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.Types.AppMonitor.AppMonitor
module Amazonka.Rum.Types.TimeRange
-- | A structure that defines the time range that you want to retrieve
-- results from.
--
-- See: newTimeRange smart constructor.
data TimeRange
TimeRange' :: Maybe Integer -> Integer -> TimeRange
-- | 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:before:TimeRange'] :: TimeRange -> Maybe Integer
-- | The beginning of the time range to retrieve performance events from.
[$sel:after:TimeRange'] :: TimeRange -> 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.
newTimeRange :: Integer -> TimeRange
-- | 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_before :: Lens' TimeRange (Maybe Integer)
-- | The beginning of the time range to retrieve performance events from.
timeRange_after :: Lens' TimeRange Integer
instance GHC.Generics.Generic Amazonka.Rum.Types.TimeRange.TimeRange
instance GHC.Show.Show Amazonka.Rum.Types.TimeRange.TimeRange
instance GHC.Read.Read Amazonka.Rum.Types.TimeRange.TimeRange
instance GHC.Classes.Eq Amazonka.Rum.Types.TimeRange.TimeRange
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.TimeRange.TimeRange
instance Control.DeepSeq.NFData Amazonka.Rum.Types.TimeRange.TimeRange
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.TimeRange.TimeRange
module Amazonka.Rum.Types.UserDetails
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
--
-- See: newUserDetails smart constructor.
data UserDetails
UserDetails' :: Maybe Text -> Maybe Text -> UserDetails
-- | The session ID that the performance events are from.
[$sel:sessionId:UserDetails'] :: UserDetails -> Maybe Text
-- | 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.
[$sel:userId:UserDetails'] :: UserDetails -> Maybe Text
-- | 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.
newUserDetails :: UserDetails
-- | The session ID that the performance events are from.
userDetails_sessionId :: Lens' UserDetails (Maybe Text)
-- | 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_userId :: Lens' UserDetails (Maybe Text)
instance GHC.Generics.Generic Amazonka.Rum.Types.UserDetails.UserDetails
instance GHC.Show.Show Amazonka.Rum.Types.UserDetails.UserDetails
instance GHC.Read.Read Amazonka.Rum.Types.UserDetails.UserDetails
instance GHC.Classes.Eq Amazonka.Rum.Types.UserDetails.UserDetails
instance Data.Hashable.Class.Hashable Amazonka.Rum.Types.UserDetails.UserDetails
instance Control.DeepSeq.NFData Amazonka.Rum.Types.UserDetails.UserDetails
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.Types.UserDetails.UserDetails
module Amazonka.Rum.Types
-- | API version 2018-05-10 of the Amazon CloudWatch RUM SDK
-- configuration.
defaultService :: Service
-- | You don't have sufficient permissions to perform this action.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | This operation attempted to create a resource that already exists.
_ConflictException :: AsError a => Fold a ServiceError
-- | Internal service exception.
_InternalServerException :: AsError a => Fold a ServiceError
-- | Resource not found.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | This request exceeds a service quota.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | The request was throttled because of quota limits.
_ThrottlingException :: AsError a => Fold a ServiceError
-- | One of the arguments for the request is not valid.
_ValidationException :: AsError a => Fold a ServiceError
newtype CustomEventsStatus
CustomEventsStatus' :: Text -> CustomEventsStatus
[fromCustomEventsStatus] :: CustomEventsStatus -> Text
pattern CustomEventsStatus_DISABLED :: CustomEventsStatus
pattern CustomEventsStatus_ENABLED :: CustomEventsStatus
newtype MetricDestination
MetricDestination' :: Text -> MetricDestination
[fromMetricDestination] :: MetricDestination -> Text
pattern MetricDestination_CloudWatch :: MetricDestination
pattern MetricDestination_Evidently :: MetricDestination
newtype StateEnum
StateEnum' :: Text -> StateEnum
[fromStateEnum] :: StateEnum -> Text
pattern StateEnum_ACTIVE :: StateEnum
pattern StateEnum_CREATED :: StateEnum
pattern StateEnum_DELETING :: StateEnum
newtype Telemetry
Telemetry' :: Text -> Telemetry
[fromTelemetry] :: Telemetry -> Text
pattern Telemetry_Errors :: Telemetry
pattern Telemetry_Http :: Telemetry
pattern Telemetry_Performance :: Telemetry
-- | 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.
data AppMonitor
AppMonitor' :: Maybe AppMonitorConfiguration -> Maybe Text -> Maybe CustomEvents -> Maybe DataStorage -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> Maybe (HashMap Text Text) -> AppMonitor
-- | A structure that contains much of the configuration data for the app
-- monitor.
[$sel:appMonitorConfiguration:AppMonitor'] :: AppMonitor -> Maybe AppMonitorConfiguration
-- | The date and time that this app monitor was created.
[$sel:created:AppMonitor'] :: AppMonitor -> Maybe Text
-- | 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:customEvents:AppMonitor'] :: AppMonitor -> Maybe CustomEvents
-- | A structure that contains information about whether this app monitor
-- stores a copy of the telemetry data that RUM collects using CloudWatch
-- Logs.
[$sel:dataStorage:AppMonitor'] :: AppMonitor -> Maybe DataStorage
-- | The top-level internet domain name for which your application has
-- administrative authority.
[$sel:domain:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The unique ID of this app monitor.
[$sel:id:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
[$sel:lastModified:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The name of the app monitor.
[$sel:name:AppMonitor'] :: AppMonitor -> Maybe Text
-- | The current state of the app monitor.
[$sel:state:AppMonitor'] :: AppMonitor -> Maybe StateEnum
-- | The list of tag keys and values associated with this app monitor.
[$sel:tags:AppMonitor'] :: AppMonitor -> Maybe (HashMap Text Text)
-- | 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.
newAppMonitor :: AppMonitor
-- | A structure that contains much of the configuration data for the app
-- monitor.
appMonitor_appMonitorConfiguration :: Lens' AppMonitor (Maybe AppMonitorConfiguration)
-- | The date and time that this app monitor was created.
appMonitor_created :: Lens' AppMonitor (Maybe Text)
-- | 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_customEvents :: Lens' AppMonitor (Maybe CustomEvents)
-- | A structure that contains information about whether this app monitor
-- stores a copy of the telemetry data that RUM collects using CloudWatch
-- Logs.
appMonitor_dataStorage :: Lens' AppMonitor (Maybe DataStorage)
-- | The top-level internet domain name for which your application has
-- administrative authority.
appMonitor_domain :: Lens' AppMonitor (Maybe Text)
-- | The unique ID of this app monitor.
appMonitor_id :: Lens' AppMonitor (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitor_lastModified :: Lens' AppMonitor (Maybe Text)
-- | The name of the app monitor.
appMonitor_name :: Lens' AppMonitor (Maybe Text)
-- | The current state of the app monitor.
appMonitor_state :: Lens' AppMonitor (Maybe StateEnum)
-- | The list of tag keys and values associated with this app monitor.
appMonitor_tags :: Lens' AppMonitor (Maybe (HashMap Text Text))
-- | This structure contains much of the configuration data for the app
-- monitor.
--
-- See: newAppMonitorConfiguration smart constructor.
data AppMonitorConfiguration
AppMonitorConfiguration' :: Maybe Bool -> Maybe Bool -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Double -> Maybe [Telemetry] -> AppMonitorConfiguration
-- | 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:allowCookies:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Bool
-- | 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:enableXRay:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Bool
-- | 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:excludedPages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | A list of pages in your application that are to be displayed with a
-- "favorite" icon in the CloudWatch RUM console.
[$sel:favoritePages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | 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:guestRoleArn:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Text
-- | The ID of the Amazon Cognito identity pool that is used to authorize
-- the sending of data to RUM.
[$sel:identityPoolId:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Text
-- | 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:includedPages:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Text]
-- | 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:sessionSampleRate:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe Double
-- | 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.
--
[$sel:telemetries:AppMonitorConfiguration'] :: AppMonitorConfiguration -> Maybe [Telemetry]
-- | 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.
--
--
-- - 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.
--
newAppMonitorConfiguration :: AppMonitorConfiguration
-- | 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_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | A list of pages in your application that are to be displayed with a
-- "favorite" icon in the CloudWatch RUM console.
appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text)
-- | The ID of the Amazon Cognito identity pool that is used to authorize
-- the sending of data to RUM.
appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text)
-- | 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_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double)
-- | 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.
--
appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry])
-- | A structure that contains information about the RUM app monitor.
--
-- See: newAppMonitorDetails smart constructor.
data AppMonitorDetails
AppMonitorDetails' :: Maybe Text -> Maybe Text -> Maybe Text -> AppMonitorDetails
-- | The unique ID of the app monitor.
[$sel:id:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | The name of the app monitor.
[$sel:name:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | The version of the app monitor.
[$sel:version:AppMonitorDetails'] :: AppMonitorDetails -> Maybe Text
-- | 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.
newAppMonitorDetails :: AppMonitorDetails
-- | The unique ID of the app monitor.
appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text)
-- | The name of the app monitor.
appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text)
-- | The version of the app monitor.
appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text)
-- | A structure that includes some data about app monitors and their
-- settings.
--
-- See: newAppMonitorSummary smart constructor.
data AppMonitorSummary
AppMonitorSummary' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> AppMonitorSummary
-- | The date and time that the app monitor was created.
[$sel:created:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The unique ID of this app monitor.
[$sel:id:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
[$sel:lastModified:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The name of this app monitor.
[$sel:name:AppMonitorSummary'] :: AppMonitorSummary -> Maybe Text
-- | The current state of this app monitor.
[$sel:state:AppMonitorSummary'] :: AppMonitorSummary -> Maybe StateEnum
-- | 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.
newAppMonitorSummary :: AppMonitorSummary
-- | The date and time that the app monitor was created.
appMonitorSummary_created :: Lens' AppMonitorSummary (Maybe Text)
-- | The unique ID of this app monitor.
appMonitorSummary_id :: Lens' AppMonitorSummary (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitorSummary_lastModified :: Lens' AppMonitorSummary (Maybe Text)
-- | The name of this app monitor.
appMonitorSummary_name :: Lens' AppMonitorSummary (Maybe Text)
-- | The current state of this app monitor.
appMonitorSummary_state :: Lens' AppMonitorSummary (Maybe StateEnum)
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchCreateRumMetricDefinitionsError smart
-- constructor.
data BatchCreateRumMetricDefinitionsError
BatchCreateRumMetricDefinitionsError' :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
-- | The error code.
[$sel:errorCode:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> Text
-- | The error message for this metric definition.
[$sel:errorMessage:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> Text
-- | The metric definition that caused this error.
[$sel:metricDefinition:BatchCreateRumMetricDefinitionsError'] :: BatchCreateRumMetricDefinitionsError -> MetricDefinitionRequest
-- | 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.
newBatchCreateRumMetricDefinitionsError :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
-- | The error code.
batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The metric definition that caused this error.
batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchDeleteRumMetricDefinitionsError smart
-- constructor.
data BatchDeleteRumMetricDefinitionsError
BatchDeleteRumMetricDefinitionsError' :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
-- | The error code.
[$sel:errorCode:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | The error message for this metric definition.
[$sel:errorMessage:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | The ID of the metric definition that caused this error.
[$sel:metricDefinitionId:BatchDeleteRumMetricDefinitionsError'] :: BatchDeleteRumMetricDefinitionsError -> Text
-- | 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.
newBatchDeleteRumMetricDefinitionsError :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
-- | The error code.
batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The ID of the metric definition that caused this error.
batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | A structure that contains information about custom events for this app
-- monitor.
--
-- See: newCustomEvents smart constructor.
data CustomEvents
CustomEvents' :: Maybe CustomEventsStatus -> CustomEvents
-- | Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
[$sel:status:CustomEvents'] :: CustomEvents -> Maybe CustomEventsStatus
-- | 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.
newCustomEvents :: CustomEvents
-- | Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
customEvents_status :: Lens' CustomEvents (Maybe CustomEventsStatus)
-- | 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.
data CwLog
CwLog' :: Maybe Bool -> Maybe Text -> CwLog
-- | Indicated whether the app monitor stores copies of the data that RUM
-- collects in CloudWatch Logs.
[$sel:cwLogEnabled:CwLog'] :: CwLog -> Maybe Bool
-- | The name of the log group where the copies are stored.
[$sel:cwLogGroup:CwLog'] :: CwLog -> 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.
newCwLog :: CwLog
-- | Indicated whether the app monitor stores copies of the data that RUM
-- collects in CloudWatch Logs.
cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool)
-- | The name of the log group where the copies are stored.
cwLog_cwLogGroup :: Lens' CwLog (Maybe Text)
-- | 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.
data DataStorage
DataStorage' :: Maybe CwLog -> DataStorage
-- | 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.
[$sel:cwLog:DataStorage'] :: DataStorage -> Maybe CwLog
-- | 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.
newDataStorage :: DataStorage
-- | 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)
-- | 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.
data MetricDefinition
MetricDefinition' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> MetricDefinition
-- | 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:dimensionKeys:MetricDefinition'] :: MetricDefinition -> Maybe (HashMap Text Text)
-- | 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:eventPattern:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | 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:unitLabel:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | The field within the event object that the metric value is sourced
-- from.
[$sel:valueKey:MetricDefinition'] :: MetricDefinition -> Maybe Text
-- | The ID of this metric definition.
[$sel:metricDefinitionId:MetricDefinition'] :: MetricDefinition -> Text
-- | The name of the metric that is defined in this structure.
[$sel:name:MetricDefinition'] :: MetricDefinition -> Text
-- | 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.
newMetricDefinition :: Text -> Text -> MetricDefinition
-- | 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_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinition (Maybe Text)
-- | 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_unitLabel :: Lens' MetricDefinition (Maybe Text)
-- | The field within the event object that the metric value is sourced
-- from.
metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text)
-- | The ID of this metric definition.
metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text
-- | The name of the metric that is defined in this structure.
metricDefinition_name :: Lens' MetricDefinition Text
-- | 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 Name is PerformanceNavigationDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_navigation_event"]}
-- - If Name is PerformanceResourceDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_resource_event"]}
-- - If Name is NavigationSatisfiedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">",2000] }] } }
-- - If Name is NavigationToleratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",2000,"<"8000] }] } }
-- - If Name is NavigationFrustratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",8000] }] } }
-- - If Name is WebVitalsCumulativeLayoutShift, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}
-- - If Name is WebVitalsFirstInputDelay, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.first_input_delay_event"]}
-- - If Name is WebVitalsLargestContentfulPaint, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.largest_contentful_paint_event"]}
-- - If Name is JsErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.js_error_event"]}
-- - If Name is HttpErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.http_event"]}
-- - If Name is SessionCount, then
-- ValueKeymust be null and the EventPattern must
-- include
-- {"event_type":["com.amazon.rum.session_start_event"]}
--
--
-- See: newMetricDefinitionRequest smart constructor.
data MetricDefinitionRequest
MetricDefinitionRequest' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> MetricDefinitionRequest
-- | 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:dimensionKeys:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe (HashMap Text Text)
-- | 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:eventPattern:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | The CloudWatch metric unit to use for this metric. If you omit this
-- field, the metric is recorded with no unit.
[$sel:unitLabel:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | 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:valueKey:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Maybe Text
-- | 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
--
[$sel:name:MetricDefinitionRequest'] :: MetricDefinitionRequest -> Text
-- | 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
--
newMetricDefinitionRequest :: Text -> MetricDefinitionRequest
-- | 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_dimensionKeys :: Lens' MetricDefinitionRequest (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinitionRequest (Maybe Text)
-- | The CloudWatch metric unit to use for this metric. If you omit this
-- field, the metric is recorded with no unit.
metricDefinitionRequest_unitLabel :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_valueKey :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_name :: Lens' MetricDefinitionRequest Text
-- | A structure that displays information about one destination that
-- CloudWatch RUM sends extended metrics to.
--
-- See: newMetricDestinationSummary smart constructor.
data MetricDestinationSummary
MetricDestinationSummary' :: Maybe MetricDestination -> Maybe Text -> Maybe Text -> MetricDestinationSummary
-- | Specifies whether the destination is CloudWatch or
-- Evidently.
[$sel:destination:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe MetricDestination
-- | If the destination is Evidently, this specifies the ARN of
-- the Evidently experiment that receives the metrics.
[$sel:destinationArn:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe Text
-- | 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.
[$sel:iamRoleArn:MetricDestinationSummary'] :: MetricDestinationSummary -> Maybe Text
-- | 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.
newMetricDestinationSummary :: MetricDestinationSummary
-- | Specifies whether the destination is CloudWatch or
-- Evidently.
metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination)
-- | If the destination is Evidently, this specifies the ARN of
-- the Evidently experiment that receives the metrics.
metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text)
-- | 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_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text)
-- | 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.
data QueryFilter
QueryFilter' :: Maybe Text -> Maybe [Text] -> QueryFilter
-- | 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:name:QueryFilter'] :: QueryFilter -> Maybe Text
-- | The values of the Name that are to be be included in the
-- returned results.
[$sel:values:QueryFilter'] :: QueryFilter -> Maybe [Text]
-- | 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.
newQueryFilter :: QueryFilter
-- | 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_name :: Lens' QueryFilter (Maybe Text)
-- | The values of the Name that are to be be included in the
-- returned results.
queryFilter_values :: Lens' QueryFilter (Maybe [Text])
-- | A structure that contains the information for one performance event
-- that RUM collects from a user session with your application.
--
-- See: newRumEvent smart constructor.
data RumEvent
RumEvent' :: Maybe Text -> Text -> Text -> POSIX -> Text -> RumEvent
-- | 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:metadata:RumEvent'] :: RumEvent -> Maybe Text
-- | A string containing details about the event.
[$sel:details:RumEvent'] :: RumEvent -> Text
-- | A unique ID for this event.
[$sel:id:RumEvent'] :: RumEvent -> Text
-- | The exact time that this event occurred.
[$sel:timestamp:RumEvent'] :: RumEvent -> POSIX
-- | The JSON schema that denotes the type of event this is, such as a page
-- load or a new session.
[$sel:type':RumEvent'] :: RumEvent -> Text
-- | 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.
newRumEvent :: Text -> Text -> UTCTime -> Text -> RumEvent
-- | 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_metadata :: Lens' RumEvent (Maybe Text)
-- | A string containing details about the event.
rumEvent_details :: Lens' RumEvent Text
-- | A unique ID for this event.
rumEvent_id :: Lens' RumEvent Text
-- | The exact time that this event occurred.
rumEvent_timestamp :: Lens' RumEvent UTCTime
-- | The JSON schema that denotes the type of event this is, such as a page
-- load or a new session.
rumEvent_type :: Lens' RumEvent Text
-- | A structure that defines the time range that you want to retrieve
-- results from.
--
-- See: newTimeRange smart constructor.
data TimeRange
TimeRange' :: Maybe Integer -> Integer -> TimeRange
-- | 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:before:TimeRange'] :: TimeRange -> Maybe Integer
-- | The beginning of the time range to retrieve performance events from.
[$sel:after:TimeRange'] :: TimeRange -> 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.
newTimeRange :: Integer -> TimeRange
-- | 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_before :: Lens' TimeRange (Maybe Integer)
-- | The beginning of the time range to retrieve performance events from.
timeRange_after :: Lens' TimeRange Integer
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
--
-- See: newUserDetails smart constructor.
data UserDetails
UserDetails' :: Maybe Text -> Maybe Text -> UserDetails
-- | The session ID that the performance events are from.
[$sel:sessionId:UserDetails'] :: UserDetails -> Maybe Text
-- | 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.
[$sel:userId:UserDetails'] :: UserDetails -> Maybe Text
-- | 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.
newUserDetails :: UserDetails
-- | The session ID that the performance events are from.
userDetails_sessionId :: Lens' UserDetails (Maybe Text)
-- | 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_userId :: Lens' UserDetails (Maybe Text)
-- | Assigns one or more tags (key-value pairs) to the specified CloudWatch
-- RUM resource. Currently, the only resources that can be tagged app
-- monitors.
--
-- Tags can help you organize and categorize your resources. You can also
-- use them to scope user permissions by granting a user permission to
-- access or change only resources with certain tag values.
--
-- Tags don't have any semantic meaning to Amazon Web Services and are
-- interpreted strictly as strings of characters.
--
-- You can use the TagResource action with a resource that
-- already has tags. If you specify a new tag key for the resource, this
-- tag is appended to the list of tags associated with the alarm. If you
-- specify a tag key that is already associated with the resource, the
-- new tag value that you specify replaces the previous value for that
-- tag.
--
-- You can associate as many as 50 tags with a resource.
--
-- For more information, see Tagging Amazon Web Services
-- resources.
module Amazonka.Rum.TagResource
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> HashMap Text Text -> TagResource
-- | The ARN of the CloudWatch RUM resource that you're adding tags to.
[$sel:resourceArn:TagResource'] :: TagResource -> Text
-- | The list of key-value pairs to associate with the resource.
[$sel:tags:TagResource'] :: TagResource -> HashMap Text Text
-- | Create a value of TagResource with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:resourceArn:TagResource', tagResource_resourceArn -
-- The ARN of the CloudWatch RUM resource that you're adding tags to.
--
-- TagResource, tagResource_tags - The list of key-value
-- pairs to associate with the resource.
newTagResource :: Text -> TagResource
-- | The ARN of the CloudWatch RUM resource that you're adding tags to.
tagResource_resourceArn :: Lens' TagResource Text
-- | The list of key-value pairs to associate with the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text)
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:TagResourceResponse'] :: TagResourceResponse -> Int
-- | Create a value of TagResourceResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
instance GHC.Generics.Generic Amazonka.Rum.TagResource.TagResource
instance GHC.Show.Show Amazonka.Rum.TagResource.TagResource
instance GHC.Read.Read Amazonka.Rum.TagResource.TagResource
instance GHC.Classes.Eq Amazonka.Rum.TagResource.TagResource
instance GHC.Generics.Generic Amazonka.Rum.TagResource.TagResourceResponse
instance GHC.Show.Show Amazonka.Rum.TagResource.TagResourceResponse
instance GHC.Read.Read Amazonka.Rum.TagResource.TagResourceResponse
instance GHC.Classes.Eq Amazonka.Rum.TagResource.TagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.Rum.TagResource.TagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.Rum.TagResource.TagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.TagResource.TagResource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.TagResource.TagResource
instance Amazonka.Data.Path.ToPath Amazonka.Rum.TagResource.TagResource
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.TagResource.TagResource
-- | Creates or updates a destination to receive extended metrics from
-- CloudWatch RUM. You can send extended metrics to CloudWatch or to a
-- CloudWatch Evidently experiment.
--
-- For more information about extended metrics, see AddRumMetrics.
module Amazonka.Rum.PutRumMetricsDestination
-- | See: newPutRumMetricsDestination smart constructor.
data PutRumMetricsDestination
PutRumMetricsDestination' :: Maybe Text -> Maybe Text -> Text -> MetricDestination -> PutRumMetricsDestination
-- | Use this parameter only if Destination is Evidently.
-- This parameter specifies the ARN of the Evidently experiment that will
-- receive the extended metrics.
[$sel:destinationArn:PutRumMetricsDestination'] :: PutRumMetricsDestination -> Maybe Text
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter.
--
-- This parameter specifies the ARN of an IAM role that RUM will assume
-- to write to the Evidently experiment that you are sending metrics to.
-- This role must have permission to write to that experiment.
[$sel:iamRoleArn:PutRumMetricsDestination'] :: PutRumMetricsDestination -> Maybe Text
-- | The name of the CloudWatch RUM app monitor that will send the metrics.
[$sel:appMonitorName:PutRumMetricsDestination'] :: PutRumMetricsDestination -> Text
-- | 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.
[$sel:destination:PutRumMetricsDestination'] :: PutRumMetricsDestination -> MetricDestination
-- | Create a value of PutRumMetricsDestination with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_destinationArn - Use this parameter
-- only if Destination is Evidently. This parameter
-- specifies the ARN of the Evidently experiment that will receive the
-- extended metrics.
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_iamRoleArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of an IAM role that RUM will assume
-- to write to the Evidently experiment that you are sending metrics to.
-- This role must have permission to write to that experiment.
--
-- $sel:appMonitorName:PutRumMetricsDestination',
-- putRumMetricsDestination_appMonitorName - The name of the
-- CloudWatch RUM app monitor that will send the metrics.
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_destination - Defines the destination
-- to send the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that is to be
-- the destination and an IAM role that has permission to write to the
-- experiment.
newPutRumMetricsDestination :: Text -> MetricDestination -> PutRumMetricsDestination
-- | Use this parameter only if Destination is Evidently.
-- This parameter specifies the ARN of the Evidently experiment that will
-- receive the extended metrics.
putRumMetricsDestination_destinationArn :: Lens' PutRumMetricsDestination (Maybe Text)
-- | 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_iamRoleArn :: Lens' PutRumMetricsDestination (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that will send the metrics.
putRumMetricsDestination_appMonitorName :: Lens' PutRumMetricsDestination Text
-- | 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.
putRumMetricsDestination_destination :: Lens' PutRumMetricsDestination MetricDestination
-- | See: newPutRumMetricsDestinationResponse smart
-- constructor.
data PutRumMetricsDestinationResponse
PutRumMetricsDestinationResponse' :: Int -> PutRumMetricsDestinationResponse
-- | The response's http status code.
[$sel:httpStatus:PutRumMetricsDestinationResponse'] :: PutRumMetricsDestinationResponse -> Int
-- | Create a value of PutRumMetricsDestinationResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:PutRumMetricsDestinationResponse',
-- putRumMetricsDestinationResponse_httpStatus - The response's
-- http status code.
newPutRumMetricsDestinationResponse :: Int -> PutRumMetricsDestinationResponse
-- | The response's http status code.
putRumMetricsDestinationResponse_httpStatus :: Lens' PutRumMetricsDestinationResponse Int
instance GHC.Generics.Generic Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance GHC.Show.Show Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance GHC.Read.Read Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance GHC.Classes.Eq Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance GHC.Generics.Generic Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestinationResponse
instance GHC.Show.Show Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestinationResponse
instance GHC.Read.Read Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestinationResponse
instance GHC.Classes.Eq Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestinationResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Control.DeepSeq.NFData Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestinationResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Control.DeepSeq.NFData Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Amazonka.Data.Path.ToPath Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.PutRumMetricsDestination.PutRumMetricsDestination
-- | Sends telemetry events about your application performance and user
-- behavior to CloudWatch RUM. The code snippet that RUM generates for
-- you to add to your application includes PutRumEvents
-- operations to send this data to RUM.
--
-- Each PutRumEvents operation can send a batch of events from
-- one user session.
module Amazonka.Rum.PutRumEvents
-- | See: newPutRumEvents smart constructor.
data PutRumEvents
PutRumEvents' :: AppMonitorDetails -> Text -> Text -> [RumEvent] -> UserDetails -> PutRumEvents
-- | A structure that contains information about the app monitor that
-- collected this telemetry information.
[$sel:appMonitorDetails:PutRumEvents'] :: PutRumEvents -> AppMonitorDetails
-- | A unique identifier for this batch of RUM event data.
[$sel:batchId:PutRumEvents'] :: PutRumEvents -> Text
-- | The ID of the app monitor that is sending this data.
[$sel:id:PutRumEvents'] :: PutRumEvents -> Text
-- | An array of structures that contain the telemetry event data.
[$sel:rumEvents:PutRumEvents'] :: PutRumEvents -> [RumEvent]
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
[$sel:userDetails:PutRumEvents'] :: PutRumEvents -> UserDetails
-- | Create a value of PutRumEvents with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitorDetails:PutRumEvents',
-- putRumEvents_appMonitorDetails - A structure that contains
-- information about the app monitor that collected this telemetry
-- information.
--
-- $sel:batchId:PutRumEvents', putRumEvents_batchId - A
-- unique identifier for this batch of RUM event data.
--
-- PutRumEvents, putRumEvents_id - The ID of the app
-- monitor that is sending this data.
--
-- $sel:rumEvents:PutRumEvents', putRumEvents_rumEvents -
-- An array of structures that contain the telemetry event data.
--
-- $sel:userDetails:PutRumEvents', putRumEvents_userDetails
-- - A structure that contains information about the user session that
-- this batch of events was collected from.
newPutRumEvents :: AppMonitorDetails -> Text -> Text -> UserDetails -> PutRumEvents
-- | A structure that contains information about the app monitor that
-- collected this telemetry information.
putRumEvents_appMonitorDetails :: Lens' PutRumEvents AppMonitorDetails
-- | A unique identifier for this batch of RUM event data.
putRumEvents_batchId :: Lens' PutRumEvents Text
-- | The ID of the app monitor that is sending this data.
putRumEvents_id :: Lens' PutRumEvents Text
-- | An array of structures that contain the telemetry event data.
putRumEvents_rumEvents :: Lens' PutRumEvents [RumEvent]
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
putRumEvents_userDetails :: Lens' PutRumEvents UserDetails
-- | See: newPutRumEventsResponse smart constructor.
data PutRumEventsResponse
PutRumEventsResponse' :: Int -> PutRumEventsResponse
-- | The response's http status code.
[$sel:httpStatus:PutRumEventsResponse'] :: PutRumEventsResponse -> Int
-- | Create a value of PutRumEventsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:PutRumEventsResponse',
-- putRumEventsResponse_httpStatus - The response's http status
-- code.
newPutRumEventsResponse :: Int -> PutRumEventsResponse
-- | The response's http status code.
putRumEventsResponse_httpStatus :: Lens' PutRumEventsResponse Int
instance GHC.Generics.Generic Amazonka.Rum.PutRumEvents.PutRumEvents
instance GHC.Show.Show Amazonka.Rum.PutRumEvents.PutRumEvents
instance GHC.Read.Read Amazonka.Rum.PutRumEvents.PutRumEvents
instance GHC.Classes.Eq Amazonka.Rum.PutRumEvents.PutRumEvents
instance GHC.Generics.Generic Amazonka.Rum.PutRumEvents.PutRumEventsResponse
instance GHC.Show.Show Amazonka.Rum.PutRumEvents.PutRumEventsResponse
instance GHC.Read.Read Amazonka.Rum.PutRumEvents.PutRumEventsResponse
instance GHC.Classes.Eq Amazonka.Rum.PutRumEvents.PutRumEventsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.PutRumEvents.PutRumEvents
instance Control.DeepSeq.NFData Amazonka.Rum.PutRumEvents.PutRumEventsResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.PutRumEvents.PutRumEvents
instance Control.DeepSeq.NFData Amazonka.Rum.PutRumEvents.PutRumEvents
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.PutRumEvents.PutRumEvents
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.PutRumEvents.PutRumEvents
instance Amazonka.Data.Path.ToPath Amazonka.Rum.PutRumEvents.PutRumEvents
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.PutRumEvents.PutRumEvents
-- | Displays the tags associated with a CloudWatch RUM resource.
module Amazonka.Rum.ListTagsForResource
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | The ARN of the resource that you want to see the tags of.
[$sel:resourceArn:ListTagsForResource'] :: ListTagsForResource -> Text
-- | Create a value of ListTagsForResource with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- ListTagsForResource, listTagsForResource_resourceArn -
-- The ARN of the resource that you want to see the tags of.
newListTagsForResource :: Text -> ListTagsForResource
-- | The ARN of the resource that you want to see the tags of.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Int -> Text -> HashMap Text Text -> ListTagsForResourceResponse
-- | The response's http status code.
[$sel:httpStatus:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Int
-- | The ARN of the resource that you are viewing.
[$sel:resourceArn:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Text
-- | The list of tag keys and values associated with the resource you
-- specified.
[$sel:tags:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> HashMap Text Text
-- | Create a value of ListTagsForResourceResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
--
-- ListTagsForResource,
-- listTagsForResourceResponse_resourceArn - The ARN of the
-- resource that you are viewing.
--
-- ListTagsForResourceResponse,
-- listTagsForResourceResponse_tags - The list of tag keys and
-- values associated with the resource you specified.
newListTagsForResourceResponse :: Int -> Text -> ListTagsForResourceResponse
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
-- | The ARN of the resource that you are viewing.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse Text
-- | The list of tag keys and values associated with the resource you
-- specified.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text)
instance GHC.Generics.Generic Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance GHC.Show.Show Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance GHC.Read.Read Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance GHC.Classes.Eq Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance GHC.Generics.Generic Amazonka.Rum.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Show.Show Amazonka.Rum.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Read.Read Amazonka.Rum.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Classes.Eq Amazonka.Rum.ListTagsForResource.ListTagsForResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.Rum.ListTagsForResource.ListTagsForResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Path.ToPath Amazonka.Rum.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.ListTagsForResource.ListTagsForResource
-- | Returns a list of destinations that you have created to receive RUM
-- extended metrics, for the specified app monitor.
--
-- For more information about extended metrics, see AddRumMetrics.
--
-- This operation returns paginated results.
module Amazonka.Rum.ListRumMetricsDestinations
-- | See: newListRumMetricsDestinations smart constructor.
data ListRumMetricsDestinations
ListRumMetricsDestinations' :: Maybe Natural -> Maybe Text -> Text -> ListRumMetricsDestinations
-- | 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.
[$sel:maxResults:ListRumMetricsDestinations'] :: ListRumMetricsDestinations -> Maybe Natural
-- | Use the token returned by the previous operation to request the next
-- page of results.
[$sel:nextToken:ListRumMetricsDestinations'] :: ListRumMetricsDestinations -> Maybe Text
-- | The name of the app monitor associated with the destinations that you
-- want to retrieve.
[$sel:appMonitorName:ListRumMetricsDestinations'] :: ListRumMetricsDestinations -> Text
-- | Create a value of ListRumMetricsDestinations with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:maxResults:ListRumMetricsDestinations',
-- listRumMetricsDestinations_maxResults - The maximum number of
-- results to return in one operation. The default is 50. The maximum
-- that you can specify is 100.
--
-- To retrieve the remaining results, make another call with the returned
-- NextToken value.
--
-- ListRumMetricsDestinations,
-- listRumMetricsDestinations_nextToken - Use the token returned
-- by the previous operation to request the next page of results.
--
-- $sel:appMonitorName:ListRumMetricsDestinations',
-- listRumMetricsDestinations_appMonitorName - The name of the app
-- monitor associated with the destinations that you want to retrieve.
newListRumMetricsDestinations :: Text -> ListRumMetricsDestinations
-- | 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_maxResults :: Lens' ListRumMetricsDestinations (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
listRumMetricsDestinations_nextToken :: Lens' ListRumMetricsDestinations (Maybe Text)
-- | The name of the app monitor associated with the destinations that you
-- want to retrieve.
listRumMetricsDestinations_appMonitorName :: Lens' ListRumMetricsDestinations Text
-- | See: newListRumMetricsDestinationsResponse smart
-- constructor.
data ListRumMetricsDestinationsResponse
ListRumMetricsDestinationsResponse' :: Maybe [MetricDestinationSummary] -> Maybe Text -> Int -> ListRumMetricsDestinationsResponse
-- | The list of CloudWatch RUM extended metrics destinations associated
-- with the app monitor that you specified.
[$sel:destinations:ListRumMetricsDestinationsResponse'] :: ListRumMetricsDestinationsResponse -> Maybe [MetricDestinationSummary]
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
[$sel:nextToken:ListRumMetricsDestinationsResponse'] :: ListRumMetricsDestinationsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListRumMetricsDestinationsResponse'] :: ListRumMetricsDestinationsResponse -> Int
-- | Create a value of ListRumMetricsDestinationsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:destinations:ListRumMetricsDestinationsResponse',
-- listRumMetricsDestinationsResponse_destinations - The list of
-- CloudWatch RUM extended metrics destinations associated with the app
-- monitor that you specified.
--
-- ListRumMetricsDestinations,
-- listRumMetricsDestinationsResponse_nextToken - A token that you
-- can use in a subsequent operation to retrieve the next set of results.
--
-- $sel:httpStatus:ListRumMetricsDestinationsResponse',
-- listRumMetricsDestinationsResponse_httpStatus - The response's
-- http status code.
newListRumMetricsDestinationsResponse :: Int -> ListRumMetricsDestinationsResponse
-- | The list of CloudWatch RUM extended metrics destinations associated
-- with the app monitor that you specified.
listRumMetricsDestinationsResponse_destinations :: Lens' ListRumMetricsDestinationsResponse (Maybe [MetricDestinationSummary])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
listRumMetricsDestinationsResponse_nextToken :: Lens' ListRumMetricsDestinationsResponse (Maybe Text)
-- | The response's http status code.
listRumMetricsDestinationsResponse_httpStatus :: Lens' ListRumMetricsDestinationsResponse Int
instance GHC.Generics.Generic Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance GHC.Show.Show Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance GHC.Read.Read Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance GHC.Classes.Eq Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance GHC.Generics.Generic Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinationsResponse
instance GHC.Show.Show Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinationsResponse
instance GHC.Read.Read Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinationsResponse
instance GHC.Classes.Eq Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinationsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Control.DeepSeq.NFData Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinationsResponse
instance Amazonka.Pager.AWSPager Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Data.Hashable.Class.Hashable Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Control.DeepSeq.NFData Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Amazonka.Data.Path.ToPath Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.ListRumMetricsDestinations.ListRumMetricsDestinations
-- | Returns a list of the Amazon CloudWatch RUM app monitors in the
-- account.
--
-- This operation returns paginated results.
module Amazonka.Rum.ListAppMonitors
-- | See: newListAppMonitors smart constructor.
data ListAppMonitors
ListAppMonitors' :: Maybe Natural -> Maybe Text -> ListAppMonitors
-- | The maximum number of results to return in one operation. The default
-- is 50. The maximum that you can specify is 100.
[$sel:maxResults:ListAppMonitors'] :: ListAppMonitors -> Maybe Natural
-- | Use the token returned by the previous operation to request the next
-- page of results.
[$sel:nextToken:ListAppMonitors'] :: ListAppMonitors -> Maybe Text
-- | Create a value of ListAppMonitors with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:maxResults:ListAppMonitors',
-- listAppMonitors_maxResults - The maximum number of results to
-- return in one operation. The default is 50. The maximum that you can
-- specify is 100.
--
-- ListAppMonitors, listAppMonitors_nextToken - Use the
-- token returned by the previous operation to request the next page of
-- results.
newListAppMonitors :: ListAppMonitors
-- | The maximum number of results to return in one operation. The default
-- is 50. The maximum that you can specify is 100.
listAppMonitors_maxResults :: Lens' ListAppMonitors (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
listAppMonitors_nextToken :: Lens' ListAppMonitors (Maybe Text)
-- | See: newListAppMonitorsResponse smart constructor.
data ListAppMonitorsResponse
ListAppMonitorsResponse' :: Maybe [AppMonitorSummary] -> Maybe Text -> Int -> ListAppMonitorsResponse
-- | An array of structures that contain information about the returned app
-- monitors.
[$sel:appMonitorSummaries:ListAppMonitorsResponse'] :: ListAppMonitorsResponse -> Maybe [AppMonitorSummary]
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
[$sel:nextToken:ListAppMonitorsResponse'] :: ListAppMonitorsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListAppMonitorsResponse'] :: ListAppMonitorsResponse -> Int
-- | Create a value of ListAppMonitorsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitorSummaries:ListAppMonitorsResponse',
-- listAppMonitorsResponse_appMonitorSummaries - An array of
-- structures that contain information about the returned app monitors.
--
-- ListAppMonitors, listAppMonitorsResponse_nextToken - A
-- token that you can use in a subsequent operation to retrieve the next
-- set of results.
--
-- $sel:httpStatus:ListAppMonitorsResponse',
-- listAppMonitorsResponse_httpStatus - The response's http status
-- code.
newListAppMonitorsResponse :: Int -> ListAppMonitorsResponse
-- | An array of structures that contain information about the returned app
-- monitors.
listAppMonitorsResponse_appMonitorSummaries :: Lens' ListAppMonitorsResponse (Maybe [AppMonitorSummary])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
listAppMonitorsResponse_nextToken :: Lens' ListAppMonitorsResponse (Maybe Text)
-- | The response's http status code.
listAppMonitorsResponse_httpStatus :: Lens' ListAppMonitorsResponse Int
instance GHC.Generics.Generic Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance GHC.Show.Show Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance GHC.Read.Read Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance GHC.Classes.Eq Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance GHC.Generics.Generic Amazonka.Rum.ListAppMonitors.ListAppMonitorsResponse
instance GHC.Show.Show Amazonka.Rum.ListAppMonitors.ListAppMonitorsResponse
instance GHC.Read.Read Amazonka.Rum.ListAppMonitors.ListAppMonitorsResponse
instance GHC.Classes.Eq Amazonka.Rum.ListAppMonitors.ListAppMonitorsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Control.DeepSeq.NFData Amazonka.Rum.ListAppMonitors.ListAppMonitorsResponse
instance Amazonka.Pager.AWSPager Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Data.Hashable.Class.Hashable Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Control.DeepSeq.NFData Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Amazonka.Data.Path.ToPath Amazonka.Rum.ListAppMonitors.ListAppMonitors
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.ListAppMonitors.ListAppMonitors
-- | Retrieves the raw performance events that RUM has collected from your
-- web application, so that you can do your own processing or analysis of
-- this data.
--
-- This operation returns paginated results.
module Amazonka.Rum.GetAppMonitorData
-- | See: newGetAppMonitorData smart constructor.
data GetAppMonitorData
GetAppMonitorData' :: Maybe [QueryFilter] -> Maybe Natural -> Maybe Text -> Text -> TimeRange -> GetAppMonitorData
-- | An array of structures that you can use to filter the results to those
-- that match one or more sets of key-value pairs that you specify.
[$sel:filters:GetAppMonitorData'] :: GetAppMonitorData -> Maybe [QueryFilter]
-- | The maximum number of results to return in one operation.
[$sel:maxResults:GetAppMonitorData'] :: GetAppMonitorData -> Maybe Natural
-- | Use the token returned by the previous operation to request the next
-- page of results.
[$sel:nextToken:GetAppMonitorData'] :: GetAppMonitorData -> Maybe Text
-- | The name of the app monitor that collected the data that you want to
-- retrieve.
[$sel:name:GetAppMonitorData'] :: GetAppMonitorData -> Text
-- | A structure that defines the time range that you want to retrieve
-- results from.
[$sel:timeRange:GetAppMonitorData'] :: GetAppMonitorData -> TimeRange
-- | Create a value of GetAppMonitorData with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:filters:GetAppMonitorData',
-- getAppMonitorData_filters - An array of structures that you can
-- use to filter the results to those that match one or more sets of
-- key-value pairs that you specify.
--
-- $sel:maxResults:GetAppMonitorData',
-- getAppMonitorData_maxResults - The maximum number of results to
-- return in one operation.
--
-- GetAppMonitorData, getAppMonitorData_nextToken - Use the
-- token returned by the previous operation to request the next page of
-- results.
--
-- GetAppMonitorData, getAppMonitorData_name - The name of
-- the app monitor that collected the data that you want to retrieve.
--
-- $sel:timeRange:GetAppMonitorData',
-- getAppMonitorData_timeRange - A structure that defines the time
-- range that you want to retrieve results from.
newGetAppMonitorData :: Text -> TimeRange -> GetAppMonitorData
-- | 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_filters :: Lens' GetAppMonitorData (Maybe [QueryFilter])
-- | The maximum number of results to return in one operation.
getAppMonitorData_maxResults :: Lens' GetAppMonitorData (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
getAppMonitorData_nextToken :: Lens' GetAppMonitorData (Maybe Text)
-- | The name of the app monitor that collected the data that you want to
-- retrieve.
getAppMonitorData_name :: Lens' GetAppMonitorData Text
-- | A structure that defines the time range that you want to retrieve
-- results from.
getAppMonitorData_timeRange :: Lens' GetAppMonitorData TimeRange
-- | See: newGetAppMonitorDataResponse smart constructor.
data GetAppMonitorDataResponse
GetAppMonitorDataResponse' :: Maybe [Text] -> Maybe Text -> Int -> GetAppMonitorDataResponse
-- | The events that RUM collected that match your request.
[$sel:events:GetAppMonitorDataResponse'] :: GetAppMonitorDataResponse -> Maybe [Text]
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
[$sel:nextToken:GetAppMonitorDataResponse'] :: GetAppMonitorDataResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetAppMonitorDataResponse'] :: GetAppMonitorDataResponse -> Int
-- | Create a value of GetAppMonitorDataResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:events:GetAppMonitorDataResponse',
-- getAppMonitorDataResponse_events - The events that RUM
-- collected that match your request.
--
-- GetAppMonitorData, getAppMonitorDataResponse_nextToken -
-- A token that you can use in a subsequent operation to retrieve the
-- next set of results.
--
-- $sel:httpStatus:GetAppMonitorDataResponse',
-- getAppMonitorDataResponse_httpStatus - The response's http
-- status code.
newGetAppMonitorDataResponse :: Int -> GetAppMonitorDataResponse
-- | The events that RUM collected that match your request.
getAppMonitorDataResponse_events :: Lens' GetAppMonitorDataResponse (Maybe [Text])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
getAppMonitorDataResponse_nextToken :: Lens' GetAppMonitorDataResponse (Maybe Text)
-- | The response's http status code.
getAppMonitorDataResponse_httpStatus :: Lens' GetAppMonitorDataResponse Int
instance GHC.Generics.Generic Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance GHC.Show.Show Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance GHC.Read.Read Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance GHC.Classes.Eq Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance GHC.Generics.Generic Amazonka.Rum.GetAppMonitorData.GetAppMonitorDataResponse
instance GHC.Show.Show Amazonka.Rum.GetAppMonitorData.GetAppMonitorDataResponse
instance GHC.Read.Read Amazonka.Rum.GetAppMonitorData.GetAppMonitorDataResponse
instance GHC.Classes.Eq Amazonka.Rum.GetAppMonitorData.GetAppMonitorDataResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Control.DeepSeq.NFData Amazonka.Rum.GetAppMonitorData.GetAppMonitorDataResponse
instance Amazonka.Pager.AWSPager Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Data.Hashable.Class.Hashable Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Control.DeepSeq.NFData Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Amazonka.Data.Path.ToPath Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.GetAppMonitorData.GetAppMonitorData
-- | Retrieves the complete configuration information for one app monitor.
module Amazonka.Rum.GetAppMonitor
-- | See: newGetAppMonitor smart constructor.
data GetAppMonitor
GetAppMonitor' :: Text -> GetAppMonitor
-- | The app monitor to retrieve information for.
[$sel:name:GetAppMonitor'] :: GetAppMonitor -> Text
-- | Create a value of GetAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- GetAppMonitor, getAppMonitor_name - The app monitor to
-- retrieve information for.
newGetAppMonitor :: Text -> GetAppMonitor
-- | The app monitor to retrieve information for.
getAppMonitor_name :: Lens' GetAppMonitor Text
-- | See: newGetAppMonitorResponse smart constructor.
data GetAppMonitorResponse
GetAppMonitorResponse' :: Maybe AppMonitor -> Int -> GetAppMonitorResponse
-- | A structure containing all the configuration information for the app
-- monitor.
[$sel:appMonitor:GetAppMonitorResponse'] :: GetAppMonitorResponse -> Maybe AppMonitor
-- | The response's http status code.
[$sel:httpStatus:GetAppMonitorResponse'] :: GetAppMonitorResponse -> Int
-- | Create a value of GetAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitor:GetAppMonitorResponse',
-- getAppMonitorResponse_appMonitor - A structure containing all
-- the configuration information for the app monitor.
--
-- $sel:httpStatus:GetAppMonitorResponse',
-- getAppMonitorResponse_httpStatus - The response's http status
-- code.
newGetAppMonitorResponse :: Int -> GetAppMonitorResponse
-- | A structure containing all the configuration information for the app
-- monitor.
getAppMonitorResponse_appMonitor :: Lens' GetAppMonitorResponse (Maybe AppMonitor)
-- | The response's http status code.
getAppMonitorResponse_httpStatus :: Lens' GetAppMonitorResponse Int
instance GHC.Generics.Generic Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance GHC.Show.Show Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance GHC.Read.Read Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance GHC.Classes.Eq Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance GHC.Generics.Generic Amazonka.Rum.GetAppMonitor.GetAppMonitorResponse
instance GHC.Show.Show Amazonka.Rum.GetAppMonitor.GetAppMonitorResponse
instance GHC.Read.Read Amazonka.Rum.GetAppMonitor.GetAppMonitorResponse
instance GHC.Classes.Eq Amazonka.Rum.GetAppMonitor.GetAppMonitorResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.GetAppMonitor.GetAppMonitorResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance Amazonka.Data.Path.ToPath Amazonka.Rum.GetAppMonitor.GetAppMonitor
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.GetAppMonitor.GetAppMonitor
-- | Deletes a destination for CloudWatch RUM extended metrics, so that the
-- specified app monitor stops sending extended metrics to that
-- destination.
module Amazonka.Rum.DeleteRumMetricsDestination
-- | See: newDeleteRumMetricsDestination smart constructor.
data DeleteRumMetricsDestination
DeleteRumMetricsDestination' :: Maybe Text -> Text -> MetricDestination -> DeleteRumMetricsDestination
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter. This parameter specifies the ARN of the
-- Evidently experiment that corresponds to the destination to delete.
[$sel:destinationArn:DeleteRumMetricsDestination'] :: DeleteRumMetricsDestination -> Maybe Text
-- | The name of the app monitor that is sending metrics to the destination
-- that you want to delete.
[$sel:appMonitorName:DeleteRumMetricsDestination'] :: DeleteRumMetricsDestination -> Text
-- | The type of destination to delete. Valid values are
-- CloudWatch and Evidently.
[$sel:destination:DeleteRumMetricsDestination'] :: DeleteRumMetricsDestination -> MetricDestination
-- | Create a value of DeleteRumMetricsDestination with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteRumMetricsDestination,
-- deleteRumMetricsDestination_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter. This parameter specifies the ARN of the Evidently
-- experiment that corresponds to the destination to delete.
--
-- $sel:appMonitorName:DeleteRumMetricsDestination',
-- deleteRumMetricsDestination_appMonitorName - The name of the
-- app monitor that is sending metrics to the destination that you want
-- to delete.
--
-- DeleteRumMetricsDestination,
-- deleteRumMetricsDestination_destination - The type of
-- destination to delete. Valid values are CloudWatch and
-- Evidently.
newDeleteRumMetricsDestination :: Text -> MetricDestination -> DeleteRumMetricsDestination
-- | 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_destinationArn :: Lens' DeleteRumMetricsDestination (Maybe Text)
-- | The name of the app monitor that is sending metrics to the destination
-- that you want to delete.
deleteRumMetricsDestination_appMonitorName :: Lens' DeleteRumMetricsDestination Text
-- | The type of destination to delete. Valid values are
-- CloudWatch and Evidently.
deleteRumMetricsDestination_destination :: Lens' DeleteRumMetricsDestination MetricDestination
-- | See: newDeleteRumMetricsDestinationResponse smart
-- constructor.
data DeleteRumMetricsDestinationResponse
DeleteRumMetricsDestinationResponse' :: Int -> DeleteRumMetricsDestinationResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteRumMetricsDestinationResponse'] :: DeleteRumMetricsDestinationResponse -> Int
-- | Create a value of DeleteRumMetricsDestinationResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteRumMetricsDestinationResponse',
-- deleteRumMetricsDestinationResponse_httpStatus - The response's
-- http status code.
newDeleteRumMetricsDestinationResponse :: Int -> DeleteRumMetricsDestinationResponse
-- | The response's http status code.
deleteRumMetricsDestinationResponse_httpStatus :: Lens' DeleteRumMetricsDestinationResponse Int
instance GHC.Generics.Generic Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance GHC.Show.Show Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance GHC.Read.Read Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance GHC.Classes.Eq Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance GHC.Generics.Generic Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestinationResponse
instance GHC.Show.Show Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestinationResponse
instance GHC.Read.Read Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestinationResponse
instance GHC.Classes.Eq Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestinationResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance Control.DeepSeq.NFData Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestinationResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance Control.DeepSeq.NFData Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance Amazonka.Data.Path.ToPath Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.DeleteRumMetricsDestination.DeleteRumMetricsDestination
-- | Deletes an existing app monitor. This immediately stops the collection
-- of data.
module Amazonka.Rum.DeleteAppMonitor
-- | See: newDeleteAppMonitor smart constructor.
data DeleteAppMonitor
DeleteAppMonitor' :: Text -> DeleteAppMonitor
-- | The name of the app monitor to delete.
[$sel:name:DeleteAppMonitor'] :: DeleteAppMonitor -> Text
-- | Create a value of DeleteAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteAppMonitor, deleteAppMonitor_name - The name of
-- the app monitor to delete.
newDeleteAppMonitor :: Text -> DeleteAppMonitor
-- | The name of the app monitor to delete.
deleteAppMonitor_name :: Lens' DeleteAppMonitor Text
-- | See: newDeleteAppMonitorResponse smart constructor.
data DeleteAppMonitorResponse
DeleteAppMonitorResponse' :: Int -> DeleteAppMonitorResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteAppMonitorResponse'] :: DeleteAppMonitorResponse -> Int
-- | Create a value of DeleteAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteAppMonitorResponse',
-- deleteAppMonitorResponse_httpStatus - The response's http
-- status code.
newDeleteAppMonitorResponse :: Int -> DeleteAppMonitorResponse
-- | The response's http status code.
deleteAppMonitorResponse_httpStatus :: Lens' DeleteAppMonitorResponse Int
instance GHC.Generics.Generic Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance GHC.Show.Show Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance GHC.Read.Read Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance GHC.Classes.Eq Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance GHC.Generics.Generic Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitorResponse
instance GHC.Show.Show Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitorResponse
instance GHC.Read.Read Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitorResponse
instance GHC.Classes.Eq Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitorResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitorResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance Amazonka.Data.Path.ToPath Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.DeleteAppMonitor.DeleteAppMonitor
-- | Creates a Amazon CloudWatch RUM app monitor, which collects telemetry
-- data from your application and sends that data to RUM. The data
-- includes performance and reliability information such as page load
-- time, client-side errors, and user behavior.
--
-- You use this operation only to create a new app monitor. To update an
-- existing app monitor, use UpdateAppMonitor instead.
--
-- After you create an app monitor, sign in to the CloudWatch RUM console
-- to get the JavaScript code snippet to add to your web application. For
-- more information, see How do I find a code snippet that I've
-- already generated?
module Amazonka.Rum.CreateAppMonitor
-- | See: newCreateAppMonitor smart constructor.
data CreateAppMonitor
CreateAppMonitor' :: Maybe AppMonitorConfiguration -> Maybe CustomEvents -> Maybe Bool -> Maybe (HashMap Text Text) -> Text -> Text -> CreateAppMonitor
-- | 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.
[$sel:appMonitorConfiguration:CreateAppMonitor'] :: CreateAppMonitor -> Maybe AppMonitorConfiguration
-- | 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.
[$sel:customEvents:CreateAppMonitor'] :: CreateAppMonitor -> Maybe CustomEvents
-- | 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.
[$sel:cwLogEnabled:CreateAppMonitor'] :: CreateAppMonitor -> Maybe Bool
-- | 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.
[$sel:tags:CreateAppMonitor'] :: CreateAppMonitor -> Maybe (HashMap Text Text)
-- | The top-level internet domain name for which your application has
-- administrative authority.
[$sel:domain:CreateAppMonitor'] :: CreateAppMonitor -> Text
-- | A name for the app monitor.
[$sel:name:CreateAppMonitor'] :: CreateAppMonitor -> Text
-- | Create a value of CreateAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateAppMonitor,
-- createAppMonitor_appMonitorConfiguration - A structure that
-- contains much of the configuration data for the app monitor. If you
-- are using Amazon Cognito for authorization, you must include this
-- structure in your request, and it must include the ID of the Amazon
-- Cognito identity pool to use for authorization. If you don't include
-- AppMonitorConfiguration, you must set up your own
-- authorization method. For more information, see Authorize your
-- application to send data to Amazon Web Services.
--
-- If you omit this argument, the sample rate used for RUM is set to 10%
-- of the user sessions.
--
-- CreateAppMonitor, createAppMonitor_customEvents -
-- Specifies whether this app monitor allows the web client to define and
-- send custom events. If you omit this parameter, custom events are
-- DISABLED.
--
-- For more information about custom events, see Send custom
-- events.
--
-- CreateAppMonitor, createAppMonitor_cwLogEnabled - Data
-- collected by RUM is kept by RUM for 30 days and then deleted. This
-- parameter specifies whether RUM sends a copy of this telemetry data to
-- Amazon CloudWatch Logs in your account. This enables you to keep the
-- telemetry data for more than 30 days, but it does incur Amazon
-- CloudWatch Logs charges.
--
-- If you omit this parameter, the default is false.
--
-- CreateAppMonitor, createAppMonitor_tags - Assigns one or
-- more tags (key-value pairs) to the app monitor.
--
-- Tags can help you organize and categorize your resources. You can also
-- use them to scope user permissions by granting a user permission to
-- access or change only resources with certain tag values.
--
-- Tags don't have any semantic meaning to Amazon Web Services and are
-- interpreted strictly as strings of characters.
--
-- You can associate as many as 50 tags with an app monitor.
--
-- For more information, see Tagging Amazon Web Services
-- resources.
--
-- CreateAppMonitor, createAppMonitor_domain - The
-- top-level internet domain name for which your application has
-- administrative authority.
--
-- CreateAppMonitor, createAppMonitor_name - A name for the
-- app monitor.
newCreateAppMonitor :: Text -> Text -> CreateAppMonitor
-- | 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_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration)
-- | 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_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents)
-- | 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_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool)
-- | 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_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text))
-- | The top-level internet domain name for which your application has
-- administrative authority.
createAppMonitor_domain :: Lens' CreateAppMonitor Text
-- | A name for the app monitor.
createAppMonitor_name :: Lens' CreateAppMonitor Text
-- | See: newCreateAppMonitorResponse smart constructor.
data CreateAppMonitorResponse
CreateAppMonitorResponse' :: Maybe Text -> Int -> CreateAppMonitorResponse
-- | The unique ID of the new app monitor.
[$sel:id:CreateAppMonitorResponse'] :: CreateAppMonitorResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:CreateAppMonitorResponse'] :: CreateAppMonitorResponse -> Int
-- | Create a value of CreateAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateAppMonitorResponse, createAppMonitorResponse_id -
-- The unique ID of the new app monitor.
--
-- $sel:httpStatus:CreateAppMonitorResponse',
-- createAppMonitorResponse_httpStatus - The response's http
-- status code.
newCreateAppMonitorResponse :: Int -> CreateAppMonitorResponse
-- | The unique ID of the new app monitor.
createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text)
-- | The response's http status code.
createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int
instance GHC.Generics.Generic Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance GHC.Show.Show Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance GHC.Read.Read Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance GHC.Classes.Eq Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance GHC.Generics.Generic Amazonka.Rum.CreateAppMonitor.CreateAppMonitorResponse
instance GHC.Show.Show Amazonka.Rum.CreateAppMonitor.CreateAppMonitorResponse
instance GHC.Read.Read Amazonka.Rum.CreateAppMonitor.CreateAppMonitorResponse
instance GHC.Classes.Eq Amazonka.Rum.CreateAppMonitor.CreateAppMonitorResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.CreateAppMonitor.CreateAppMonitorResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Amazonka.Data.Path.ToPath Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.CreateAppMonitor.CreateAppMonitor
-- | Retrieves the list of metrics and dimensions that a RUM app monitor is
-- sending to a single destination.
--
-- This operation returns paginated results.
module Amazonka.Rum.BatchGetRumMetricDefinitions
-- | See: newBatchGetRumMetricDefinitions smart constructor.
data BatchGetRumMetricDefinitions
BatchGetRumMetricDefinitions' :: Maybe Text -> Maybe Natural -> Maybe Text -> Text -> MetricDestination -> BatchGetRumMetricDefinitions
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that
-- corresponds to the destination.
[$sel:destinationArn:BatchGetRumMetricDefinitions'] :: BatchGetRumMetricDefinitions -> Maybe Text
-- | 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.
[$sel:maxResults:BatchGetRumMetricDefinitions'] :: BatchGetRumMetricDefinitions -> Maybe Natural
-- | Use the token returned by the previous operation to request the next
-- page of results.
[$sel:nextToken:BatchGetRumMetricDefinitions'] :: BatchGetRumMetricDefinitions -> Maybe Text
-- | The name of the CloudWatch RUM app monitor that is sending the
-- metrics.
[$sel:appMonitorName:BatchGetRumMetricDefinitions'] :: BatchGetRumMetricDefinitions -> Text
-- | The type of destination that you want to view metrics for. Valid
-- values are CloudWatch and Evidently.
[$sel:destination:BatchGetRumMetricDefinitions'] :: BatchGetRumMetricDefinitions -> MetricDestination
-- | Create a value of BatchGetRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that
-- corresponds to the destination.
--
-- $sel:maxResults:BatchGetRumMetricDefinitions',
-- batchGetRumMetricDefinitions_maxResults - The maximum number of
-- results to return in one operation. The default is 50. The maximum
-- that you can specify is 100.
--
-- To retrieve the remaining results, make another call with the returned
-- NextToken value.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_nextToken - Use the token returned
-- by the previous operation to request the next page of results.
--
-- $sel:appMonitorName:BatchGetRumMetricDefinitions',
-- batchGetRumMetricDefinitions_appMonitorName - The name of the
-- CloudWatch RUM app monitor that is sending the metrics.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_destination - The type of
-- destination that you want to view metrics for. Valid values are
-- CloudWatch and Evidently.
newBatchGetRumMetricDefinitions :: Text -> MetricDestination -> BatchGetRumMetricDefinitions
-- | 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_destinationArn :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
-- | 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_maxResults :: Lens' BatchGetRumMetricDefinitions (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
batchGetRumMetricDefinitions_nextToken :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is sending the
-- metrics.
batchGetRumMetricDefinitions_appMonitorName :: Lens' BatchGetRumMetricDefinitions Text
-- | The type of destination that you want to view metrics for. Valid
-- values are CloudWatch and Evidently.
batchGetRumMetricDefinitions_destination :: Lens' BatchGetRumMetricDefinitions MetricDestination
-- | See: newBatchGetRumMetricDefinitionsResponse smart
-- constructor.
data BatchGetRumMetricDefinitionsResponse
BatchGetRumMetricDefinitionsResponse' :: Maybe [MetricDefinition] -> Maybe Text -> Int -> BatchGetRumMetricDefinitionsResponse
-- | An array of structures that display information about the metrics that
-- are sent by the specified app monitor to the specified destination.
[$sel:metricDefinitions:BatchGetRumMetricDefinitionsResponse'] :: BatchGetRumMetricDefinitionsResponse -> Maybe [MetricDefinition]
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
[$sel:nextToken:BatchGetRumMetricDefinitionsResponse'] :: BatchGetRumMetricDefinitionsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:BatchGetRumMetricDefinitionsResponse'] :: BatchGetRumMetricDefinitionsResponse -> Int
-- | Create a value of BatchGetRumMetricDefinitionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metricDefinitions:BatchGetRumMetricDefinitionsResponse',
-- batchGetRumMetricDefinitionsResponse_metricDefinitions - An
-- array of structures that display information about the metrics that
-- are sent by the specified app monitor to the specified destination.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitionsResponse_nextToken - A token that
-- you can use in a subsequent operation to retrieve the next set of
-- results.
--
-- $sel:httpStatus:BatchGetRumMetricDefinitionsResponse',
-- batchGetRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
newBatchGetRumMetricDefinitionsResponse :: Int -> BatchGetRumMetricDefinitionsResponse
-- | An array of structures that display information about the metrics that
-- are sent by the specified app monitor to the specified destination.
batchGetRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe [MetricDefinition])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
batchGetRumMetricDefinitionsResponse_nextToken :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe Text)
-- | The response's http status code.
batchGetRumMetricDefinitionsResponse_httpStatus :: Lens' BatchGetRumMetricDefinitionsResponse Int
instance GHC.Generics.Generic Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance GHC.Show.Show Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance GHC.Read.Read Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance GHC.Classes.Eq Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance GHC.Generics.Generic Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitionsResponse
instance GHC.Show.Show Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitionsResponse
instance GHC.Read.Read Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitionsResponse
instance GHC.Classes.Eq Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitionsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitionsResponse
instance Amazonka.Pager.AWSPager Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Data.Hashable.Class.Hashable Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Amazonka.Data.Path.ToPath Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.BatchGetRumMetricDefinitions.BatchGetRumMetricDefinitions
-- | Removes the specified metrics from being sent to an extended metrics
-- destination.
--
-- If some metric definition IDs specified in a
-- BatchDeleteRumMetricDefinitions operations are not valid,
-- those metric definitions fail and return errors, but all valid metric
-- definition IDs in the same operation are still deleted.
--
-- The maximum number of metric definitions that you can specify in one
-- BatchDeleteRumMetricDefinitions operation is 200.
module Amazonka.Rum.BatchDeleteRumMetricDefinitions
-- | See: newBatchDeleteRumMetricDefinitions smart
-- constructor.
data BatchDeleteRumMetricDefinitions
BatchDeleteRumMetricDefinitions' :: Maybe Text -> Text -> MetricDestination -> [Text] -> BatchDeleteRumMetricDefinitions
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that was
-- receiving the metrics that are being deleted.
[$sel:destinationArn:BatchDeleteRumMetricDefinitions'] :: BatchDeleteRumMetricDefinitions -> Maybe Text
-- | The name of the CloudWatch RUM app monitor that is sending these
-- metrics.
[$sel:appMonitorName:BatchDeleteRumMetricDefinitions'] :: BatchDeleteRumMetricDefinitions -> Text
-- | 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.
[$sel:destination:BatchDeleteRumMetricDefinitions'] :: BatchDeleteRumMetricDefinitions -> MetricDestination
-- | An array of structures which define the metrics that you want to stop
-- sending.
[$sel:metricDefinitionIds:BatchDeleteRumMetricDefinitions'] :: BatchDeleteRumMetricDefinitions -> [Text]
-- | Create a value of BatchDeleteRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_destinationArn - This parameter
-- is required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that was
-- receiving the metrics that are being deleted.
--
-- $sel:appMonitorName:BatchDeleteRumMetricDefinitions',
-- batchDeleteRumMetricDefinitions_appMonitorName - The name of
-- the CloudWatch RUM app monitor that is sending these metrics.
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_destination - Defines the
-- destination where you want to stop sending the specified metrics.
-- Valid values are CloudWatch and Evidently. If you
-- specify Evidently, you must also specify the ARN of the
-- CloudWatchEvidently experiment that is to be the destination and an
-- IAM role that has permission to write to the experiment.
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_metricDefinitionIds - An array
-- of structures which define the metrics that you want to stop sending.
newBatchDeleteRumMetricDefinitions :: Text -> MetricDestination -> BatchDeleteRumMetricDefinitions
-- | 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_destinationArn :: Lens' BatchDeleteRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is sending these
-- metrics.
batchDeleteRumMetricDefinitions_appMonitorName :: Lens' BatchDeleteRumMetricDefinitions Text
-- | 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_destination :: Lens' BatchDeleteRumMetricDefinitions MetricDestination
-- | An array of structures which define the metrics that you want to stop
-- sending.
batchDeleteRumMetricDefinitions_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitions [Text]
-- | See: newBatchDeleteRumMetricDefinitionsResponse smart
-- constructor.
data BatchDeleteRumMetricDefinitionsResponse
BatchDeleteRumMetricDefinitionsResponse' :: Maybe [Text] -> Int -> [BatchDeleteRumMetricDefinitionsError] -> BatchDeleteRumMetricDefinitionsResponse
-- | The IDs of the metric definitions that were deleted.
[$sel:metricDefinitionIds:BatchDeleteRumMetricDefinitionsResponse'] :: BatchDeleteRumMetricDefinitionsResponse -> Maybe [Text]
-- | The response's http status code.
[$sel:httpStatus:BatchDeleteRumMetricDefinitionsResponse'] :: BatchDeleteRumMetricDefinitionsResponse -> Int
-- | An array of error objects, if the operation caused any errors.
[$sel:errors:BatchDeleteRumMetricDefinitionsResponse'] :: BatchDeleteRumMetricDefinitionsResponse -> [BatchDeleteRumMetricDefinitionsError]
-- | Create a value of BatchDeleteRumMetricDefinitionsResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds -
-- The IDs of the metric definitions that were deleted.
--
-- $sel:httpStatus:BatchDeleteRumMetricDefinitionsResponse',
-- batchDeleteRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
--
-- $sel:errors:BatchDeleteRumMetricDefinitionsResponse',
-- batchDeleteRumMetricDefinitionsResponse_errors - An array of
-- error objects, if the operation caused any errors.
newBatchDeleteRumMetricDefinitionsResponse :: Int -> BatchDeleteRumMetricDefinitionsResponse
-- | The IDs of the metric definitions that were deleted.
batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitionsResponse (Maybe [Text])
-- | The response's http status code.
batchDeleteRumMetricDefinitionsResponse_httpStatus :: Lens' BatchDeleteRumMetricDefinitionsResponse Int
-- | An array of error objects, if the operation caused any errors.
batchDeleteRumMetricDefinitionsResponse_errors :: Lens' BatchDeleteRumMetricDefinitionsResponse [BatchDeleteRumMetricDefinitionsError]
instance GHC.Generics.Generic Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance GHC.Show.Show Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance GHC.Read.Read Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance GHC.Classes.Eq Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance GHC.Generics.Generic Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitionsResponse
instance GHC.Show.Show Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitionsResponse
instance GHC.Read.Read Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitionsResponse
instance GHC.Classes.Eq Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitionsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitionsResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance Amazonka.Data.Path.ToPath Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.BatchDeleteRumMetricDefinitions.BatchDeleteRumMetricDefinitions
-- | Specifies the extended metrics that you want a CloudWatch RUM app
-- monitor to send to a destination. Valid destinations include
-- CloudWatch and Evidently.
--
-- By default, RUM app monitors send some metrics to CloudWatch. These
-- default metrics are listed in CloudWatch metrics that you can
-- collect with CloudWatch RUM.
--
-- If you also send extended metrics, you can send metrics to Evidently
-- as well as CloudWatch, and you can also optionally send the metrics
-- with additional dimensions. The valid dimension names for the
-- additional dimensions are BrowserName, CountryCode,
-- DeviceType, FileType, OSName, and
-- PageId. For more information, see Extended metrics that
-- you can send to CloudWatch and CloudWatch Evidently.
--
-- The maximum number of metric definitions that you can specify in one
-- BatchCreateRumMetricDefinitions operation is 200.
--
-- The maximum number of metric definitions that one destination can
-- contain is 2000.
--
-- Extended metrics sent are charged as CloudWatch custom metrics. Each
-- combination of additional dimension name and dimension value counts as
-- a custom metric. For more information, see Amazon CloudWatch
-- Pricing.
--
-- You must have already created a destination for the metrics before you
-- send them. For more information, see PutRumMetricsDestination.
--
-- If some metric definitions specified in a
-- BatchCreateRumMetricDefinitions operations are not valid,
-- those metric definitions fail and return errors, but all valid metric
-- definitions in the same operation still succeed.
module Amazonka.Rum.BatchCreateRumMetricDefinitions
-- | See: newBatchCreateRumMetricDefinitions smart
-- constructor.
data BatchCreateRumMetricDefinitions
BatchCreateRumMetricDefinitions' :: Maybe Text -> Text -> MetricDestination -> [MetricDefinitionRequest] -> BatchCreateRumMetricDefinitions
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
[$sel:destinationArn:BatchCreateRumMetricDefinitions'] :: BatchCreateRumMetricDefinitions -> Maybe Text
-- | The name of the CloudWatch RUM app monitor that is to send the
-- metrics.
[$sel:appMonitorName:BatchCreateRumMetricDefinitions'] :: BatchCreateRumMetricDefinitions -> Text
-- | 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.
[$sel:destination:BatchCreateRumMetricDefinitions'] :: BatchCreateRumMetricDefinitions -> MetricDestination
-- | An array of structures which define the metrics that you want to send.
[$sel:metricDefinitions:BatchCreateRumMetricDefinitions'] :: BatchCreateRumMetricDefinitions -> [MetricDefinitionRequest]
-- | Create a value of BatchCreateRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_destinationArn - This parameter
-- is required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
--
-- $sel:appMonitorName:BatchCreateRumMetricDefinitions',
-- batchCreateRumMetricDefinitions_appMonitorName - The name of
-- the CloudWatch RUM app monitor that is to send the metrics.
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_destination - The destination
-- to send the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that will
-- receive the metrics and an IAM role that has permission to write to
-- the experiment.
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_metricDefinitions - An array of
-- structures which define the metrics that you want to send.
newBatchCreateRumMetricDefinitions :: Text -> MetricDestination -> BatchCreateRumMetricDefinitions
-- | 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_destinationArn :: Lens' BatchCreateRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is to send the
-- metrics.
batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text
-- | 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_destination :: Lens' BatchCreateRumMetricDefinitions MetricDestination
-- | An array of structures which define the metrics that you want to send.
batchCreateRumMetricDefinitions_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest]
-- | See: newBatchCreateRumMetricDefinitionsResponse smart
-- constructor.
data BatchCreateRumMetricDefinitionsResponse
BatchCreateRumMetricDefinitionsResponse' :: Maybe [MetricDefinition] -> Int -> [BatchCreateRumMetricDefinitionsError] -> BatchCreateRumMetricDefinitionsResponse
-- | An array of structures that define the extended metrics.
[$sel:metricDefinitions:BatchCreateRumMetricDefinitionsResponse'] :: BatchCreateRumMetricDefinitionsResponse -> Maybe [MetricDefinition]
-- | The response's http status code.
[$sel:httpStatus:BatchCreateRumMetricDefinitionsResponse'] :: BatchCreateRumMetricDefinitionsResponse -> Int
-- | An array of error objects, if the operation caused any errors.
[$sel:errors:BatchCreateRumMetricDefinitionsResponse'] :: BatchCreateRumMetricDefinitionsResponse -> [BatchCreateRumMetricDefinitionsError]
-- | Create a value of BatchCreateRumMetricDefinitionsResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitionsResponse_metricDefinitions - An
-- array of structures that define the extended metrics.
--
-- $sel:httpStatus:BatchCreateRumMetricDefinitionsResponse',
-- batchCreateRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
--
-- $sel:errors:BatchCreateRumMetricDefinitionsResponse',
-- batchCreateRumMetricDefinitionsResponse_errors - An array of
-- error objects, if the operation caused any errors.
newBatchCreateRumMetricDefinitionsResponse :: Int -> BatchCreateRumMetricDefinitionsResponse
-- | An array of structures that define the extended metrics.
batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition])
-- | The response's http status code.
batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int
-- | An array of error objects, if the operation caused any errors.
batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError]
instance GHC.Generics.Generic Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance GHC.Show.Show Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance GHC.Read.Read Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance GHC.Classes.Eq Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance GHC.Generics.Generic Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitionsResponse
instance GHC.Show.Show Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitionsResponse
instance GHC.Read.Read Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitionsResponse
instance GHC.Classes.Eq Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitionsResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitionsResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Control.DeepSeq.NFData Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Amazonka.Data.Path.ToPath Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.BatchCreateRumMetricDefinitions.BatchCreateRumMetricDefinitions
-- | Removes one or more tags from the specified resource.
module Amazonka.Rum.UntagResource
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | The ARN of the CloudWatch RUM resource that you're removing tags from.
[$sel:resourceArn:UntagResource'] :: UntagResource -> Text
-- | The list of tag keys to remove from the resource.
[$sel:tagKeys:UntagResource'] :: UntagResource -> [Text]
-- | Create a value of UntagResource with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:resourceArn:UntagResource',
-- untagResource_resourceArn - The ARN of the CloudWatch RUM
-- resource that you're removing tags from.
--
-- $sel:tagKeys:UntagResource', untagResource_tagKeys - The
-- list of tag keys to remove from the resource.
newUntagResource :: Text -> UntagResource
-- | The ARN of the CloudWatch RUM resource that you're removing tags from.
untagResource_resourceArn :: Lens' UntagResource Text
-- | The list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:UntagResourceResponse'] :: UntagResourceResponse -> Int
-- | Create a value of UntagResourceResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
instance GHC.Generics.Generic Amazonka.Rum.UntagResource.UntagResource
instance GHC.Show.Show Amazonka.Rum.UntagResource.UntagResource
instance GHC.Read.Read Amazonka.Rum.UntagResource.UntagResource
instance GHC.Classes.Eq Amazonka.Rum.UntagResource.UntagResource
instance GHC.Generics.Generic Amazonka.Rum.UntagResource.UntagResourceResponse
instance GHC.Show.Show Amazonka.Rum.UntagResource.UntagResourceResponse
instance GHC.Read.Read Amazonka.Rum.UntagResource.UntagResourceResponse
instance GHC.Classes.Eq Amazonka.Rum.UntagResource.UntagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.Rum.UntagResource.UntagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.Rum.UntagResource.UntagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.UntagResource.UntagResource
instance Amazonka.Data.Path.ToPath Amazonka.Rum.UntagResource.UntagResource
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.UntagResource.UntagResource
-- | Updates the configuration of an existing app monitor. When you use
-- this operation, only the parts of the app monitor configuration that
-- you specify in this operation are changed. For any parameters that you
-- omit, the existing values are kept.
--
-- You can't use this operation to change the tags of an existing app
-- monitor. To change the tags of an existing app monitor, use
-- TagResource.
--
-- To create a new app monitor, use CreateAppMonitor.
--
-- After you update an app monitor, sign in to the CloudWatch RUM console
-- to get the updated JavaScript code snippet to add to your web
-- application. For more information, see How do I find a code snippet
-- that I've already generated?
module Amazonka.Rum.UpdateAppMonitor
-- | See: newUpdateAppMonitor smart constructor.
data UpdateAppMonitor
UpdateAppMonitor' :: Maybe AppMonitorConfiguration -> Maybe CustomEvents -> Maybe Bool -> Maybe Text -> Text -> UpdateAppMonitor
-- | 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.
[$sel:appMonitorConfiguration:UpdateAppMonitor'] :: UpdateAppMonitor -> Maybe AppMonitorConfiguration
-- | 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.
[$sel:customEvents:UpdateAppMonitor'] :: UpdateAppMonitor -> Maybe CustomEvents
-- | 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.
[$sel:cwLogEnabled:UpdateAppMonitor'] :: UpdateAppMonitor -> Maybe Bool
-- | The top-level internet domain name for which your application has
-- administrative authority.
[$sel:domain:UpdateAppMonitor'] :: UpdateAppMonitor -> Maybe Text
-- | The name of the app monitor to update.
[$sel:name:UpdateAppMonitor'] :: UpdateAppMonitor -> Text
-- | Create a value of UpdateAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- UpdateAppMonitor,
-- updateAppMonitor_appMonitorConfiguration - A structure that
-- contains much of the configuration data for the app monitor. If you
-- are using Amazon Cognito for authorization, you must include this
-- structure in your request, and it must include the ID of the Amazon
-- Cognito identity pool to use for authorization. If you don't include
-- AppMonitorConfiguration, you must set up your own
-- authorization method. For more information, see Authorize your
-- application to send data to Amazon Web Services.
--
-- UpdateAppMonitor, updateAppMonitor_customEvents -
-- Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
--
-- For more information about custom events, see Send custom
-- events.
--
-- UpdateAppMonitor, updateAppMonitor_cwLogEnabled - Data
-- collected by RUM is kept by RUM for 30 days and then deleted. This
-- parameter specifies whether RUM sends a copy of this telemetry data to
-- Amazon CloudWatch Logs in your account. This enables you to keep the
-- telemetry data for more than 30 days, but it does incur Amazon
-- CloudWatch Logs charges.
--
-- UpdateAppMonitor, updateAppMonitor_domain - The
-- top-level internet domain name for which your application has
-- administrative authority.
--
-- UpdateAppMonitor, updateAppMonitor_name - The name of
-- the app monitor to update.
newUpdateAppMonitor :: Text -> UpdateAppMonitor
-- | 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_appMonitorConfiguration :: Lens' UpdateAppMonitor (Maybe AppMonitorConfiguration)
-- | 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_customEvents :: Lens' UpdateAppMonitor (Maybe CustomEvents)
-- | 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_cwLogEnabled :: Lens' UpdateAppMonitor (Maybe Bool)
-- | The top-level internet domain name for which your application has
-- administrative authority.
updateAppMonitor_domain :: Lens' UpdateAppMonitor (Maybe Text)
-- | The name of the app monitor to update.
updateAppMonitor_name :: Lens' UpdateAppMonitor Text
-- | See: newUpdateAppMonitorResponse smart constructor.
data UpdateAppMonitorResponse
UpdateAppMonitorResponse' :: Int -> UpdateAppMonitorResponse
-- | The response's http status code.
[$sel:httpStatus:UpdateAppMonitorResponse'] :: UpdateAppMonitorResponse -> Int
-- | Create a value of UpdateAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UpdateAppMonitorResponse',
-- updateAppMonitorResponse_httpStatus - The response's http
-- status code.
newUpdateAppMonitorResponse :: Int -> UpdateAppMonitorResponse
-- | The response's http status code.
updateAppMonitorResponse_httpStatus :: Lens' UpdateAppMonitorResponse Int
instance GHC.Generics.Generic Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance GHC.Show.Show Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance GHC.Read.Read Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance GHC.Classes.Eq Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance GHC.Generics.Generic Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitorResponse
instance GHC.Show.Show Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitorResponse
instance GHC.Read.Read Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitorResponse
instance GHC.Classes.Eq Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitorResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitorResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Control.DeepSeq.NFData Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Amazonka.Data.Path.ToPath Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.UpdateAppMonitor.UpdateAppMonitor
-- | Modifies one existing metric definition for CloudWatch RUM extended
-- metrics. For more information about extended metrics, see
-- BatchCreateRumMetricsDefinitions.
module Amazonka.Rum.UpdateRumMetricDefinition
-- | See: newUpdateRumMetricDefinition smart constructor.
data UpdateRumMetricDefinition
UpdateRumMetricDefinition' :: Maybe Text -> Text -> MetricDestination -> MetricDefinitionRequest -> Text -> UpdateRumMetricDefinition
-- | This parameter is required if Destination is
-- Evidently. If Destination is CloudWatch, do
-- not use this parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
[$sel:destinationArn:UpdateRumMetricDefinition'] :: UpdateRumMetricDefinition -> Maybe Text
-- | The name of the CloudWatch RUM app monitor that sends these metrics.
[$sel:appMonitorName:UpdateRumMetricDefinition'] :: UpdateRumMetricDefinition -> Text
-- | 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.
[$sel:destination:UpdateRumMetricDefinition'] :: UpdateRumMetricDefinition -> MetricDestination
-- | A structure that contains the new definition that you want to use for
-- this metric.
[$sel:metricDefinition:UpdateRumMetricDefinition'] :: UpdateRumMetricDefinition -> MetricDefinitionRequest
-- | The ID of the metric definition to update.
[$sel:metricDefinitionId:UpdateRumMetricDefinition'] :: UpdateRumMetricDefinition -> Text
-- | Create a value of UpdateRumMetricDefinition with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
--
-- $sel:appMonitorName:UpdateRumMetricDefinition',
-- updateRumMetricDefinition_appMonitorName - The name of the
-- CloudWatch RUM app monitor that sends these metrics.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_destination - The destination to send
-- the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that will
-- receive the metrics and an IAM role that has permission to write to
-- the experiment.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_metricDefinition - A structure that
-- contains the new definition that you want to use for this metric.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_metricDefinitionId - The ID of the
-- metric definition to update.
newUpdateRumMetricDefinition :: Text -> MetricDestination -> MetricDefinitionRequest -> Text -> UpdateRumMetricDefinition
-- | 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_destinationArn :: Lens' UpdateRumMetricDefinition (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that sends these metrics.
updateRumMetricDefinition_appMonitorName :: Lens' UpdateRumMetricDefinition Text
-- | 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_destination :: Lens' UpdateRumMetricDefinition MetricDestination
-- | A structure that contains the new definition that you want to use for
-- this metric.
updateRumMetricDefinition_metricDefinition :: Lens' UpdateRumMetricDefinition MetricDefinitionRequest
-- | The ID of the metric definition to update.
updateRumMetricDefinition_metricDefinitionId :: Lens' UpdateRumMetricDefinition Text
-- | See: newUpdateRumMetricDefinitionResponse smart
-- constructor.
data UpdateRumMetricDefinitionResponse
UpdateRumMetricDefinitionResponse' :: Int -> UpdateRumMetricDefinitionResponse
-- | The response's http status code.
[$sel:httpStatus:UpdateRumMetricDefinitionResponse'] :: UpdateRumMetricDefinitionResponse -> Int
-- | Create a value of UpdateRumMetricDefinitionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UpdateRumMetricDefinitionResponse',
-- updateRumMetricDefinitionResponse_httpStatus - The response's
-- http status code.
newUpdateRumMetricDefinitionResponse :: Int -> UpdateRumMetricDefinitionResponse
-- | The response's http status code.
updateRumMetricDefinitionResponse_httpStatus :: Lens' UpdateRumMetricDefinitionResponse Int
instance GHC.Generics.Generic Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance GHC.Show.Show Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance GHC.Read.Read Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance GHC.Classes.Eq Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance GHC.Generics.Generic Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinitionResponse
instance GHC.Show.Show Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinitionResponse
instance GHC.Read.Read Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinitionResponse
instance GHC.Classes.Eq Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinitionResponse
instance Amazonka.Types.AWSRequest Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Control.DeepSeq.NFData Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinitionResponse
instance Data.Hashable.Class.Hashable Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Control.DeepSeq.NFData Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Amazonka.Data.Headers.ToHeaders Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Amazonka.Data.Path.ToPath Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
instance Amazonka.Data.Query.ToQuery Amazonka.Rum.UpdateRumMetricDefinition.UpdateRumMetricDefinition
module Amazonka.Rum.Lens
-- | 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_destinationArn :: Lens' BatchCreateRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is to send the
-- metrics.
batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text
-- | 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_destination :: Lens' BatchCreateRumMetricDefinitions MetricDestination
-- | An array of structures which define the metrics that you want to send.
batchCreateRumMetricDefinitions_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest]
-- | An array of structures that define the extended metrics.
batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition])
-- | The response's http status code.
batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int
-- | An array of error objects, if the operation caused any errors.
batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError]
-- | 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_destinationArn :: Lens' BatchDeleteRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is sending these
-- metrics.
batchDeleteRumMetricDefinitions_appMonitorName :: Lens' BatchDeleteRumMetricDefinitions Text
-- | 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_destination :: Lens' BatchDeleteRumMetricDefinitions MetricDestination
-- | An array of structures which define the metrics that you want to stop
-- sending.
batchDeleteRumMetricDefinitions_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitions [Text]
-- | The IDs of the metric definitions that were deleted.
batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitionsResponse (Maybe [Text])
-- | The response's http status code.
batchDeleteRumMetricDefinitionsResponse_httpStatus :: Lens' BatchDeleteRumMetricDefinitionsResponse Int
-- | An array of error objects, if the operation caused any errors.
batchDeleteRumMetricDefinitionsResponse_errors :: Lens' BatchDeleteRumMetricDefinitionsResponse [BatchDeleteRumMetricDefinitionsError]
-- | 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_destinationArn :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
-- | 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_maxResults :: Lens' BatchGetRumMetricDefinitions (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
batchGetRumMetricDefinitions_nextToken :: Lens' BatchGetRumMetricDefinitions (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that is sending the
-- metrics.
batchGetRumMetricDefinitions_appMonitorName :: Lens' BatchGetRumMetricDefinitions Text
-- | The type of destination that you want to view metrics for. Valid
-- values are CloudWatch and Evidently.
batchGetRumMetricDefinitions_destination :: Lens' BatchGetRumMetricDefinitions MetricDestination
-- | An array of structures that display information about the metrics that
-- are sent by the specified app monitor to the specified destination.
batchGetRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe [MetricDefinition])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
batchGetRumMetricDefinitionsResponse_nextToken :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe Text)
-- | The response's http status code.
batchGetRumMetricDefinitionsResponse_httpStatus :: Lens' BatchGetRumMetricDefinitionsResponse Int
-- | 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_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration)
-- | 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_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents)
-- | 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_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool)
-- | 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_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text))
-- | The top-level internet domain name for which your application has
-- administrative authority.
createAppMonitor_domain :: Lens' CreateAppMonitor Text
-- | A name for the app monitor.
createAppMonitor_name :: Lens' CreateAppMonitor Text
-- | The unique ID of the new app monitor.
createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text)
-- | The response's http status code.
createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int
-- | The name of the app monitor to delete.
deleteAppMonitor_name :: Lens' DeleteAppMonitor Text
-- | The response's http status code.
deleteAppMonitorResponse_httpStatus :: Lens' DeleteAppMonitorResponse Int
-- | 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_destinationArn :: Lens' DeleteRumMetricsDestination (Maybe Text)
-- | The name of the app monitor that is sending metrics to the destination
-- that you want to delete.
deleteRumMetricsDestination_appMonitorName :: Lens' DeleteRumMetricsDestination Text
-- | The type of destination to delete. Valid values are
-- CloudWatch and Evidently.
deleteRumMetricsDestination_destination :: Lens' DeleteRumMetricsDestination MetricDestination
-- | The response's http status code.
deleteRumMetricsDestinationResponse_httpStatus :: Lens' DeleteRumMetricsDestinationResponse Int
-- | The app monitor to retrieve information for.
getAppMonitor_name :: Lens' GetAppMonitor Text
-- | A structure containing all the configuration information for the app
-- monitor.
getAppMonitorResponse_appMonitor :: Lens' GetAppMonitorResponse (Maybe AppMonitor)
-- | The response's http status code.
getAppMonitorResponse_httpStatus :: Lens' GetAppMonitorResponse Int
-- | 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_filters :: Lens' GetAppMonitorData (Maybe [QueryFilter])
-- | The maximum number of results to return in one operation.
getAppMonitorData_maxResults :: Lens' GetAppMonitorData (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
getAppMonitorData_nextToken :: Lens' GetAppMonitorData (Maybe Text)
-- | The name of the app monitor that collected the data that you want to
-- retrieve.
getAppMonitorData_name :: Lens' GetAppMonitorData Text
-- | A structure that defines the time range that you want to retrieve
-- results from.
getAppMonitorData_timeRange :: Lens' GetAppMonitorData TimeRange
-- | The events that RUM collected that match your request.
getAppMonitorDataResponse_events :: Lens' GetAppMonitorDataResponse (Maybe [Text])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
getAppMonitorDataResponse_nextToken :: Lens' GetAppMonitorDataResponse (Maybe Text)
-- | The response's http status code.
getAppMonitorDataResponse_httpStatus :: Lens' GetAppMonitorDataResponse Int
-- | The maximum number of results to return in one operation. The default
-- is 50. The maximum that you can specify is 100.
listAppMonitors_maxResults :: Lens' ListAppMonitors (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
listAppMonitors_nextToken :: Lens' ListAppMonitors (Maybe Text)
-- | An array of structures that contain information about the returned app
-- monitors.
listAppMonitorsResponse_appMonitorSummaries :: Lens' ListAppMonitorsResponse (Maybe [AppMonitorSummary])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
listAppMonitorsResponse_nextToken :: Lens' ListAppMonitorsResponse (Maybe Text)
-- | The response's http status code.
listAppMonitorsResponse_httpStatus :: Lens' ListAppMonitorsResponse Int
-- | 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_maxResults :: Lens' ListRumMetricsDestinations (Maybe Natural)
-- | Use the token returned by the previous operation to request the next
-- page of results.
listRumMetricsDestinations_nextToken :: Lens' ListRumMetricsDestinations (Maybe Text)
-- | The name of the app monitor associated with the destinations that you
-- want to retrieve.
listRumMetricsDestinations_appMonitorName :: Lens' ListRumMetricsDestinations Text
-- | The list of CloudWatch RUM extended metrics destinations associated
-- with the app monitor that you specified.
listRumMetricsDestinationsResponse_destinations :: Lens' ListRumMetricsDestinationsResponse (Maybe [MetricDestinationSummary])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
listRumMetricsDestinationsResponse_nextToken :: Lens' ListRumMetricsDestinationsResponse (Maybe Text)
-- | The response's http status code.
listRumMetricsDestinationsResponse_httpStatus :: Lens' ListRumMetricsDestinationsResponse Int
-- | The ARN of the resource that you want to see the tags of.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
-- | The ARN of the resource that you are viewing.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse Text
-- | The list of tag keys and values associated with the resource you
-- specified.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (HashMap Text Text)
-- | A structure that contains information about the app monitor that
-- collected this telemetry information.
putRumEvents_appMonitorDetails :: Lens' PutRumEvents AppMonitorDetails
-- | A unique identifier for this batch of RUM event data.
putRumEvents_batchId :: Lens' PutRumEvents Text
-- | The ID of the app monitor that is sending this data.
putRumEvents_id :: Lens' PutRumEvents Text
-- | An array of structures that contain the telemetry event data.
putRumEvents_rumEvents :: Lens' PutRumEvents [RumEvent]
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
putRumEvents_userDetails :: Lens' PutRumEvents UserDetails
-- | The response's http status code.
putRumEventsResponse_httpStatus :: Lens' PutRumEventsResponse Int
-- | Use this parameter only if Destination is Evidently.
-- This parameter specifies the ARN of the Evidently experiment that will
-- receive the extended metrics.
putRumMetricsDestination_destinationArn :: Lens' PutRumMetricsDestination (Maybe Text)
-- | 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_iamRoleArn :: Lens' PutRumMetricsDestination (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that will send the metrics.
putRumMetricsDestination_appMonitorName :: Lens' PutRumMetricsDestination Text
-- | 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.
putRumMetricsDestination_destination :: Lens' PutRumMetricsDestination MetricDestination
-- | The response's http status code.
putRumMetricsDestinationResponse_httpStatus :: Lens' PutRumMetricsDestinationResponse Int
-- | The ARN of the CloudWatch RUM resource that you're adding tags to.
tagResource_resourceArn :: Lens' TagResource Text
-- | The list of key-value pairs to associate with the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text)
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
-- | The ARN of the CloudWatch RUM resource that you're removing tags from.
untagResource_resourceArn :: Lens' UntagResource Text
-- | The list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
-- | 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_appMonitorConfiguration :: Lens' UpdateAppMonitor (Maybe AppMonitorConfiguration)
-- | 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_customEvents :: Lens' UpdateAppMonitor (Maybe CustomEvents)
-- | 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_cwLogEnabled :: Lens' UpdateAppMonitor (Maybe Bool)
-- | The top-level internet domain name for which your application has
-- administrative authority.
updateAppMonitor_domain :: Lens' UpdateAppMonitor (Maybe Text)
-- | The name of the app monitor to update.
updateAppMonitor_name :: Lens' UpdateAppMonitor Text
-- | The response's http status code.
updateAppMonitorResponse_httpStatus :: Lens' UpdateAppMonitorResponse Int
-- | 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_destinationArn :: Lens' UpdateRumMetricDefinition (Maybe Text)
-- | The name of the CloudWatch RUM app monitor that sends these metrics.
updateRumMetricDefinition_appMonitorName :: Lens' UpdateRumMetricDefinition Text
-- | 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_destination :: Lens' UpdateRumMetricDefinition MetricDestination
-- | A structure that contains the new definition that you want to use for
-- this metric.
updateRumMetricDefinition_metricDefinition :: Lens' UpdateRumMetricDefinition MetricDefinitionRequest
-- | The ID of the metric definition to update.
updateRumMetricDefinition_metricDefinitionId :: Lens' UpdateRumMetricDefinition Text
-- | The response's http status code.
updateRumMetricDefinitionResponse_httpStatus :: Lens' UpdateRumMetricDefinitionResponse Int
-- | A structure that contains much of the configuration data for the app
-- monitor.
appMonitor_appMonitorConfiguration :: Lens' AppMonitor (Maybe AppMonitorConfiguration)
-- | The date and time that this app monitor was created.
appMonitor_created :: Lens' AppMonitor (Maybe Text)
-- | 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_customEvents :: Lens' AppMonitor (Maybe CustomEvents)
-- | A structure that contains information about whether this app monitor
-- stores a copy of the telemetry data that RUM collects using CloudWatch
-- Logs.
appMonitor_dataStorage :: Lens' AppMonitor (Maybe DataStorage)
-- | The top-level internet domain name for which your application has
-- administrative authority.
appMonitor_domain :: Lens' AppMonitor (Maybe Text)
-- | The unique ID of this app monitor.
appMonitor_id :: Lens' AppMonitor (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitor_lastModified :: Lens' AppMonitor (Maybe Text)
-- | The name of the app monitor.
appMonitor_name :: Lens' AppMonitor (Maybe Text)
-- | The current state of the app monitor.
appMonitor_state :: Lens' AppMonitor (Maybe StateEnum)
-- | The list of tag keys and values associated with this app monitor.
appMonitor_tags :: Lens' AppMonitor (Maybe (HashMap Text Text))
-- | 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_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool)
-- | 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_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | A list of pages in your application that are to be displayed with a
-- "favorite" icon in the CloudWatch RUM console.
appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text)
-- | The ID of the Amazon Cognito identity pool that is used to authorize
-- the sending of data to RUM.
appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text)
-- | 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_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
-- | 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_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double)
-- | 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.
--
appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry])
-- | The unique ID of the app monitor.
appMonitorDetails_id :: Lens' AppMonitorDetails (Maybe Text)
-- | The name of the app monitor.
appMonitorDetails_name :: Lens' AppMonitorDetails (Maybe Text)
-- | The version of the app monitor.
appMonitorDetails_version :: Lens' AppMonitorDetails (Maybe Text)
-- | The date and time that the app monitor was created.
appMonitorSummary_created :: Lens' AppMonitorSummary (Maybe Text)
-- | The unique ID of this app monitor.
appMonitorSummary_id :: Lens' AppMonitorSummary (Maybe Text)
-- | The date and time of the most recent changes to this app monitor's
-- configuration.
appMonitorSummary_lastModified :: Lens' AppMonitorSummary (Maybe Text)
-- | The name of this app monitor.
appMonitorSummary_name :: Lens' AppMonitorSummary (Maybe Text)
-- | The current state of this app monitor.
appMonitorSummary_state :: Lens' AppMonitorSummary (Maybe StateEnum)
-- | The error code.
batchCreateRumMetricDefinitionsError_errorCode :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchCreateRumMetricDefinitionsError_errorMessage :: Lens' BatchCreateRumMetricDefinitionsError Text
-- | The metric definition that caused this error.
batchCreateRumMetricDefinitionsError_metricDefinition :: Lens' BatchCreateRumMetricDefinitionsError MetricDefinitionRequest
-- | The error code.
batchDeleteRumMetricDefinitionsError_errorCode :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The error message for this metric definition.
batchDeleteRumMetricDefinitionsError_errorMessage :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | The ID of the metric definition that caused this error.
batchDeleteRumMetricDefinitionsError_metricDefinitionId :: Lens' BatchDeleteRumMetricDefinitionsError Text
-- | 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)
-- | Indicated whether the app monitor stores copies of the data that RUM
-- collects in CloudWatch Logs.
cwLog_cwLogEnabled :: Lens' CwLog (Maybe Bool)
-- | The name of the log group where the copies are stored.
cwLog_cwLogGroup :: Lens' CwLog (Maybe Text)
-- | 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)
-- | 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_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinition (Maybe Text)
-- | 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_unitLabel :: Lens' MetricDefinition (Maybe Text)
-- | The field within the event object that the metric value is sourced
-- from.
metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text)
-- | The ID of this metric definition.
metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text
-- | The name of the metric that is defined in this structure.
metricDefinition_name :: Lens' MetricDefinition Text
-- | 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_dimensionKeys :: Lens' MetricDefinitionRequest (Maybe (HashMap Text Text))
-- | 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_eventPattern :: Lens' MetricDefinitionRequest (Maybe Text)
-- | The CloudWatch metric unit to use for this metric. If you omit this
-- field, the metric is recorded with no unit.
metricDefinitionRequest_unitLabel :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_valueKey :: Lens' MetricDefinitionRequest (Maybe Text)
-- | 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_name :: Lens' MetricDefinitionRequest Text
-- | Specifies whether the destination is CloudWatch or
-- Evidently.
metricDestinationSummary_destination :: Lens' MetricDestinationSummary (Maybe MetricDestination)
-- | If the destination is Evidently, this specifies the ARN of
-- the Evidently experiment that receives the metrics.
metricDestinationSummary_destinationArn :: Lens' MetricDestinationSummary (Maybe Text)
-- | 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_iamRoleArn :: Lens' MetricDestinationSummary (Maybe Text)
-- | 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_name :: Lens' QueryFilter (Maybe Text)
-- | The values of the Name that are to be be included in the
-- returned results.
queryFilter_values :: Lens' QueryFilter (Maybe [Text])
-- | 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_metadata :: Lens' RumEvent (Maybe Text)
-- | A string containing details about the event.
rumEvent_details :: Lens' RumEvent Text
-- | A unique ID for this event.
rumEvent_id :: Lens' RumEvent Text
-- | The exact time that this event occurred.
rumEvent_timestamp :: Lens' RumEvent UTCTime
-- | The JSON schema that denotes the type of event this is, such as a page
-- load or a new session.
rumEvent_type :: Lens' RumEvent Text
-- | 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_before :: Lens' TimeRange (Maybe Integer)
-- | The beginning of the time range to retrieve performance events from.
timeRange_after :: Lens' TimeRange Integer
-- | The session ID that the performance events are from.
userDetails_sessionId :: Lens' UserDetails (Maybe Text)
-- | 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_userId :: Lens' UserDetails (Maybe Text)
module Amazonka.Rum.Waiters
-- | Derived from API version 2018-05-10 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- With Amazon CloudWatch RUM, you can perform real-user monitoring to
-- collect client-side data about your web application performance from
-- actual user sessions in real time. The data collected includes page
-- load times, client-side errors, and user behavior. When you view this
-- data, you can see it all aggregated together and also see breakdowns
-- by the browsers and devices that your customers use.
--
-- You can use the collected data to quickly identify and debug
-- client-side performance issues. CloudWatch RUM helps you visualize
-- anomalies in your application performance and find relevant debugging
-- data such as error messages, stack traces, and user sessions. You can
-- also use RUM to understand the range of end-user impact including the
-- number of users, geolocations, and browsers used.
module Amazonka.Rum
-- | API version 2018-05-10 of the Amazon CloudWatch RUM SDK
-- configuration.
defaultService :: Service
-- | You don't have sufficient permissions to perform this action.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | This operation attempted to create a resource that already exists.
_ConflictException :: AsError a => Fold a ServiceError
-- | Internal service exception.
_InternalServerException :: AsError a => Fold a ServiceError
-- | Resource not found.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | This request exceeds a service quota.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | The request was throttled because of quota limits.
_ThrottlingException :: AsError a => Fold a ServiceError
-- | One of the arguments for the request is not valid.
_ValidationException :: AsError a => Fold a ServiceError
-- | See: newBatchCreateRumMetricDefinitions smart
-- constructor.
data BatchCreateRumMetricDefinitions
BatchCreateRumMetricDefinitions' :: Maybe Text -> Text -> MetricDestination -> [MetricDefinitionRequest] -> BatchCreateRumMetricDefinitions
-- | Create a value of BatchCreateRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_destinationArn - This parameter
-- is required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
--
-- $sel:appMonitorName:BatchCreateRumMetricDefinitions',
-- batchCreateRumMetricDefinitions_appMonitorName - The name of
-- the CloudWatch RUM app monitor that is to send the metrics.
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_destination - The destination
-- to send the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that will
-- receive the metrics and an IAM role that has permission to write to
-- the experiment.
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitions_metricDefinitions - An array of
-- structures which define the metrics that you want to send.
newBatchCreateRumMetricDefinitions :: Text -> MetricDestination -> BatchCreateRumMetricDefinitions
-- | See: newBatchCreateRumMetricDefinitionsResponse smart
-- constructor.
data BatchCreateRumMetricDefinitionsResponse
BatchCreateRumMetricDefinitionsResponse' :: Maybe [MetricDefinition] -> Int -> [BatchCreateRumMetricDefinitionsError] -> BatchCreateRumMetricDefinitionsResponse
-- | Create a value of BatchCreateRumMetricDefinitionsResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchCreateRumMetricDefinitions,
-- batchCreateRumMetricDefinitionsResponse_metricDefinitions - An
-- array of structures that define the extended metrics.
--
-- $sel:httpStatus:BatchCreateRumMetricDefinitionsResponse',
-- batchCreateRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
--
-- $sel:errors:BatchCreateRumMetricDefinitionsResponse',
-- batchCreateRumMetricDefinitionsResponse_errors - An array of
-- error objects, if the operation caused any errors.
newBatchCreateRumMetricDefinitionsResponse :: Int -> BatchCreateRumMetricDefinitionsResponse
-- | See: newBatchDeleteRumMetricDefinitions smart
-- constructor.
data BatchDeleteRumMetricDefinitions
BatchDeleteRumMetricDefinitions' :: Maybe Text -> Text -> MetricDestination -> [Text] -> BatchDeleteRumMetricDefinitions
-- | Create a value of BatchDeleteRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_destinationArn - This parameter
-- is required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that was
-- receiving the metrics that are being deleted.
--
-- $sel:appMonitorName:BatchDeleteRumMetricDefinitions',
-- batchDeleteRumMetricDefinitions_appMonitorName - The name of
-- the CloudWatch RUM app monitor that is sending these metrics.
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_destination - Defines the
-- destination where you want to stop sending the specified metrics.
-- Valid values are CloudWatch and Evidently. If you
-- specify Evidently, you must also specify the ARN of the
-- CloudWatchEvidently experiment that is to be the destination and an
-- IAM role that has permission to write to the experiment.
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitions_metricDefinitionIds - An array
-- of structures which define the metrics that you want to stop sending.
newBatchDeleteRumMetricDefinitions :: Text -> MetricDestination -> BatchDeleteRumMetricDefinitions
-- | See: newBatchDeleteRumMetricDefinitionsResponse smart
-- constructor.
data BatchDeleteRumMetricDefinitionsResponse
BatchDeleteRumMetricDefinitionsResponse' :: Maybe [Text] -> Int -> [BatchDeleteRumMetricDefinitionsError] -> BatchDeleteRumMetricDefinitionsResponse
-- | Create a value of BatchDeleteRumMetricDefinitionsResponse with
-- all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchDeleteRumMetricDefinitions,
-- batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds -
-- The IDs of the metric definitions that were deleted.
--
-- $sel:httpStatus:BatchDeleteRumMetricDefinitionsResponse',
-- batchDeleteRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
--
-- $sel:errors:BatchDeleteRumMetricDefinitionsResponse',
-- batchDeleteRumMetricDefinitionsResponse_errors - An array of
-- error objects, if the operation caused any errors.
newBatchDeleteRumMetricDefinitionsResponse :: Int -> BatchDeleteRumMetricDefinitionsResponse
-- | See: newBatchGetRumMetricDefinitions smart constructor.
data BatchGetRumMetricDefinitions
BatchGetRumMetricDefinitions' :: Maybe Text -> Maybe Natural -> Maybe Text -> Text -> MetricDestination -> BatchGetRumMetricDefinitions
-- | Create a value of BatchGetRumMetricDefinitions with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that
-- corresponds to the destination.
--
-- $sel:maxResults:BatchGetRumMetricDefinitions',
-- batchGetRumMetricDefinitions_maxResults - The maximum number of
-- results to return in one operation. The default is 50. The maximum
-- that you can specify is 100.
--
-- To retrieve the remaining results, make another call with the returned
-- NextToken value.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_nextToken - Use the token returned
-- by the previous operation to request the next page of results.
--
-- $sel:appMonitorName:BatchGetRumMetricDefinitions',
-- batchGetRumMetricDefinitions_appMonitorName - The name of the
-- CloudWatch RUM app monitor that is sending the metrics.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitions_destination - The type of
-- destination that you want to view metrics for. Valid values are
-- CloudWatch and Evidently.
newBatchGetRumMetricDefinitions :: Text -> MetricDestination -> BatchGetRumMetricDefinitions
-- | See: newBatchGetRumMetricDefinitionsResponse smart
-- constructor.
data BatchGetRumMetricDefinitionsResponse
BatchGetRumMetricDefinitionsResponse' :: Maybe [MetricDefinition] -> Maybe Text -> Int -> BatchGetRumMetricDefinitionsResponse
-- | Create a value of BatchGetRumMetricDefinitionsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:metricDefinitions:BatchGetRumMetricDefinitionsResponse',
-- batchGetRumMetricDefinitionsResponse_metricDefinitions - An
-- array of structures that display information about the metrics that
-- are sent by the specified app monitor to the specified destination.
--
-- BatchGetRumMetricDefinitions,
-- batchGetRumMetricDefinitionsResponse_nextToken - A token that
-- you can use in a subsequent operation to retrieve the next set of
-- results.
--
-- $sel:httpStatus:BatchGetRumMetricDefinitionsResponse',
-- batchGetRumMetricDefinitionsResponse_httpStatus - The
-- response's http status code.
newBatchGetRumMetricDefinitionsResponse :: Int -> BatchGetRumMetricDefinitionsResponse
-- | See: newCreateAppMonitor smart constructor.
data CreateAppMonitor
CreateAppMonitor' :: Maybe AppMonitorConfiguration -> Maybe CustomEvents -> Maybe Bool -> Maybe (HashMap Text Text) -> Text -> Text -> CreateAppMonitor
-- | Create a value of CreateAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateAppMonitor,
-- createAppMonitor_appMonitorConfiguration - A structure that
-- contains much of the configuration data for the app monitor. If you
-- are using Amazon Cognito for authorization, you must include this
-- structure in your request, and it must include the ID of the Amazon
-- Cognito identity pool to use for authorization. If you don't include
-- AppMonitorConfiguration, you must set up your own
-- authorization method. For more information, see Authorize your
-- application to send data to Amazon Web Services.
--
-- If you omit this argument, the sample rate used for RUM is set to 10%
-- of the user sessions.
--
-- CreateAppMonitor, createAppMonitor_customEvents -
-- Specifies whether this app monitor allows the web client to define and
-- send custom events. If you omit this parameter, custom events are
-- DISABLED.
--
-- For more information about custom events, see Send custom
-- events.
--
-- CreateAppMonitor, createAppMonitor_cwLogEnabled - Data
-- collected by RUM is kept by RUM for 30 days and then deleted. This
-- parameter specifies whether RUM sends a copy of this telemetry data to
-- Amazon CloudWatch Logs in your account. This enables you to keep the
-- telemetry data for more than 30 days, but it does incur Amazon
-- CloudWatch Logs charges.
--
-- If you omit this parameter, the default is false.
--
-- CreateAppMonitor, createAppMonitor_tags - Assigns one or
-- more tags (key-value pairs) to the app monitor.
--
-- Tags can help you organize and categorize your resources. You can also
-- use them to scope user permissions by granting a user permission to
-- access or change only resources with certain tag values.
--
-- Tags don't have any semantic meaning to Amazon Web Services and are
-- interpreted strictly as strings of characters.
--
-- You can associate as many as 50 tags with an app monitor.
--
-- For more information, see Tagging Amazon Web Services
-- resources.
--
-- CreateAppMonitor, createAppMonitor_domain - The
-- top-level internet domain name for which your application has
-- administrative authority.
--
-- CreateAppMonitor, createAppMonitor_name - A name for the
-- app monitor.
newCreateAppMonitor :: Text -> Text -> CreateAppMonitor
-- | See: newCreateAppMonitorResponse smart constructor.
data CreateAppMonitorResponse
CreateAppMonitorResponse' :: Maybe Text -> Int -> CreateAppMonitorResponse
-- | Create a value of CreateAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- CreateAppMonitorResponse, createAppMonitorResponse_id -
-- The unique ID of the new app monitor.
--
-- $sel:httpStatus:CreateAppMonitorResponse',
-- createAppMonitorResponse_httpStatus - The response's http
-- status code.
newCreateAppMonitorResponse :: Int -> CreateAppMonitorResponse
-- | See: newDeleteAppMonitor smart constructor.
data DeleteAppMonitor
DeleteAppMonitor' :: Text -> DeleteAppMonitor
-- | Create a value of DeleteAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteAppMonitor, deleteAppMonitor_name - The name of
-- the app monitor to delete.
newDeleteAppMonitor :: Text -> DeleteAppMonitor
-- | See: newDeleteAppMonitorResponse smart constructor.
data DeleteAppMonitorResponse
DeleteAppMonitorResponse' :: Int -> DeleteAppMonitorResponse
-- | Create a value of DeleteAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteAppMonitorResponse',
-- deleteAppMonitorResponse_httpStatus - The response's http
-- status code.
newDeleteAppMonitorResponse :: Int -> DeleteAppMonitorResponse
-- | See: newDeleteRumMetricsDestination smart constructor.
data DeleteRumMetricsDestination
DeleteRumMetricsDestination' :: Maybe Text -> Text -> MetricDestination -> DeleteRumMetricsDestination
-- | Create a value of DeleteRumMetricsDestination with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- DeleteRumMetricsDestination,
-- deleteRumMetricsDestination_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter. This parameter specifies the ARN of the Evidently
-- experiment that corresponds to the destination to delete.
--
-- $sel:appMonitorName:DeleteRumMetricsDestination',
-- deleteRumMetricsDestination_appMonitorName - The name of the
-- app monitor that is sending metrics to the destination that you want
-- to delete.
--
-- DeleteRumMetricsDestination,
-- deleteRumMetricsDestination_destination - The type of
-- destination to delete. Valid values are CloudWatch and
-- Evidently.
newDeleteRumMetricsDestination :: Text -> MetricDestination -> DeleteRumMetricsDestination
-- | See: newDeleteRumMetricsDestinationResponse smart
-- constructor.
data DeleteRumMetricsDestinationResponse
DeleteRumMetricsDestinationResponse' :: Int -> DeleteRumMetricsDestinationResponse
-- | Create a value of DeleteRumMetricsDestinationResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:DeleteRumMetricsDestinationResponse',
-- deleteRumMetricsDestinationResponse_httpStatus - The response's
-- http status code.
newDeleteRumMetricsDestinationResponse :: Int -> DeleteRumMetricsDestinationResponse
-- | See: newGetAppMonitor smart constructor.
data GetAppMonitor
GetAppMonitor' :: Text -> GetAppMonitor
-- | Create a value of GetAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- GetAppMonitor, getAppMonitor_name - The app monitor to
-- retrieve information for.
newGetAppMonitor :: Text -> GetAppMonitor
-- | See: newGetAppMonitorResponse smart constructor.
data GetAppMonitorResponse
GetAppMonitorResponse' :: Maybe AppMonitor -> Int -> GetAppMonitorResponse
-- | Create a value of GetAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitor:GetAppMonitorResponse',
-- getAppMonitorResponse_appMonitor - A structure containing all
-- the configuration information for the app monitor.
--
-- $sel:httpStatus:GetAppMonitorResponse',
-- getAppMonitorResponse_httpStatus - The response's http status
-- code.
newGetAppMonitorResponse :: Int -> GetAppMonitorResponse
-- | See: newGetAppMonitorData smart constructor.
data GetAppMonitorData
GetAppMonitorData' :: Maybe [QueryFilter] -> Maybe Natural -> Maybe Text -> Text -> TimeRange -> GetAppMonitorData
-- | Create a value of GetAppMonitorData with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:filters:GetAppMonitorData',
-- getAppMonitorData_filters - An array of structures that you can
-- use to filter the results to those that match one or more sets of
-- key-value pairs that you specify.
--
-- $sel:maxResults:GetAppMonitorData',
-- getAppMonitorData_maxResults - The maximum number of results to
-- return in one operation.
--
-- GetAppMonitorData, getAppMonitorData_nextToken - Use the
-- token returned by the previous operation to request the next page of
-- results.
--
-- GetAppMonitorData, getAppMonitorData_name - The name of
-- the app monitor that collected the data that you want to retrieve.
--
-- $sel:timeRange:GetAppMonitorData',
-- getAppMonitorData_timeRange - A structure that defines the time
-- range that you want to retrieve results from.
newGetAppMonitorData :: Text -> TimeRange -> GetAppMonitorData
-- | See: newGetAppMonitorDataResponse smart constructor.
data GetAppMonitorDataResponse
GetAppMonitorDataResponse' :: Maybe [Text] -> Maybe Text -> Int -> GetAppMonitorDataResponse
-- | Create a value of GetAppMonitorDataResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:events:GetAppMonitorDataResponse',
-- getAppMonitorDataResponse_events - The events that RUM
-- collected that match your request.
--
-- GetAppMonitorData, getAppMonitorDataResponse_nextToken -
-- A token that you can use in a subsequent operation to retrieve the
-- next set of results.
--
-- $sel:httpStatus:GetAppMonitorDataResponse',
-- getAppMonitorDataResponse_httpStatus - The response's http
-- status code.
newGetAppMonitorDataResponse :: Int -> GetAppMonitorDataResponse
-- | See: newListAppMonitors smart constructor.
data ListAppMonitors
ListAppMonitors' :: Maybe Natural -> Maybe Text -> ListAppMonitors
-- | Create a value of ListAppMonitors with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:maxResults:ListAppMonitors',
-- listAppMonitors_maxResults - The maximum number of results to
-- return in one operation. The default is 50. The maximum that you can
-- specify is 100.
--
-- ListAppMonitors, listAppMonitors_nextToken - Use the
-- token returned by the previous operation to request the next page of
-- results.
newListAppMonitors :: ListAppMonitors
-- | See: newListAppMonitorsResponse smart constructor.
data ListAppMonitorsResponse
ListAppMonitorsResponse' :: Maybe [AppMonitorSummary] -> Maybe Text -> Int -> ListAppMonitorsResponse
-- | Create a value of ListAppMonitorsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitorSummaries:ListAppMonitorsResponse',
-- listAppMonitorsResponse_appMonitorSummaries - An array of
-- structures that contain information about the returned app monitors.
--
-- ListAppMonitors, listAppMonitorsResponse_nextToken - A
-- token that you can use in a subsequent operation to retrieve the next
-- set of results.
--
-- $sel:httpStatus:ListAppMonitorsResponse',
-- listAppMonitorsResponse_httpStatus - The response's http status
-- code.
newListAppMonitorsResponse :: Int -> ListAppMonitorsResponse
-- | See: newListRumMetricsDestinations smart constructor.
data ListRumMetricsDestinations
ListRumMetricsDestinations' :: Maybe Natural -> Maybe Text -> Text -> ListRumMetricsDestinations
-- | Create a value of ListRumMetricsDestinations with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:maxResults:ListRumMetricsDestinations',
-- listRumMetricsDestinations_maxResults - The maximum number of
-- results to return in one operation. The default is 50. The maximum
-- that you can specify is 100.
--
-- To retrieve the remaining results, make another call with the returned
-- NextToken value.
--
-- ListRumMetricsDestinations,
-- listRumMetricsDestinations_nextToken - Use the token returned
-- by the previous operation to request the next page of results.
--
-- $sel:appMonitorName:ListRumMetricsDestinations',
-- listRumMetricsDestinations_appMonitorName - The name of the app
-- monitor associated with the destinations that you want to retrieve.
newListRumMetricsDestinations :: Text -> ListRumMetricsDestinations
-- | See: newListRumMetricsDestinationsResponse smart
-- constructor.
data ListRumMetricsDestinationsResponse
ListRumMetricsDestinationsResponse' :: Maybe [MetricDestinationSummary] -> Maybe Text -> Int -> ListRumMetricsDestinationsResponse
-- | Create a value of ListRumMetricsDestinationsResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:destinations:ListRumMetricsDestinationsResponse',
-- listRumMetricsDestinationsResponse_destinations - The list of
-- CloudWatch RUM extended metrics destinations associated with the app
-- monitor that you specified.
--
-- ListRumMetricsDestinations,
-- listRumMetricsDestinationsResponse_nextToken - A token that you
-- can use in a subsequent operation to retrieve the next set of results.
--
-- $sel:httpStatus:ListRumMetricsDestinationsResponse',
-- listRumMetricsDestinationsResponse_httpStatus - The response's
-- http status code.
newListRumMetricsDestinationsResponse :: Int -> ListRumMetricsDestinationsResponse
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | Create a value of ListTagsForResource with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- ListTagsForResource, listTagsForResource_resourceArn -
-- The ARN of the resource that you want to see the tags of.
newListTagsForResource :: Text -> ListTagsForResource
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Int -> Text -> HashMap Text Text -> ListTagsForResourceResponse
-- | Create a value of ListTagsForResourceResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
--
-- ListTagsForResource,
-- listTagsForResourceResponse_resourceArn - The ARN of the
-- resource that you are viewing.
--
-- ListTagsForResourceResponse,
-- listTagsForResourceResponse_tags - The list of tag keys and
-- values associated with the resource you specified.
newListTagsForResourceResponse :: Int -> Text -> ListTagsForResourceResponse
-- | See: newPutRumEvents smart constructor.
data PutRumEvents
PutRumEvents' :: AppMonitorDetails -> Text -> Text -> [RumEvent] -> UserDetails -> PutRumEvents
-- | Create a value of PutRumEvents with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:appMonitorDetails:PutRumEvents',
-- putRumEvents_appMonitorDetails - A structure that contains
-- information about the app monitor that collected this telemetry
-- information.
--
-- $sel:batchId:PutRumEvents', putRumEvents_batchId - A
-- unique identifier for this batch of RUM event data.
--
-- PutRumEvents, putRumEvents_id - The ID of the app
-- monitor that is sending this data.
--
-- $sel:rumEvents:PutRumEvents', putRumEvents_rumEvents -
-- An array of structures that contain the telemetry event data.
--
-- $sel:userDetails:PutRumEvents', putRumEvents_userDetails
-- - A structure that contains information about the user session that
-- this batch of events was collected from.
newPutRumEvents :: AppMonitorDetails -> Text -> Text -> UserDetails -> PutRumEvents
-- | See: newPutRumEventsResponse smart constructor.
data PutRumEventsResponse
PutRumEventsResponse' :: Int -> PutRumEventsResponse
-- | Create a value of PutRumEventsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:PutRumEventsResponse',
-- putRumEventsResponse_httpStatus - The response's http status
-- code.
newPutRumEventsResponse :: Int -> PutRumEventsResponse
-- | See: newPutRumMetricsDestination smart constructor.
data PutRumMetricsDestination
PutRumMetricsDestination' :: Maybe Text -> Maybe Text -> Text -> MetricDestination -> PutRumMetricsDestination
-- | Create a value of PutRumMetricsDestination with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_destinationArn - Use this parameter
-- only if Destination is Evidently. This parameter
-- specifies the ARN of the Evidently experiment that will receive the
-- extended metrics.
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_iamRoleArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of an IAM role that RUM will assume
-- to write to the Evidently experiment that you are sending metrics to.
-- This role must have permission to write to that experiment.
--
-- $sel:appMonitorName:PutRumMetricsDestination',
-- putRumMetricsDestination_appMonitorName - The name of the
-- CloudWatch RUM app monitor that will send the metrics.
--
-- PutRumMetricsDestination,
-- putRumMetricsDestination_destination - Defines the destination
-- to send the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that is to be
-- the destination and an IAM role that has permission to write to the
-- experiment.
newPutRumMetricsDestination :: Text -> MetricDestination -> PutRumMetricsDestination
-- | See: newPutRumMetricsDestinationResponse smart
-- constructor.
data PutRumMetricsDestinationResponse
PutRumMetricsDestinationResponse' :: Int -> PutRumMetricsDestinationResponse
-- | Create a value of PutRumMetricsDestinationResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:PutRumMetricsDestinationResponse',
-- putRumMetricsDestinationResponse_httpStatus - The response's
-- http status code.
newPutRumMetricsDestinationResponse :: Int -> PutRumMetricsDestinationResponse
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> HashMap Text Text -> TagResource
-- | Create a value of TagResource with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:resourceArn:TagResource', tagResource_resourceArn -
-- The ARN of the CloudWatch RUM resource that you're adding tags to.
--
-- TagResource, tagResource_tags - The list of key-value
-- pairs to associate with the resource.
newTagResource :: Text -> TagResource
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | Create a value of TagResourceResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | Create a value of UntagResource with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:resourceArn:UntagResource',
-- untagResource_resourceArn - The ARN of the CloudWatch RUM
-- resource that you're removing tags from.
--
-- $sel:tagKeys:UntagResource', untagResource_tagKeys - The
-- list of tag keys to remove from the resource.
newUntagResource :: Text -> UntagResource
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | Create a value of UntagResourceResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | See: newUpdateAppMonitor smart constructor.
data UpdateAppMonitor
UpdateAppMonitor' :: Maybe AppMonitorConfiguration -> Maybe CustomEvents -> Maybe Bool -> Maybe Text -> Text -> UpdateAppMonitor
-- | Create a value of UpdateAppMonitor with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- UpdateAppMonitor,
-- updateAppMonitor_appMonitorConfiguration - A structure that
-- contains much of the configuration data for the app monitor. If you
-- are using Amazon Cognito for authorization, you must include this
-- structure in your request, and it must include the ID of the Amazon
-- Cognito identity pool to use for authorization. If you don't include
-- AppMonitorConfiguration, you must set up your own
-- authorization method. For more information, see Authorize your
-- application to send data to Amazon Web Services.
--
-- UpdateAppMonitor, updateAppMonitor_customEvents -
-- Specifies whether this app monitor allows the web client to define and
-- send custom events. The default is for custom events to be
-- DISABLED.
--
-- For more information about custom events, see Send custom
-- events.
--
-- UpdateAppMonitor, updateAppMonitor_cwLogEnabled - Data
-- collected by RUM is kept by RUM for 30 days and then deleted. This
-- parameter specifies whether RUM sends a copy of this telemetry data to
-- Amazon CloudWatch Logs in your account. This enables you to keep the
-- telemetry data for more than 30 days, but it does incur Amazon
-- CloudWatch Logs charges.
--
-- UpdateAppMonitor, updateAppMonitor_domain - The
-- top-level internet domain name for which your application has
-- administrative authority.
--
-- UpdateAppMonitor, updateAppMonitor_name - The name of
-- the app monitor to update.
newUpdateAppMonitor :: Text -> UpdateAppMonitor
-- | See: newUpdateAppMonitorResponse smart constructor.
data UpdateAppMonitorResponse
UpdateAppMonitorResponse' :: Int -> UpdateAppMonitorResponse
-- | Create a value of UpdateAppMonitorResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UpdateAppMonitorResponse',
-- updateAppMonitorResponse_httpStatus - The response's http
-- status code.
newUpdateAppMonitorResponse :: Int -> UpdateAppMonitorResponse
-- | See: newUpdateRumMetricDefinition smart constructor.
data UpdateRumMetricDefinition
UpdateRumMetricDefinition' :: Maybe Text -> Text -> MetricDestination -> MetricDefinitionRequest -> Text -> UpdateRumMetricDefinition
-- | Create a value of UpdateRumMetricDefinition with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_destinationArn - This parameter is
-- required if Destination is Evidently. If
-- Destination is CloudWatch, do not use this
-- parameter.
--
-- This parameter specifies the ARN of the Evidently experiment that is
-- to receive the metrics. You must have already defined this experiment
-- as a valid destination. For more information, see
-- PutRumMetricsDestination.
--
-- $sel:appMonitorName:UpdateRumMetricDefinition',
-- updateRumMetricDefinition_appMonitorName - The name of the
-- CloudWatch RUM app monitor that sends these metrics.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_destination - The destination to send
-- the metrics to. Valid values are CloudWatch and
-- Evidently. If you specify Evidently, you must also
-- specify the ARN of the CloudWatchEvidently experiment that will
-- receive the metrics and an IAM role that has permission to write to
-- the experiment.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_metricDefinition - A structure that
-- contains the new definition that you want to use for this metric.
--
-- UpdateRumMetricDefinition,
-- updateRumMetricDefinition_metricDefinitionId - The ID of the
-- metric definition to update.
newUpdateRumMetricDefinition :: Text -> MetricDestination -> MetricDefinitionRequest -> Text -> UpdateRumMetricDefinition
-- | See: newUpdateRumMetricDefinitionResponse smart
-- constructor.
data UpdateRumMetricDefinitionResponse
UpdateRumMetricDefinitionResponse' :: Int -> UpdateRumMetricDefinitionResponse
-- | Create a value of UpdateRumMetricDefinitionResponse with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:httpStatus:UpdateRumMetricDefinitionResponse',
-- updateRumMetricDefinitionResponse_httpStatus - The response's
-- http status code.
newUpdateRumMetricDefinitionResponse :: Int -> UpdateRumMetricDefinitionResponse
newtype CustomEventsStatus
CustomEventsStatus' :: Text -> CustomEventsStatus
[fromCustomEventsStatus] :: CustomEventsStatus -> Text
pattern CustomEventsStatus_DISABLED :: CustomEventsStatus
pattern CustomEventsStatus_ENABLED :: CustomEventsStatus
newtype MetricDestination
MetricDestination' :: Text -> MetricDestination
[fromMetricDestination] :: MetricDestination -> Text
pattern MetricDestination_CloudWatch :: MetricDestination
pattern MetricDestination_Evidently :: MetricDestination
newtype StateEnum
StateEnum' :: Text -> StateEnum
[fromStateEnum] :: StateEnum -> Text
pattern StateEnum_ACTIVE :: StateEnum
pattern StateEnum_CREATED :: StateEnum
pattern StateEnum_DELETING :: StateEnum
newtype Telemetry
Telemetry' :: Text -> Telemetry
[fromTelemetry] :: Telemetry -> Text
pattern Telemetry_Errors :: Telemetry
pattern Telemetry_Http :: Telemetry
pattern Telemetry_Performance :: Telemetry
-- | 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.
data AppMonitor
AppMonitor' :: Maybe AppMonitorConfiguration -> Maybe Text -> Maybe CustomEvents -> Maybe DataStorage -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> Maybe (HashMap Text Text) -> AppMonitor
-- | 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.
newAppMonitor :: AppMonitor
-- | This structure contains much of the configuration data for the app
-- monitor.
--
-- See: newAppMonitorConfiguration smart constructor.
data AppMonitorConfiguration
AppMonitorConfiguration' :: Maybe Bool -> Maybe Bool -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Double -> Maybe [Telemetry] -> AppMonitorConfiguration
-- | 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.
--
--
-- - 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.
--
newAppMonitorConfiguration :: AppMonitorConfiguration
-- | A structure that contains information about the RUM app monitor.
--
-- See: newAppMonitorDetails smart constructor.
data AppMonitorDetails
AppMonitorDetails' :: Maybe Text -> Maybe Text -> Maybe Text -> AppMonitorDetails
-- | 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.
newAppMonitorDetails :: AppMonitorDetails
-- | A structure that includes some data about app monitors and their
-- settings.
--
-- See: newAppMonitorSummary smart constructor.
data AppMonitorSummary
AppMonitorSummary' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe StateEnum -> AppMonitorSummary
-- | 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.
newAppMonitorSummary :: AppMonitorSummary
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchCreateRumMetricDefinitionsError smart
-- constructor.
data BatchCreateRumMetricDefinitionsError
BatchCreateRumMetricDefinitionsError' :: 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.
newBatchCreateRumMetricDefinitionsError :: Text -> Text -> MetricDefinitionRequest -> BatchCreateRumMetricDefinitionsError
-- | A structure that defines one error caused by a
-- BatchCreateRumMetricsDefinitions operation.
--
-- See: newBatchDeleteRumMetricDefinitionsError smart
-- constructor.
data BatchDeleteRumMetricDefinitionsError
BatchDeleteRumMetricDefinitionsError' :: 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.
newBatchDeleteRumMetricDefinitionsError :: Text -> Text -> Text -> BatchDeleteRumMetricDefinitionsError
-- | A structure that contains information about custom events for this app
-- monitor.
--
-- See: newCustomEvents smart constructor.
data CustomEvents
CustomEvents' :: Maybe CustomEventsStatus -> CustomEvents
-- | 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.
newCustomEvents :: CustomEvents
-- | 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.
data CwLog
CwLog' :: Maybe Bool -> Maybe Text -> CwLog
-- | 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.
newCwLog :: CwLog
-- | 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.
data DataStorage
DataStorage' :: Maybe CwLog -> DataStorage
-- | 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.
newDataStorage :: DataStorage
-- | 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.
data MetricDefinition
MetricDefinition' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> 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.
newMetricDefinition :: Text -> Text -> MetricDefinition
-- | 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 Name is PerformanceNavigationDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_navigation_event"]}
-- - If Name is PerformanceResourceDuration, then
-- ValueKeymust be event_details.duration and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.performance_resource_event"]}
-- - If Name is NavigationSatisfiedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">",2000] }] } }
-- - If Name is NavigationToleratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",2000,"<"8000] }] } }
-- - If Name is NavigationFrustratedTransaction, then
-- ValueKeymust be null and the EventPattern must
-- include { "event_type":
-- ["com.amazon.rum.performance_navigation_event"], "event_details": {
-- "duration": [{ "numeric": [">=",8000] }] } }
-- - If Name is WebVitalsCumulativeLayoutShift, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}
-- - If Name is WebVitalsFirstInputDelay, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.first_input_delay_event"]}
-- - If Name is WebVitalsLargestContentfulPaint, then
-- ValueKeymust be event_details.value and the
-- EventPattern must include
-- {"event_type":["com.amazon.rum.largest_contentful_paint_event"]}
-- - If Name is JsErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.js_error_event"]}
-- - If Name is HttpErrorCount, then
-- ValueKeymust be null and the EventPattern must
-- include {"event_type":["com.amazon.rum.http_event"]}
-- - If Name is SessionCount, then
-- ValueKeymust be null and the EventPattern must
-- include
-- {"event_type":["com.amazon.rum.session_start_event"]}
--
--
-- See: newMetricDefinitionRequest smart constructor.
data MetricDefinitionRequest
MetricDefinitionRequest' :: Maybe (HashMap Text Text) -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> MetricDefinitionRequest
-- | 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
--
newMetricDefinitionRequest :: Text -> MetricDefinitionRequest
-- | A structure that displays information about one destination that
-- CloudWatch RUM sends extended metrics to.
--
-- See: newMetricDestinationSummary smart constructor.
data MetricDestinationSummary
MetricDestinationSummary' :: Maybe MetricDestination -> Maybe Text -> Maybe Text -> MetricDestinationSummary
-- | 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.
newMetricDestinationSummary :: MetricDestinationSummary
-- | 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.
data QueryFilter
QueryFilter' :: Maybe Text -> Maybe [Text] -> QueryFilter
-- | 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.
newQueryFilter :: QueryFilter
-- | A structure that contains the information for one performance event
-- that RUM collects from a user session with your application.
--
-- See: newRumEvent smart constructor.
data RumEvent
RumEvent' :: Maybe Text -> Text -> Text -> POSIX -> Text -> RumEvent
-- | 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.
newRumEvent :: Text -> Text -> UTCTime -> Text -> RumEvent
-- | A structure that defines the time range that you want to retrieve
-- results from.
--
-- See: newTimeRange smart constructor.
data TimeRange
TimeRange' :: Maybe Integer -> Integer -> TimeRange
-- | 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.
newTimeRange :: Integer -> TimeRange
-- | A structure that contains information about the user session that this
-- batch of events was collected from.
--
-- See: newUserDetails smart constructor.
data UserDetails
UserDetails' :: Maybe Text -> Maybe Text -> UserDetails
-- | 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.
newUserDetails :: UserDetails