SYNOPSIS
mon-list-metrics
[--dimensions "key1=value1,key2=value2..." ] [--metric-name value ]
[--namespace value ] [General Options]
DESCRIPTION
This call will get a list of all the metrics that the system is storing for
your AWS account. Note: Any metric not seen for two weeks will be aged out
from this list as that is the retention period for data. Metrics may be
filtered by any combination of MetricName, Namespace or Dimensions. If any
of these filters is not specified, then all possible matches for the
respective attribute are returned.
SPECIFIC OPTIONS
-d, --dimensions "key1=value1,key2=value2..."
Dimensions (one or more) along which the metric names are to be filtered.
If no dimensions are specified then metric names with all possible
dimensions will be included in the results.
-m, --metric-name VALUE
The name of a particular metric that you are interested in. If not
specified, all possible metric names will be returned.
-n, --namespace VALUE
The namespace along which metrics will be filtered. If not specified,
metric names from all possible namespaces will be returned.
GENERAL OPTIONS
--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.
-C, --ec2-cert-file-path VALUE
Location of your EC2 certificate file. This value can be set by using the
environment variable 'EC2_CERT'.
--connection-timeout VALUE
Specify a connection timeout VALUE (in seconds). The default value is
'30'.
--delimiter VALUE
What delimiter to use when displaying delimited (long) results.
--headers
If you are displaying tabular or delimited results, it includes the
column headers. If you are showing xml results, it returns the HTTP
headers from the service request, if applicable. This is off by default.
-I, --access-key-id VALUE
Specify VALUE as the AWS Access Id to use.
-K, --ec2-private-key-file-path VALUE
Location of your EC2 private key file. This value can be set by using the
environment variable 'EC2_PRIVATE_KEY'.
--region VALUE
Specify region VALUE as the web service region to use. This value can be
set by using the environment variable 'EC2_REGION'.
-S, --secret-key VALUE
Specify VALUE as the AWS Secret Key to use.
--show-empty-fields
Show empty fields and rows, using a "(nil)" value. The default is to not
show empty fields or columns.
--show-request
Displays the URL the tools used to call the AWS Service. The default
value is 'false'.
--show-table, --show-long, --show-xml, --quiet
Specify how the results are displayed: tabular, delimited (long), xml, or
no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character. The xml is the raw return from the service, while quiet
suppresses all standard output. The default is tabular, or 'show-table'.
-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable 'AWS_CLOUDWATCH_URL'.
INPUT EXAMPLES
This returns a list of all your metrics.
$PROMPT>mon-list-metrics
This returns a list of all your metrics that have a particular metric name.
$PROMPT>mon-list-metrics --metric-name RequestCount
This returns a list of all your metrics that belong to a particular
namespace
$PROMPT>mon-list-metrics --namespace MyService
This returns a list of all your metrics having the specified dimension names
and values.
$PROMPT>mon-list-metrics --dimensions "User=SomeUser,Stack=Test"
OUTPUT
This command returns a table that contains the following:
* Metric Name - The name of the metric attached to this metric.
* Namespace - The namespace associated with this metric.
* Dimensions - A list of the dimension names and values associated with this
metric.
OUTPUT EXAMPLES
This is an example of an output of a call to 'mon-list-metrics'.