CloudWatch / Client / get_otel_enrichment

get_otel_enrichment¶

CloudWatch.Client.get_otel_enrichment()¶

Returns the current status of vended metric enrichment for the account, including whether CloudWatch vended metrics are enriched with resource ARN and resource tag labels and queryable using PromQL. For the list of supported resources, see Supported Amazon Web Services infrastructure metrics.

Request Syntax

response = client.get_otel_enrichment()

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Status (string) –
  
  The status of OTel enrichment for the account. Valid values are Running (enrichment is enabled) and Stopped (enrichment is disabled).
- IncludeFilters (list) –
  
  The metric namespaces, and the metric names, that are enriched. This parameter is omitted when enrichment is stopped, and when enrichment is running with no 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 metric namespaces, and the metric names, that are left unenriched. This parameter is omitted when enrichment is stopped, and when enrichment is running with no 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. This parameter is omitted when enrichment is stopped.
- UpdatedAt (datetime) –
  
  The date and time that the enrichment configuration for the account was last stored.