Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rum.CreateAppMonitor

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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?

Synopsis

data CreateAppMonitor = CreateAppMonitor' {
- appMonitorConfiguration :: Maybe AppMonitorConfiguration
- customEvents :: Maybe CustomEvents
- cwLogEnabled :: Maybe Bool
- tags :: Maybe (HashMap Text Text)
- domain :: Text
- name :: Text
}
newCreateAppMonitor :: Text -> Text -> CreateAppMonitor
createAppMonitor_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration)
createAppMonitor_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents)
createAppMonitor_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool)
createAppMonitor_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text))
createAppMonitor_domain :: Lens' CreateAppMonitor Text
createAppMonitor_name :: Lens' CreateAppMonitor Text
data CreateAppMonitorResponse = CreateAppMonitorResponse' {
- id :: Maybe Text
- httpStatus :: Int
}
newCreateAppMonitorResponse :: Int -> CreateAppMonitorResponse
createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text)
createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int

Creating a Request

data CreateAppMonitor Source #

See: newCreateAppMonitor smart constructor.

Constructors

CreateAppMonitor'

Fields

appMonitorConfiguration :: Maybe 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.
customEvents :: Maybe 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.
cwLogEnabled :: Maybe Bool
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.
tags :: Maybe (HashMap Text Text)
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.
domain :: Text
The top-level internet domain name for which your application has administrative authority.
name :: Text
A name for the app monitor.

Instances

Instances details

ToJSON CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods toJSON :: CreateAppMonitor -> Value # toEncoding :: CreateAppMonitor -> Encoding # toJSONList :: [CreateAppMonitor] -> Value # toEncodingList :: [CreateAppMonitor] -> Encoding #
ToHeaders CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods toHeaders :: CreateAppMonitor -> [Header] #
ToPath CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods toPath :: CreateAppMonitor -> ByteString #
ToQuery CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods toQuery :: CreateAppMonitor -> QueryString #
AWSRequest CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Associated Types type AWSResponse CreateAppMonitor # Methods request :: (Service -> Service) -> CreateAppMonitor -> Request CreateAppMonitor # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAppMonitor -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAppMonitor))) #
Generic CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Associated Types type Rep CreateAppMonitor :: Type -> Type # Methods from :: CreateAppMonitor -> Rep CreateAppMonitor x # to :: Rep CreateAppMonitor x -> CreateAppMonitor #
Read CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods readsPrec :: Int -> ReadS CreateAppMonitor # readList :: ReadS [CreateAppMonitor] # readPrec :: ReadPrec CreateAppMonitor # readListPrec :: ReadPrec [CreateAppMonitor] #
Show CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods showsPrec :: Int -> CreateAppMonitor -> ShowS # show :: CreateAppMonitor -> String # showList :: [CreateAppMonitor] -> ShowS #
NFData CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods rnf :: CreateAppMonitor -> () #
Eq CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods (==) :: CreateAppMonitor -> CreateAppMonitor -> Bool # (/=) :: CreateAppMonitor -> CreateAppMonitor -> Bool #
Hashable CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods hashWithSalt :: Int -> CreateAppMonitor -> Int # hash :: CreateAppMonitor -> Int #
type AWSResponse CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor type AWSResponse CreateAppMonitor = CreateAppMonitorResponse
type Rep CreateAppMonitor Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor type Rep CreateAppMonitor = D1 ('MetaData "CreateAppMonitor" "Amazonka.Rum.CreateAppMonitor" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "CreateAppMonitor'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appMonitorConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppMonitorConfiguration)) :: (S1 ('MetaSel ('Just "customEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomEvents)) :: S1 ('MetaSel ('Just "cwLogEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAppMonitor Source #

Arguments

:: Text	`CreateAppMonitor`
-> Text	`CreateAppMonitor`
-> 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.

Request Lenses

createAppMonitor_appMonitorConfiguration :: Lens' CreateAppMonitor (Maybe AppMonitorConfiguration) Source #

A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

createAppMonitor_customEvents :: Lens' CreateAppMonitor (Maybe CustomEvents) Source #

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

For more information about custom events, see Send custom events.

createAppMonitor_cwLogEnabled :: Lens' CreateAppMonitor (Maybe Bool) Source #

Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false.

createAppMonitor_tags :: Lens' CreateAppMonitor (Maybe (HashMap Text Text)) Source #

Assigns one or more tags (key-value pairs) to the app monitor.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging Amazon Web Services resources.

createAppMonitor_domain :: Lens' CreateAppMonitor Text Source #

The top-level internet domain name for which your application has administrative authority.

createAppMonitor_name :: Lens' CreateAppMonitor Text Source #

A name for the app monitor.

Destructuring the Response

data CreateAppMonitorResponse Source #

See: newCreateAppMonitorResponse smart constructor.

Constructors

CreateAppMonitorResponse'
Fields id :: Maybe Text The unique ID of the new app monitor. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Associated Types type Rep CreateAppMonitorResponse :: Type -> Type # Methods from :: CreateAppMonitorResponse -> Rep CreateAppMonitorResponse x # to :: Rep CreateAppMonitorResponse x -> CreateAppMonitorResponse #
Read CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods readsPrec :: Int -> ReadS CreateAppMonitorResponse # readList :: ReadS [CreateAppMonitorResponse] # readPrec :: ReadPrec CreateAppMonitorResponse # readListPrec :: ReadPrec [CreateAppMonitorResponse] #
Show CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods showsPrec :: Int -> CreateAppMonitorResponse -> ShowS # show :: CreateAppMonitorResponse -> String # showList :: [CreateAppMonitorResponse] -> ShowS #
NFData CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods rnf :: CreateAppMonitorResponse -> () #
Eq CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor Methods (==) :: CreateAppMonitorResponse -> CreateAppMonitorResponse -> Bool # (/=) :: CreateAppMonitorResponse -> CreateAppMonitorResponse -> Bool #
type Rep CreateAppMonitorResponse Source #
Instance details Defined in Amazonka.Rum.CreateAppMonitor type Rep CreateAppMonitorResponse = D1 ('MetaData "CreateAppMonitorResponse" "Amazonka.Rum.CreateAppMonitor" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "CreateAppMonitorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAppMonitorResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAppMonitorResponse'`
-> 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.

Response Lenses

createAppMonitorResponse_id :: Lens' CreateAppMonitorResponse (Maybe Text) Source #

The unique ID of the new app monitor.

createAppMonitorResponse_httpStatus :: Lens' CreateAppMonitorResponse Int Source #

The response's http status code.