amazonka-rum-2.0: Amazon CloudWatch RUM SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rum.UpdateAppMonitor

Description

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?

Synopsis

Creating a Request

data UpdateAppMonitor Source #

See: newUpdateAppMonitor smart constructor.

Constructors

UpdateAppMonitor' 

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.

  • customEvents :: Maybe 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.

  • 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.

  • domain :: Maybe Text

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

  • name :: Text

    The name of the app monitor to update.

Instances

Instances details
ToJSON UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

ToHeaders UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

ToPath UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

ToQuery UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

AWSRequest UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Associated Types

type AWSResponse UpdateAppMonitor #

Generic UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Associated Types

type Rep UpdateAppMonitor :: Type -> Type #

Read UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Show UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

NFData UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Methods

rnf :: UpdateAppMonitor -> () #

Eq UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Hashable UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

type AWSResponse UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

type Rep UpdateAppMonitor Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

type Rep UpdateAppMonitor = D1 ('MetaData "UpdateAppMonitor" "Amazonka.Rum.UpdateAppMonitor" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "UpdateAppMonitor'" '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 "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateAppMonitor Source #

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.

Request Lenses

updateAppMonitor_appMonitorConfiguration :: Lens' UpdateAppMonitor (Maybe AppMonitorConfiguration) Source #

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

updateAppMonitor_customEvents :: Lens' UpdateAppMonitor (Maybe CustomEvents) Source #

Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.

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

updateAppMonitor_cwLogEnabled :: Lens' UpdateAppMonitor (Maybe Bool) Source #

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

updateAppMonitor_domain :: Lens' UpdateAppMonitor (Maybe Text) Source #

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

updateAppMonitor_name :: Lens' UpdateAppMonitor Text Source #

The name of the app monitor to update.

Destructuring the Response

data UpdateAppMonitorResponse Source #

See: newUpdateAppMonitorResponse smart constructor.

Constructors

UpdateAppMonitorResponse' 

Fields

Instances

Instances details
Generic UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Associated Types

type Rep UpdateAppMonitorResponse :: Type -> Type #

Read UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Show UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

NFData UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

Eq UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

type Rep UpdateAppMonitorResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateAppMonitor

type Rep UpdateAppMonitorResponse = D1 ('MetaData "UpdateAppMonitorResponse" "Amazonka.Rum.UpdateAppMonitor" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "UpdateAppMonitorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAppMonitorResponse Source #

Create a value of UpdateAppMonitorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateAppMonitorResponse', updateAppMonitorResponse_httpStatus - The response's http status code.

Response Lenses