| 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.BatchCreateRumMetricDefinitions
Description
Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.
If you also send extended metrics, you can send metrics to Evidently as
well as CloudWatch, and you can also optionally send the metrics with
additional dimensions. The valid dimension names for the additional
dimensions are BrowserName, CountryCode, DeviceType, FileType,
OSName, and PageId. For more information, see
Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
The maximum number of metric definitions that you can specify in one
BatchCreateRumMetricDefinitions operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.
You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.
If some metric definitions specified in a
BatchCreateRumMetricDefinitions operations are not valid, those metric
definitions fail and return errors, but all valid metric definitions in
the same operation still succeed.
Synopsis
- data BatchCreateRumMetricDefinitions = BatchCreateRumMetricDefinitions' {}
- newBatchCreateRumMetricDefinitions :: Text -> MetricDestination -> BatchCreateRumMetricDefinitions
- batchCreateRumMetricDefinitions_destinationArn :: Lens' BatchCreateRumMetricDefinitions (Maybe Text)
- batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text
- batchCreateRumMetricDefinitions_destination :: Lens' BatchCreateRumMetricDefinitions MetricDestination
- batchCreateRumMetricDefinitions_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest]
- data BatchCreateRumMetricDefinitionsResponse = BatchCreateRumMetricDefinitionsResponse' {}
- newBatchCreateRumMetricDefinitionsResponse :: Int -> BatchCreateRumMetricDefinitionsResponse
- batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition])
- batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int
- batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError]
Creating a Request
data BatchCreateRumMetricDefinitions Source #
See: newBatchCreateRumMetricDefinitions smart constructor.
Constructors
| BatchCreateRumMetricDefinitions' | |
Fields
| |
Instances
newBatchCreateRumMetricDefinitions Source #
Arguments
| :: Text | |
| -> MetricDestination | |
| -> BatchCreateRumMetricDefinitions |
Create a value of BatchCreateRumMetricDefinitions 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:
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_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:BatchCreateRumMetricDefinitions', batchCreateRumMetricDefinitions_appMonitorName - The name of the CloudWatch RUM app monitor that is to send the metrics.
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_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.
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitions_metricDefinitions - An array of structures which define the metrics that you want to send.
Request Lenses
batchCreateRumMetricDefinitions_destinationArn :: Lens' BatchCreateRumMetricDefinitions (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.
batchCreateRumMetricDefinitions_appMonitorName :: Lens' BatchCreateRumMetricDefinitions Text Source #
The name of the CloudWatch RUM app monitor that is to send the metrics.
batchCreateRumMetricDefinitions_destination :: Lens' BatchCreateRumMetricDefinitions 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.
batchCreateRumMetricDefinitions_metricDefinitions :: Lens' BatchCreateRumMetricDefinitions [MetricDefinitionRequest] Source #
An array of structures which define the metrics that you want to send.
Destructuring the Response
data BatchCreateRumMetricDefinitionsResponse Source #
See: newBatchCreateRumMetricDefinitionsResponse smart constructor.
Constructors
| BatchCreateRumMetricDefinitionsResponse' | |
Fields
| |
Instances
newBatchCreateRumMetricDefinitionsResponse Source #
Arguments
| :: Int | |
| -> BatchCreateRumMetricDefinitionsResponse |
Create a value of BatchCreateRumMetricDefinitionsResponse 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:
BatchCreateRumMetricDefinitions, batchCreateRumMetricDefinitionsResponse_metricDefinitions - An array of structures that define the extended metrics.
$sel:httpStatus:BatchCreateRumMetricDefinitionsResponse', batchCreateRumMetricDefinitionsResponse_httpStatus - The response's http status code.
$sel:errors:BatchCreateRumMetricDefinitionsResponse', batchCreateRumMetricDefinitionsResponse_errors - An array of error objects, if the operation caused any errors.
Response Lenses
batchCreateRumMetricDefinitionsResponse_metricDefinitions :: Lens' BatchCreateRumMetricDefinitionsResponse (Maybe [MetricDefinition]) Source #
An array of structures that define the extended metrics.
batchCreateRumMetricDefinitionsResponse_httpStatus :: Lens' BatchCreateRumMetricDefinitionsResponse Int Source #
The response's http status code.
batchCreateRumMetricDefinitionsResponse_errors :: Lens' BatchCreateRumMetricDefinitionsResponse [BatchCreateRumMetricDefinitionsError] Source #
An array of error objects, if the operation caused any errors.