AWS CLI Command Reference

[ aws . cloudwatch ]

update-otel-enrichment

Description

Replaces the filters that determine which CloudWatch vended metrics are enriched with resource ARN and resource tag labels for the account. Enrichment must already be running for the account. If it is not, this operation returns a ResourceNotFoundException . To start enrichment, use StartOTelEnrichment .

The filters in the request completely replace the stored filters; they are not merged with them. IncludeFilters and ExcludeFilters are replaced as a pair, so a request that specifies only IncludeFilters also clears the stored ExcludeFilters , and a request that specifies neither clears both.

See also: AWS API Documentation

Synopsis

  update-otel-enrichment
[--include-filters <value>]
[--exclude-filters <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>]

Options

--include-filters (list)

The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope.

A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.

Constraints:

  • min: 0
  • max: 100

(structure)

Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment .

A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.

Namespace -> (string) [required]

The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.

Constraints:

  • min: 1
  • max: 255
  • pattern: [^:].*

MetricNames -> (list)

The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.

A maximum of 100 metric names is allowed for each selector.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 255

Shorthand Syntax:

Namespace=string,MetricNames=string,string ...

JSON Syntax:

[
  {
    "Namespace": "string",
    "MetricNames": ["string", ...]
  }
  ...
]

--exclude-filters (list)

The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded.

Amazon CloudWatch applies ExcludeFilters after IncludeFilters , so a metric that both parameters match is not enriched.

A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.

Constraints:

  • min: 0
  • max: 100

(structure)

Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment .

A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.

Namespace -> (string) [required]

The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.

Constraints:

  • min: 1
  • max: 255
  • pattern: [^:].*

MetricNames -> (list)

The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.

A maximum of 100 metric names is allowed for each selector.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 255

Shorthand Syntax:

Namespace=string,MetricNames=string,string ...

JSON Syntax:

[
  {
    "Namespace": "string",
    "MetricNames": ["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

Output

IncludeFilters -> (list)

The include filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the include filters, which means that every supported namespace is in scope.

Constraints:

  • min: 0
  • max: 100

(structure)

Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment .

A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.

Namespace -> (string) [required]

The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.

Constraints:

  • min: 1
  • max: 255
  • pattern: [^:].*

MetricNames -> (list)

The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.

A maximum of 100 metric names is allowed for each selector.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 255

ExcludeFilters -> (list)

The exclude filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the exclude filters, which means that nothing is excluded.

Constraints:

  • min: 0
  • max: 100

(structure)

Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment .

A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.

Namespace -> (string) [required]

The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.

Constraints:

  • min: 1
  • max: 255
  • pattern: [^:].*

MetricNames -> (list)

The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.

A maximum of 100 metric names is allowed for each selector.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 1
  • max: 255

CreatedAt -> (timestamp)

The date and time that enrichment started for the account.

UpdatedAt -> (timestamp)

The date and time that the enrichment configuration for the account was last stored.
© Copyright 2026, Amazon Web Services. Created using Sphinx.