GetMetricStatistics
Gets statistics for the specified metric.
Amazon CloudWatch retains metric data as follows:
Data points with a period of 60 seconds (1 minute) are available for 15 days
Data points with a period of 300 seconds (5 minute) are available for 63 days
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)
Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.
Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, Amazon CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
For a list of metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Dimensions.member.N
The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide.
Type: array of Dimension objects
Array Members: Maximum number of 10 items.
Required: No
- EndTime
The time stamp that determines the last data point to return.
The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
Type: Timestamp
Required: Yes
- ExtendedStatistics.member.N
The percentile statistics. Specify values between p0.0 and p100.
Type: array of Strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Pattern:
p(\d{1,2}(\.\d{0,2})?|100)
Required: No
- MetricName
The name of the metric, with or without spaces.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Namespace
The namespace of the metric, with or without spaces.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[^:].*
Required: Yes
- Period
The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.
If the
StartTime
parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned:Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
Type: Integer
Valid Range: Minimum value of 60.
Required: Yes
- StartTime
The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
Type: Timestamp
Required: Yes
- Statistics.member.N
The metric statistics, other than percentile. For percentile statistics, use
ExtendedStatistic
.Type: array of Strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Valid Values:
SampleCount | Average | Sum | Minimum | Maximum
Required: No
- Unit
The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.
Type: String
Valid Values:
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
Required: No
Response Elements
The following elements are returned by the service.
- Datapoints.member.N
The data points for the specified metric.
Type: array of Datapoint objects
- Label
A label for the specified metric.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParameterCombination
Parameters that cannot be used together were used together.
HTTP Status Code: 400
- InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400
- MissingParameter
An input parameter that is required is missing.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: