AWS CLI Command Reference

[ aws . cloudwatch ]

put-metric-data-query-definition

Description

Creates or updates a metric data query definition.

A metric data query definition saves a metric query so that you can reuse it later. It includes the query expression, the query language, and a path that names the definition and can organize it into folders. When you save a definition, CloudWatch doesn’t validate or run its expression.

To create a definition, omit Id . CloudWatch generates the ID and returns it. To update a definition, specify its Id . An update replaces the path, expression, and type, and keeps the creation time.

The path must be unique in your account and Region. If another definition already uses the path, the request fails with a ConflictException .

You can have up to 1,000 metric data query definitions in each Region of your account. A request that would create more fails with a LimitExceededException .

Permissions

To create or update a definition, you need the cloudwatch:PutMetricDataQueryDefinition permission on the metric data query definition resource. The resource ARN has the format arn:aws:cloudwatch:Region:account-id:metric-query-definition/Id .

To add tags when you create a definition, you also need the cloudwatch:TagResource permission. You can use the aws:RequestTag/${TagKey} and aws:TagKeys condition keys to control which tags can be added.

See also: AWS API Documentation

Synopsis

  put-metric-data-query-definition
[--id <value>]
--path <value>
--expression <value>
--type <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--id (string)

The ID of the metric data query definition to update. Omit this parameter to create a definition. CloudWatch then generates the ID and returns it in the response.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9-]{1,64}

--path (string) [required]

The name of the metric data query definition. Use slashes (/ ) to organize definitions into folders, for example team/web/latency . The path must meet the following requirements:

  • It must be unique in your account and Region.
  • It can’t start or end with a slash.
  • It can’t contain an empty folder name (// ).
  • It can be at most 1,015 bytes when encoded as UTF-8.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [\p{L}\p{M}\p{N}\p{P}\p{S}\p{Zs}]+

--expression (string) [required]

The query expression, in the language that Type specifies. CloudWatch doesn’t validate or run the expression when you save it.

Constraints:

  • min: 1
  • max: 65536

--type (string) [required]

The language of the expression. Valid values are the following:

  • PROMQL – A PromQL query.
  • SQL – A CloudWatch Metrics Insights query.
  • METRIC_MATH – A metric math expression.

Possible values:

  • PROMQL
  • SQL
  • METRIC_MATH

--tags (list)

A list of key-value pairs to associate with the metric data query definition. You can use tags to categorize definitions and to control access to them. Tags are applied only when the request creates a definition, that is, when you omit Id . To change the tags of an existing definition, use TagResource and UntagResource .

(structure)

A key-value pair associated with a CloudWatch resource.

Key -> (string) [required]

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

Constraints:

  • min: 1
  • max: 128

Value -> (string) [required]

The value for the specified tag key.

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

Id -> (string)

The ID of the metric data query definition.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9-]{1,64}

Arn -> (string)

The Amazon Resource Name (ARN) of the metric data query definition.

Constraints:

  • min: 1
  • max: 1024

Path -> (string)

The path of the metric data query definition.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [\p{L}\p{M}\p{N}\p{P}\p{S}\p{Zs}]+

Expression -> (string)

The query expression.

Constraints:

  • min: 1
  • max: 65536

Type -> (string)

The language of the expression.

Possible values:

  • PROMQL
  • SQL
  • METRIC_MATH

CreatedAt -> (timestamp)

The date and time when you created the metric data query definition.

UpdatedAt -> (timestamp)

The date and time when you last updated the metric data query definition.
© Copyright 2026, Amazon Web Services. Created using Sphinx.