2024/11/15 - Amazon CloudWatch - 1 updated api methods
Changes Adds support for adding related Entity information to metrics ingested through PutMetricData.
{'EntityMetricData': [{'Entity': {'Attributes': {'string': 'string'},
'KeyAttributes': {'string': 'string'}},
'MetricData': [{'Counts': ['double'],
'Dimensions': [{'Name': 'string',
'Value': 'string'}],
'MetricName': 'string',
'StatisticValues': {'Maximum': 'double',
'Minimum': 'double',
'SampleCount': 'double',
'Sum': 'double'},
'StorageResolution': 'integer',
'Timestamp': 'timestamp',
'Unit': 'Seconds | Microseconds | '
'Milliseconds | Bytes | '
'Kilobytes | Megabytes | '
'Gigabytes | Terabytes | Bits | '
'Kilobits | Megabits | Gigabits '
'| Terabits | Percent | Count | '
'Bytes/Second | '
'Kilobytes/Second | '
'Megabytes/Second | '
'Gigabytes/Second | '
'Terabytes/Second | Bits/Second '
'| Kilobits/Second | '
'Megabits/Second | '
'Gigabits/Second | '
'Terabits/Second | Count/Second '
'| None',
'Value': 'double',
'Values': ['double']}]}],
'StrictEntityValidation': 'boolean'}
Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
You can publish metrics with associated entity data (so that related telemetry can be found and viewed together), or publish metric data by itself. To send entity data with your metrics, use the EntityMetricData parameter. To send metrics without entity data, use the MetricData parameter. The EntityMetricData structure includes MetricData structures for the metric data.
You can publish either individual values in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricData structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics (across both the MetricData and EntityMetricData properties).
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.
See also: AWS API Documentation
Request Syntax
client.put_metric_data(
Namespace='string',
MetricData=[
{
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Timestamp': datetime(2015, 1, 1),
'Value': 123.0,
'StatisticValues': {
'SampleCount': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0
},
'Values': [
123.0,
],
'Counts': [
123.0,
],
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'StorageResolution': 123
},
],
EntityMetricData=[
{
'Entity': {
'KeyAttributes': {
'string': 'string'
},
'Attributes': {
'string': 'string'
}
},
'MetricData': [
{
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Timestamp': datetime(2015, 1, 1),
'Value': 123.0,
'StatisticValues': {
'SampleCount': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0
},
'Values': [
123.0,
],
'Counts': [
123.0,
],
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'StorageResolution': 123
},
]
},
],
StrictEntityValidation=True|False
)
string
[REQUIRED]
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/
list
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.
(dict) --
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
MetricName (string) -- [REQUIRED]
The name of the metric.
Dimensions (list) --
The dimensions associated with the metric.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( :). ASCII control characters are not supported as part of dimension names.
Value (string) -- [REQUIRED]
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
Timestamp (datetime) --
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Value (float) --
The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
StatisticValues (dict) --
The statistical values for the metric.
SampleCount (float) -- [REQUIRED]
The number of samples used for the statistic set.
Sum (float) -- [REQUIRED]
The sum of values for the sample set.
Minimum (float) -- [REQUIRED]
The minimum value of the sample set.
Maximum (float) -- [REQUIRED]
The maximum value of the sample set.
Values (list) --
Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
(float) --
Counts (list) --
Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.
(float) --
Unit (string) --
When you are using a Put operation, this defines what unit you want to use when storing the metric.
In a Get operation, this displays the unit that is used for the metric.
StorageResolution (integer) --
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
This field is optional, if you do not specify it the default of 60 is used.
list
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.
(dict) --
A set of metrics that are associated with an entity, such as a specific service or resource. Contains the entity and the list of metric data associated with it.
Entity (dict) --
The entity associated with the metrics.
KeyAttributes (dict) --
The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same KeyAttributes are considered to be the same entity. For an entity to be valid, the KeyAttributes must exist and be formatted correctly.
There are five allowed attributes (key names): Type, ResourceType, Identifier, Name, and Environment.
For details about how to use the key attributes to specify an entity, see How to add related information to telemetry in the CloudWatch User Guide.
(string) --
(string) --
Attributes (dict) --
Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.
For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.
(string) --
(string) --
MetricData (list) --
The metric data.
(dict) --
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
MetricName (string) -- [REQUIRED]
The name of the metric.
Dimensions (list) --
The dimensions associated with the metric.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( :). ASCII control characters are not supported as part of dimension names.
Value (string) -- [REQUIRED]
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
Timestamp (datetime) --
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Value (float) --
The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
StatisticValues (dict) --
The statistical values for the metric.
SampleCount (float) -- [REQUIRED]
The number of samples used for the statistic set.
Sum (float) -- [REQUIRED]
The sum of values for the sample set.
Minimum (float) -- [REQUIRED]
The minimum value of the sample set.
Maximum (float) -- [REQUIRED]
The maximum value of the sample set.
Values (list) --
Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
(float) --
Counts (list) --
Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.
(float) --
Unit (string) --
When you are using a Put operation, this defines what unit you want to use when storing the metric.
In a Get operation, this displays the unit that is used for the metric.
StorageResolution (integer) --
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
This field is optional, if you do not specify it the default of 60 is used.
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.
None