update-fleet-metric¶
Description¶
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-fleet-metric
--metric-name <value>
[--query-string <value>]
[--aggregation-type <value>]
[--period <value>]
[--aggregation-field <value>]
[--description <value>]
[--query-version <value>]
--index-name <value>
[--unit <value>]
[--expected-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--metric-name (string)
The name of the fleet metric to update.
--query-string (string)
The search query string.
--aggregation-type (structure)
The type of the aggregation query.
name -> (string)
The name of the aggregation type.
values -> (list)
A list of the values of aggregation types.
(string)
Shorthand Syntax:
name=string,values=string,string
JSON Syntax:
{
"name": "Statistics"|"Percentiles"|"Cardinality",
"values": ["string", ...]
}
--period (integer)
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
--aggregation-field (string)
The field to aggregate.
--description (string)
The description of the fleet metric.
--query-version (string)
The version of the query.
--index-name (string)
The name of the index to search.
--unit (string)
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric .
Possible 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
--expected-version (long)
The expected version of the fleet metric record in the registry.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.
Output¶
None