mon-put-data
Description
Adds metric data points to the specified metric. This call will put time-series data, for either the raw value or valid statistic values of a given metric name. It supports the input of a single data point at a time.
Note
When you create a new metric using the mon-put-data command, it can take up to two minutes
before you can retrieve statistics on the new metric using the mon-get-stats command.
However, it can take up to fifteen minutes before the new metric appears in the list of metrics
retrieved using the mon-list-metrics command.
Syntax
mon-put-data --metric-name
value[--namespace value
[--dimensions
"key1=value1,key2=value2..."]
[--statisticValues
"key1=value1,key2=value2..."]
[--timestamp value] [--unit value]
[--value value] [Common Options]
Options
| Name | Description |
|---|---|
|
-d, --dimensions "key1=value1,key2=value2..." |
The dimensions that uniquely identify the metric data. You can specify dimensions two ways and the formats can be combined or used interchangeably:
Type: Map Valid values: A string of the format name=value, where the key is the name of the dimension, and the value is the dimension's value. The dimension names, and values must be an ANSI string between 1 and 250 characters long. A maximum of 10 dimensions are allowed. Default: n/a Required: No |
|
|
The name of the metric. Type: String Valid values: Any valid metric name between 1 and 250 characters. Default: n/a Required: Yes |
|
|
The namespace of the metric. For more information about namespaces, see AWS Namespaces. Type: String Valid values: An ANSI string between 1 and 250 characters in length. Default: n/a Required: Yes |
|
|
The statistics to store for the specified timestamp and metric. This option is exclusive with Type: Map Valid values: A string containing all double values for all statistic names: SampleCount, Sum, Maximum, and Minimum. All these values must be a value between 1E-130 and 1E130. Default: n/a Required: Yes |
|
|
The timestamp of the data point or observation for the metric to record. Timestamps are specified using ISO8601 combined format. For example the date and time July 30th, 2013 at 12:30:00 PST would be represented as 2013-07-30T12:30:00-07:00, or in UTC: 2013-07-30T19:30:00Z. Type: Simple Valid values: A valid timestamp represented in ISO8601 format with time zone offset, or UTC indicator. Default: The current UTC time. Required: No |
|
|
The unit for the metric. Type: Enumeration Valid values: One of the following:
Default: n/a Required: No |
|
|
A single value to be recorded. The value is translated to a
statistic set of the form: SampleCount=1, Sum=VALUE, Minimum=VALUE, Maximum=VALUE.
This option is exclusive of Type: Simple Valid values: All values must be a number between 1E-130 and 1E130. Default: n/a Required: Yes |
Common options
| Name | Description |
|---|---|
|
|
The location of the file with your AWS credentials. You can set this
value using the environment variable Type: String Valid values: A valid path to a file containing your access key ID and secret access key. Default: Uses the environment variable |
|
|
The location of your EC2 certificate file for signing requests. You
can use the environment variable Type: String Valid values: A valid file path to the PEM file provided by Amazon EC2 or AWS Identity and Access Management. Default: Uses the environment variable |
|
|
The connection timeout value, in seconds. Type: Integer Valid values: Any positive number. Default: 30 |
|
|
The delimiter to use when displaying delimited (long) results. Type: String Valid values: Any string. Default: Comma (,) |
|
|
If you are displaying tabular or delimited results, include the column headers. If you are showing XML results, return the HTTP headers from the service request, if applicable. Type: Flag Valid values: When present, shows headers. Default: The |
|
|
The access key ID that will be used, in conjunction with the secret key, to sign the request. This must be used in conjunction with --secret-key, otherwise the option is ignored. All requests to CloudWatch must be signed, otherwise the request is rejected. Type: String Valid values: A valid access key ID. Default: None |
|
|
The private key that will be used to sign the
request. Using public/private keys causes the CLI to use SOAP. The request is
signed with a public certificate and private key. This parameter must be used in
conjunction with Type: String Valid values: The path to a valid ASN.1 private key. Default: None |
|
|
The region requests are directed to. You can use the environment
variable Type: String Valid values: Any AWS region, for example, us-east-1. Default: us-east-1, unless the |
|
|
The secret access key that will be used to sign the request, in conjunction with an access
key ID. This parameter must be used in conjunction with
Type: String Valid values: Your access key ID. Default: None |
|
|
Shows empty fields using (nil) as a placeholder to indicate that this data was not requested. Type: Flag Valid values: None Default: Empty fields are not shown by default. |
|
|
Displays the URL the CLI uses to call AWS. Type: Flag Valid values: None Default: false |
|
|
Specifies how the results are displayed: in a table, delimited (long), XML, or
no output (quiet). The Type: Flag Valid values: None Default: |
|
|
The URL used to contact CloudWatch. You can set this value using the
environment variable Type: String Valid values: A valid HTTP or HTTPS URL. Default: Uses the value specified in |
Output
This command adds metric data points to a metric.
The Amazon CloudWatch CLI displays errors on stderr.
Examples
Example request
This example puts statistic data for RequestCount in the MyService namespace.
The metric contains no dimensions and so represents the overall RequestCount
across the entire service. The measurement is a pre-aggregated
statisticValue representing five earlier measurements whose maximum was 70,
whose minimum was 30, and whose sum was 250.
mon-put-data --metric-name RequestCount --namespace "MyService" --timestamp 2013-11-25T00:00:00.000Z --statisticValues "Sum=250,Minimum=30,Maximum=70,SampleCount=5"
Example request
This example puts user-specific RequestCount test data in the MyService
namespace. The user and stack name are stored as dimensions in order to
distinguish this metric from the service-wide metric in the example above.
mon-put-data --metric-name RequestCount --namespace "MyService" --dimensions "User=SomeUser,Stack=Test" --timestamp 2013-11-25T00:00:00.000Z --value 50
Related topics
Download
Related action
Related command
