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

Description

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

Synopsis

Creating a Request

data UpdateRumMetricDefinition Source #

See: newUpdateRumMetricDefinition smart constructor.

Constructors

UpdateRumMetricDefinition' 

Fields

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

  • appMonitorName :: Text

    The name of the CloudWatch RUM app monitor that sends these metrics.

  • destination :: MetricDestination

    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.

  • metricDefinition :: MetricDefinitionRequest

    A structure that contains the new definition that you want to use for this metric.

  • metricDefinitionId :: Text

    The ID of the metric definition to update.

Instances

Instances details
ToJSON UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

toJSON :: UpdateRumMetricDefinition -> Value #

toEncoding :: UpdateRumMetricDefinition -> Encoding #

toJSONList :: [UpdateRumMetricDefinition] -> Value #

toEncodingList :: [UpdateRumMetricDefinition] -> Encoding #

ToHeaders UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

toHeaders :: UpdateRumMetricDefinition -> [Header] #

ToPath UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

toPath :: UpdateRumMetricDefinition -> ByteString #

ToQuery UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

toQuery :: UpdateRumMetricDefinition -> QueryString #

AWSRequest UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Associated Types

type AWSResponse UpdateRumMetricDefinition #

Methods

request :: (Service -> Service) -> UpdateRumMetricDefinition -> Request UpdateRumMetricDefinition #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRumMetricDefinition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRumMetricDefinition))) #

Generic UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Associated Types

type Rep UpdateRumMetricDefinition :: Type -> Type #

Methods

from :: UpdateRumMetricDefinition -> Rep UpdateRumMetricDefinition x #

to :: Rep UpdateRumMetricDefinition x -> UpdateRumMetricDefinition #

Read UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

readsPrec :: Int -> ReadS UpdateRumMetricDefinition #

readList :: ReadS [UpdateRumMetricDefinition] #

readPrec :: ReadPrec UpdateRumMetricDefinition #

readListPrec :: ReadPrec [UpdateRumMetricDefinition] #

Show UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

showsPrec :: Int -> UpdateRumMetricDefinition -> ShowS #

show :: UpdateRumMetricDefinition -> String #

showList :: [UpdateRumMetricDefinition] -> ShowS #

NFData UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

rnf :: UpdateRumMetricDefinition -> () #

Eq UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

(==) :: UpdateRumMetricDefinition -> UpdateRumMetricDefinition -> Bool #

(/=) :: UpdateRumMetricDefinition -> UpdateRumMetricDefinition -> Bool #

Hashable UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

hashWithSalt :: Int -> UpdateRumMetricDefinition -> Int #

hash :: UpdateRumMetricDefinition -> Int #

type AWSResponse UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

type AWSResponse UpdateRumMetricDefinition = UpdateRumMetricDefinitionResponse
type Rep UpdateRumMetricDefinition Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

type Rep UpdateRumMetricDefinition = D1 ('MetaData "UpdateRumMetricDefinition" "Amazonka.Rum.UpdateRumMetricDefinition" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "UpdateRumMetricDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appMonitorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricDestination) :*: (S1 ('MetaSel ('Just "metricDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricDefinitionRequest) :*: S1 ('MetaSel ('Just "metricDefinitionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateRumMetricDefinition Source #

Arguments

:: Text

$sel:appMonitorName:UpdateRumMetricDefinition'

-> MetricDestination

UpdateRumMetricDefinition

-> MetricDefinitionRequest

UpdateRumMetricDefinition

-> Text

UpdateRumMetricDefinition

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

Request Lenses

updateRumMetricDefinition_destinationArn :: Lens' UpdateRumMetricDefinition (Maybe Text) Source #

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

updateRumMetricDefinition_appMonitorName :: Lens' UpdateRumMetricDefinition Text Source #

The name of the CloudWatch RUM app monitor that sends these metrics.

updateRumMetricDefinition_destination :: Lens' UpdateRumMetricDefinition MetricDestination Source #

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

updateRumMetricDefinition_metricDefinition :: Lens' UpdateRumMetricDefinition MetricDefinitionRequest Source #

A structure that contains the new definition that you want to use for this metric.

updateRumMetricDefinition_metricDefinitionId :: Lens' UpdateRumMetricDefinition Text Source #

The ID of the metric definition to update.

Destructuring the Response

data UpdateRumMetricDefinitionResponse Source #

See: newUpdateRumMetricDefinitionResponse smart constructor.

Constructors

UpdateRumMetricDefinitionResponse' 

Fields

Instances

Instances details
Generic UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Associated Types

type Rep UpdateRumMetricDefinitionResponse :: Type -> Type #

Methods

from :: UpdateRumMetricDefinitionResponse -> Rep UpdateRumMetricDefinitionResponse x #

to :: Rep UpdateRumMetricDefinitionResponse x -> UpdateRumMetricDefinitionResponse #

Read UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

readsPrec :: Int -> ReadS UpdateRumMetricDefinitionResponse #

readList :: ReadS [UpdateRumMetricDefinitionResponse] #

readPrec :: ReadPrec UpdateRumMetricDefinitionResponse #

readListPrec :: ReadPrec [UpdateRumMetricDefinitionResponse] #

Show UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

showsPrec :: Int -> UpdateRumMetricDefinitionResponse -> ShowS #

show :: UpdateRumMetricDefinitionResponse -> String #

showList :: [UpdateRumMetricDefinitionResponse] -> ShowS #

NFData UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

rnf :: UpdateRumMetricDefinitionResponse -> () #

Eq UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

Methods

(==) :: UpdateRumMetricDefinitionResponse -> UpdateRumMetricDefinitionResponse -> Bool #

(/=) :: UpdateRumMetricDefinitionResponse -> UpdateRumMetricDefinitionResponse -> Bool #

type Rep UpdateRumMetricDefinitionResponse Source # 
Instance details

Defined in Amazonka.Rum.UpdateRumMetricDefinition

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

newUpdateRumMetricDefinitionResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateRumMetricDefinitionResponse'

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

Response Lenses

updateRumMetricDefinitionResponse_httpStatus :: Lens' UpdateRumMetricDefinitionResponse Int Source #

The response's http status code.