Class: Aws::CloudWatch::Types::PutMetricDataInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_metric_data ⇒ Array<Types::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.

Returns:



4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 4239

class PutMetricDataInput < Struct.new(
  :namespace,
  :metric_data,
  :entity_metric_data,
  :strict_entity_validation)
  SENSITIVE = []
  include Aws::Structure
end

#metric_data ⇒ Array<Types::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.

Returns:



4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 4239

class PutMetricDataInput < Struct.new(
  :namespace,
  :metric_data,
  :entity_metric_data,
  :strict_entity_validation)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ 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/`

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 4239

class PutMetricDataInput < Struct.new(
  :namespace,
  :metric_data,
  :entity_metric_data,
  :strict_entity_validation)
  SENSITIVE = []
  include Aws::Structure
end

#strict_entity_validation ⇒ Boolean

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.

[1]: docs.aws.amazon.com/adding-your-own-related-telemetry.html

Returns:

  • (Boolean) 


4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 4239

class PutMetricDataInput < Struct.new(
  :namespace,
  :metric_data,
  :entity_metric_data,
  :strict_entity_validation)
  SENSITIVE = []
  include Aws::Structure
end