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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data PutRumMetricsDestination Source #

See: newPutRumMetricsDestination smart constructor.

Constructors

PutRumMetricsDestination'

Fields

destinationArn :: Maybe Text
Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
iamRoleArn :: 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.
appMonitorName :: Text
The name of the CloudWatch RUM app monitor that will send the metrics.
destination :: MetricDestination
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.

Instances

Instances details

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

newPutRumMetricsDestination Source #

Arguments

:: Text	`$sel:appMonitorName:PutRumMetricsDestination'`
-> MetricDestination	`PutRumMetricsDestination`
-> 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.

Request Lenses

putRumMetricsDestination_destinationArn :: Lens' PutRumMetricsDestination (Maybe Text) Source #

Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

putRumMetricsDestination_iamRoleArn :: Lens' PutRumMetricsDestination (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 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_appMonitorName :: Lens' PutRumMetricsDestination Text Source #

The name of the CloudWatch RUM app monitor that will send the metrics.

putRumMetricsDestination_destination :: Lens' PutRumMetricsDestination MetricDestination Source #

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.

Destructuring the Response

data PutRumMetricsDestinationResponse Source #

See: newPutRumMetricsDestinationResponse smart constructor.

Constructors

PutRumMetricsDestinationResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPutRumMetricsDestinationResponse Source #

Arguments

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

Response Lenses

putRumMetricsDestinationResponse_httpStatus :: Lens' PutRumMetricsDestinationResponse Int Source #

The response's http status code.