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

Description

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

This operation returns paginated results.

Synopsis

Creating a Request

data BatchGetRumMetricDefinitions Source #

See: newBatchGetRumMetricDefinitions smart constructor.

Constructors

BatchGetRumMetricDefinitions' 

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 corresponds to the destination.

  • maxResults :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    Use the token returned by the previous operation to request the next page of results.

  • appMonitorName :: Text

    The name of the CloudWatch RUM app monitor that is sending the metrics.

  • destination :: MetricDestination

    The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

Instances

Instances details
ToHeaders BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

toHeaders :: BatchGetRumMetricDefinitions -> [Header] #

ToPath BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

toPath :: BatchGetRumMetricDefinitions -> ByteString #

ToQuery BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

toQuery :: BatchGetRumMetricDefinitions -> QueryString #

AWSPager BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

page :: BatchGetRumMetricDefinitions -> AWSResponse BatchGetRumMetricDefinitions -> Maybe BatchGetRumMetricDefinitions #

AWSRequest BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Associated Types

type AWSResponse BatchGetRumMetricDefinitions #

Methods

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

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

Generic BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Associated Types

type Rep BatchGetRumMetricDefinitions :: Type -> Type #

Methods

from :: BatchGetRumMetricDefinitions -> Rep BatchGetRumMetricDefinitions x #

to :: Rep BatchGetRumMetricDefinitions x -> BatchGetRumMetricDefinitions #

Read BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

readsPrec :: Int -> ReadS BatchGetRumMetricDefinitions #

readList :: ReadS [BatchGetRumMetricDefinitions] #

readPrec :: ReadPrec BatchGetRumMetricDefinitions #

readListPrec :: ReadPrec [BatchGetRumMetricDefinitions] #

Show BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

showsPrec :: Int -> BatchGetRumMetricDefinitions -> ShowS #

show :: BatchGetRumMetricDefinitions -> String #

showList :: [BatchGetRumMetricDefinitions] -> ShowS #

NFData BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

rnf :: BatchGetRumMetricDefinitions -> () #

Eq BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

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

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

Hashable BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

hashWithSalt :: Int -> BatchGetRumMetricDefinitions -> Int #

hash :: BatchGetRumMetricDefinitions -> Int #

type AWSResponse BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

type AWSResponse BatchGetRumMetricDefinitions = BatchGetRumMetricDefinitionsResponse
type Rep BatchGetRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

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

newBatchGetRumMetricDefinitions Source #

Arguments

:: Text

$sel:appMonitorName:BatchGetRumMetricDefinitions'

-> MetricDestination

BatchGetRumMetricDefinitions

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

Request Lenses

batchGetRumMetricDefinitions_destinationArn :: Lens' BatchGetRumMetricDefinitions (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 corresponds to the destination.

batchGetRumMetricDefinitions_maxResults :: Lens' BatchGetRumMetricDefinitions (Maybe Natural) Source #

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_nextToken :: Lens' BatchGetRumMetricDefinitions (Maybe Text) Source #

Use the token returned by the previous operation to request the next page of results.

batchGetRumMetricDefinitions_appMonitorName :: Lens' BatchGetRumMetricDefinitions Text Source #

The name of the CloudWatch RUM app monitor that is sending the metrics.

batchGetRumMetricDefinitions_destination :: Lens' BatchGetRumMetricDefinitions MetricDestination Source #

The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

Destructuring the Response

data BatchGetRumMetricDefinitionsResponse Source #

See: newBatchGetRumMetricDefinitionsResponse smart constructor.

Constructors

BatchGetRumMetricDefinitionsResponse' 

Fields

Instances

Instances details
Generic BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Associated Types

type Rep BatchGetRumMetricDefinitionsResponse :: Type -> Type #

Methods

from :: BatchGetRumMetricDefinitionsResponse -> Rep BatchGetRumMetricDefinitionsResponse x #

to :: Rep BatchGetRumMetricDefinitionsResponse x -> BatchGetRumMetricDefinitionsResponse #

Read BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

readsPrec :: Int -> ReadS BatchGetRumMetricDefinitionsResponse #

readList :: ReadS [BatchGetRumMetricDefinitionsResponse] #

readPrec :: ReadPrec BatchGetRumMetricDefinitionsResponse #

readListPrec :: ReadPrec [BatchGetRumMetricDefinitionsResponse] #

Show BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

showsPrec :: Int -> BatchGetRumMetricDefinitionsResponse -> ShowS #

show :: BatchGetRumMetricDefinitionsResponse -> String #

showList :: [BatchGetRumMetricDefinitionsResponse] -> ShowS #

NFData BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

rnf :: BatchGetRumMetricDefinitionsResponse -> () #

Eq BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

Methods

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

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

type Rep BatchGetRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchGetRumMetricDefinitions

type Rep BatchGetRumMetricDefinitionsResponse = D1 ('MetaData "BatchGetRumMetricDefinitionsResponse" "Amazonka.Rum.BatchGetRumMetricDefinitions" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "BatchGetRumMetricDefinitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDefinition])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchGetRumMetricDefinitionsResponse Source #

Arguments

:: Int

$sel:httpStatus:BatchGetRumMetricDefinitionsResponse'

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

Response Lenses

batchGetRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe [MetricDefinition]) Source #

An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.

batchGetRumMetricDefinitionsResponse_nextToken :: Lens' BatchGetRumMetricDefinitionsResponse (Maybe Text) Source #

A token that you can use in a subsequent operation to retrieve the next set of results.

batchGetRumMetricDefinitionsResponse_httpStatus :: Lens' BatchGetRumMetricDefinitionsResponse Int Source #

The response's http status code.