Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cloudwatch ]



You can use the get-metric-data API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Calls to the get-metric-data API have a different pricing structure than calls to get-metric-statistics . For more information about pricing, see Amazon CloudWatch Pricing .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--metric-data-queries <value>
--start-time <value>
--end-time <value>
[--next-token <value>]
[--scan-by <value>]
[--max-datapoints <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--metric-data-queries (list)

The metric queries to be returned. A single get-metric-data call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

JSON Syntax:

    "Id": "string",
    "MetricStat": {
      "Metric": {
        "Namespace": "string",
        "MetricName": "string",
        "Dimensions": [
            "Name": "string",
            "Value": "string"
      "Period": integer,
      "Stat": "string",
      "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"
    "Expression": "string",
    "Label": "string",
    "ReturnData": true|false

--start-time (timestamp)

The time stamp indicating the earliest data to be returned.

--end-time (timestamp)

The time stamp indicating the latest data to be returned.

--next-token (string)

Include this value, if it was returned by the previous call, to get the next set of data points.

--scan-by (string)

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Possible values:

  • TimestampDescending
  • TimestampAscending

--max-datapoints (integer)

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


MetricDataResults -> (list)

The metrics that are returned, including the metric name, namespace, and dimensions.


A get-metric-data call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the time stamps of those data points and other identifying information.

Id -> (string)

The short name you specified to represent this metric.

Label -> (string)

The human-readable label associated with the data.

Timestamps -> (list)

The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].


Values -> (list)

The data points for the metric corresponding to Timestamps . The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].


StatusCode -> (string)

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the next-token value that was returned and repeat your request to get more data points. next-token is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using next-token , if present.

Messages -> (list)

A list of messages with additional information about the data returned.


A message returned by the get-metric-data API, including a code and a description.

Code -> (string)

The error code or status code associated with the message.

Value -> (string)

The message text.

NextToken -> (string)

A token that marks the next batch of returned results.