CloudWatch / Client / update_otel_enrichment

update_otel_enrichment

CloudWatch.Client.update_otel_enrichment(**kwargs)

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

Request Syntax

response = client.update_otel_enrichment(
    IncludeFilters=[
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    ExcludeFilters=[
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ]
)
Parameters:

  • IncludeFilters (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.

    • (dict) –

      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.

      • 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.

        • (string) –

  • ExcludeFilters (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.

    • (dict) –

      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.

      • 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.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IncludeFilters': [
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    'ExcludeFilters': [
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • 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.

      • (dict) –

        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) –

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

        • 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.

          • (string) –

    • 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.

      • (dict) –

        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) –

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

        • 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.

          • (string) –

    • CreatedAt (datetime) –

      The date and time that enrichment started for the account.

    • UpdatedAt (datetime) –

      The date and time that the enrichment configuration for the account was last stored.

Exceptions