Struct PutMetricDataInput

#[non_exhaustive]
pub struct PutMetricDataInput {
    pub namespace: Option<String>,
    pub metric_data: Option<Vec<MetricDatum>>,
    pub entity_metric_data: Option<Vec<EntityMetricData>>,
    pub strict_entity_validation: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

namespace: Option<String>

The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.

To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/

metric_data: Option<Vec<MetricDatum>>

The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.

The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.

entity_metric_data: Option<Vec<EntityMetricData>>

Data for metrics that contain associated entity information. You can include up to two EntityMetricData objects, each of which can contain a single Entity and associated metrics.

The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.

strict_entity_validation: Option<bool>

Whether to accept valid metric data when an invalid entity is sent.

• When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.

• When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.

  In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:

  • InvalidEntity - The provided entity is invalid.

  • InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.

  • InvalidAttributes - The provided Attributes of an entity is invalid.

  • InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.

  • EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.

  • MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.

  For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.

This parameter is required when EntityMetricData is included.

Implementations

impl PutMetricDataInput

pub fn namespace(&self) -> Option<&str>

The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.

To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/

pub fn metric_data(&self) -> &[MetricDatum]

The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.

The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_data.is_none().

pub fn entity_metric_data(&self) -> &[EntityMetricData]

Data for metrics that contain associated entity information. You can include up to two EntityMetricData objects, each of which can contain a single Entity and associated metrics.

The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entity_metric_data.is_none().

pub fn strict_entity_validation(&self) -> Option<bool>

Whether to accept valid metric data when an invalid entity is sent.

• When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.

• When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.

  In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:

  • InvalidEntity - The provided entity is invalid.

  • InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.

  • InvalidAttributes - The provided Attributes of an entity is invalid.

  • InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.

  • EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.

  • MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.

  For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.

This parameter is required when EntityMetricData is included.

impl PutMetricDataInput

pub fn builder() -> PutMetricDataInputBuilder

Creates a new builder-style object to manufacture PutMetricDataInput.

Trait Implementations

impl Clone for PutMetricDataInput

fn clone(&self) -> PutMetricDataInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutMetricDataInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PutMetricDataInput

fn eq(&self, other: &PutMetricDataInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PutMetricDataInput