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

Description

Removes the specified metrics from being sent to an extended metrics destination.

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.

Synopsis

Creating a Request

data BatchDeleteRumMetricDefinitions Source #

See: newBatchDeleteRumMetricDefinitions smart constructor.

Constructors

BatchDeleteRumMetricDefinitions' 

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 was receiving the metrics that are being deleted.

  • appMonitorName :: Text

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

  • destination :: MetricDestination

    Defines the destination where you want to stop sending the specified metrics. 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.

  • metricDefinitionIds :: [Text]

    An array of structures which define the metrics that you want to stop sending.

Instances

Instances details
ToHeaders BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

ToPath BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

ToQuery BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

AWSRequest BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Generic BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Associated Types

type Rep BatchDeleteRumMetricDefinitions :: Type -> Type #

Read BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Show BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

NFData BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Eq BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Hashable BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

type AWSResponse BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

type Rep BatchDeleteRumMetricDefinitions Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

type Rep BatchDeleteRumMetricDefinitions = D1 ('MetaData "BatchDeleteRumMetricDefinitions" "Amazonka.Rum.BatchDeleteRumMetricDefinitions" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "BatchDeleteRumMetricDefinitions'" '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 "metricDefinitionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newBatchDeleteRumMetricDefinitions Source #

Create a value of BatchDeleteRumMetricDefinitions 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:

BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_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 was receiving the metrics that are being deleted.

$sel:appMonitorName:BatchDeleteRumMetricDefinitions', batchDeleteRumMetricDefinitions_appMonitorName - The name of the CloudWatch RUM app monitor that is sending these metrics.

BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_destination - Defines the destination where you want to stop sending the specified metrics. 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.

BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitions_metricDefinitionIds - An array of structures which define the metrics that you want to stop sending.

Request Lenses

batchDeleteRumMetricDefinitions_destinationArn :: Lens' BatchDeleteRumMetricDefinitions (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 was receiving the metrics that are being deleted.

batchDeleteRumMetricDefinitions_appMonitorName :: Lens' BatchDeleteRumMetricDefinitions Text Source #

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

batchDeleteRumMetricDefinitions_destination :: Lens' BatchDeleteRumMetricDefinitions MetricDestination Source #

Defines the destination where you want to stop sending the specified metrics. 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.

batchDeleteRumMetricDefinitions_metricDefinitionIds :: Lens' BatchDeleteRumMetricDefinitions [Text] Source #

An array of structures which define the metrics that you want to stop sending.

Destructuring the Response

data BatchDeleteRumMetricDefinitionsResponse Source #

Constructors

BatchDeleteRumMetricDefinitionsResponse' 

Fields

Instances

Instances details
Generic BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Read BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Show BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

NFData BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

Eq BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

type Rep BatchDeleteRumMetricDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Rum.BatchDeleteRumMetricDefinitions

type Rep BatchDeleteRumMetricDefinitionsResponse = D1 ('MetaData "BatchDeleteRumMetricDefinitionsResponse" "Amazonka.Rum.BatchDeleteRumMetricDefinitions" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "BatchDeleteRumMetricDefinitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricDefinitionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDeleteRumMetricDefinitionsError]))))

newBatchDeleteRumMetricDefinitionsResponse Source #

Create a value of BatchDeleteRumMetricDefinitionsResponse 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:

BatchDeleteRumMetricDefinitions, batchDeleteRumMetricDefinitionsResponse_metricDefinitionIds - The IDs of the metric definitions that were deleted.

$sel:httpStatus:BatchDeleteRumMetricDefinitionsResponse', batchDeleteRumMetricDefinitionsResponse_httpStatus - The response's http status code.

$sel:errors:BatchDeleteRumMetricDefinitionsResponse', batchDeleteRumMetricDefinitionsResponse_errors - An array of error objects, if the operation caused any errors.

Response Lenses