---
title: Preview AWS metric name filter
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > API Reference > AWS Integration
---

> For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt).

# Preview AWS metric name filter{% #preview-aws-metric-name-filter %}
Copy pageCopied
{% tab title="v2" %}
**Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
| Datadog site      | API endpoint                                                                                                          |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview |
| ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview |
| app.datadoghq.eu  | POST https://api.datadoghq.eu/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview      |
| app.ddog-gov.com  | POST https://api.ddog-gov.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview      |
| us2.ddog-gov.com  | POST https://api.us2.ddog-gov.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview  |
| uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview |
| app.datadoghq.com | POST https://api.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview     |
| us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview |
| us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview |

### Overview

Preview which collected CloudWatch metrics would be filtered by the supplied metric name filters. The filters are not persisted. This endpoint requires the `aws_configuration_read` permission.

### Arguments

#### Path Parameters

| Name                                    | Type   | Description                                                                                                                                                                                                                                                 |
| --------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| aws_account_config_id [*required*] | string | Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration.md#list-all-aws-integrations) endpoint and query by AWS Account ID. |

### Request

#### Body Data (required)

The metric name filters to preview.

{% tab title="Model" %}

| Parent field        | Field                                 | Type            | Description                                                                                            |
| ------------------- | ------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------ |
|                     | data [*required*]                | object          | AWS metric name filter preview request data.                                                           |
| data                | attributes [*required*]          | object          | AWS metric name filter preview request attributes.                                                     |
| attributes          | metric_name_filters [*required*] | [ <oneOf>] | The metric name filters to preview.                                                                    |
| metric_name_filters | Object 1                              | object          | Include only metric names matching one of these patterns for a single namespace.                       |
| Object 1            | include_only [*required*]        | [string]        | Include only metric names matching one of these patterns.                                              |
| Object 1            | namespace [*required*]           | string          | The AWS CloudWatch namespace to which this metric name filter applies.                                 |
| metric_name_filters | Object 2                              | object          | Exclude metric names matching one of these patterns for a single namespace.                            |
| Object 2            | exclude_only [*required*]        | [string]        | Exclude metric names matching one of these patterns.                                                   |
| Object 2            | namespace [*required*]           | string          | The AWS CloudWatch namespace to which this metric name filter applies.                                 |
| data                | type [*required*]                | enum            | The `AWSMetricNameFilterPreviewResponseData` `type`. Allowed enum values: `metric_name_filter_preview` |

{% /tab %}

{% tab title="Example" %}

```json
{
  "data": {
    "attributes": {
      "metric_name_filters": [
        {
          "include_only": [
            "aws.ec2.network_in"
          ],
          "namespace": "AWS/EC2"
        }
      ]
    },
    "type": "metric_name_filter_preview"
  }
}
```

{% /tab %}

### Response

{% tab title="200" %}
AWS metric name filter preview result
{% tab title="Model" %}
AWS metric name filter preview response body.

| Parent field | Field                         | Type     | Description                                                                                                                                                                                                                                                 |
| ------------ | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|              | data [*required*]        | object   | AWS metric name filter preview response data.                                                                                                                                                                                                               |
| data         | attributes [*required*]  | object   | AWS metric name filter preview response attributes.                                                                                                                                                                                                         |
| attributes   | namespaces [*required*]  | [object] | The list of namespaces affected by the previewed metric name filters.                                                                                                                                                                                       |
| namespaces   | filters [*required*]     | [object] | The metric name filter patterns evaluated for this namespace and how many metrics they matched.                                                                                                                                                             |
| filters      | match_count [*required*] | int64    | The number of Datadog metric names matched by this pattern.                                                                                                                                                                                                 |
| filters      | pattern [*required*]     | string   | The metric name filter pattern.                                                                                                                                                                                                                             |
| namespaces   | metrics [*required*]     | [object] | The CloudWatch metrics collected for this namespace and whether each resulting Datadog metric is filtered.                                                                                                                                                  |
| metrics      | cw_name [*required*]     | string   | The CloudWatch metric name.                                                                                                                                                                                                                                 |
| metrics      | dd_names [*required*]    | [object] | The Datadog metric names produced from this CloudWatch metric.                                                                                                                                                                                              |
| dd_names     | filtered [*required*]    | boolean  | Whether this Datadog metric name is filtered out.                                                                                                                                                                                                           |
| dd_names     | name [*required*]        | string   | The Datadog metric name.                                                                                                                                                                                                                                    |
| namespaces   | namespace [*required*]   | string   | The AWS CloudWatch namespace.                                                                                                                                                                                                                               |
| data         | id [*required*]          | string   | Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration.md#list-all-aws-integrations) endpoint and query by AWS Account ID. |
| data         | type [*required*]        | enum     | The `AWSMetricNameFilterPreviewResponseData` `type`. Allowed enum values: `metric_name_filter_preview`                                                                                                                                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "data": {
    "attributes": {
      "namespaces": [
        {
          "filters": [
            {
              "match_count": 1,
              "pattern": "aws.ec2.network_in"
            }
          ],
          "metrics": [
            {
              "cw_name": "NetworkIn",
              "dd_names": [
                {
                  "filtered": true,
                  "name": "aws.ec2.network_in"
                }
              ]
            }
          ],
          "namespace": "AWS/EC2"
        }
      ]
    },
    "id": "00000000-abcd-0001-0000-000000000000",
    "type": "metric_name_filter_preview"
  }
}
```

{% /tab %}

{% /tab %}

{% tab title="400" %}
Bad Request
{% tab title="Model" %}
API error response.

| Parent field | Field                    | Type     | Description                                                                     |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- |
|              | errors [*required*] | [object] | A list of errors.                                                               |
| errors       | detail                   | string   | A human-readable explanation specific to this occurrence of the error.          |
| errors       | meta                     | object   | Non-standard meta-information about the error                                   |
| errors       | source                   | object   | References to the source of the error.                                          |
| source       | header                   | string   | A string indicating the name of a single request header which caused the error. |
| source       | parameter                | string   | A string indicating which URI query parameter caused the error.                 |
| source       | pointer                  | string   | A JSON pointer to the value in the request document that caused the error.      |
| errors       | status                   | string   | Status code of the response.                                                    |
| errors       | title                    | string   | Short human-readable summary of the error.                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="403" %}
Forbidden
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="404" %}
Not Found
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="429" %}
Too many requests
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

### Code Example

##### 
                  \## default
# 
 \# Path parameters export aws_account_config_id="CHANGE_ME" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/integration/aws/accounts/${aws_account_config_id}/metric_name_filter_preview" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "metric_name_filters": [
        {
          "exclude_only": [
            "aws.ec2.network_in"
          ],
          "namespace": "AWS/EC2"
        }
      ]
    },
    "type": "metric_name_filter_preview"
  }
}
EOF 
                
##### 

```python
"""
Preview AWS metric name filter returns "AWS metric name filter preview result" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.aws_integration_api import AWSIntegrationApi
from datadog_api_client.v2.model.aws_metric_name_filter_preview_request import AWSMetricNameFilterPreviewRequest
from datadog_api_client.v2.model.aws_metric_name_filter_preview_request_attributes import (
    AWSMetricNameFilterPreviewRequestAttributes,
)
from datadog_api_client.v2.model.aws_metric_name_filter_preview_request_data import (
    AWSMetricNameFilterPreviewRequestData,
)
from datadog_api_client.v2.model.aws_metric_name_filter_preview_type import AWSMetricNameFilterPreviewType
from datadog_api_client.v2.model.aws_metric_name_filters_include_only import AWSMetricNameFiltersIncludeOnly

body = AWSMetricNameFilterPreviewRequest(
    data=AWSMetricNameFilterPreviewRequestData(
        attributes=AWSMetricNameFilterPreviewRequestAttributes(
            metric_name_filters=[
                AWSMetricNameFiltersIncludeOnly(
                    include_only=[
                        "aws.ec2.network_in",
                    ],
                    namespace="AWS/EC2",
                ),
            ],
        ),
        type=AWSMetricNameFilterPreviewType.METRIC_NAME_FILTER_PREVIEW,
    ),
)

configuration = Configuration()
configuration.unstable_operations["preview_aws_metric_name_filter"] = True
with ApiClient(configuration) as api_client:
    api_instance = AWSIntegrationApi(api_client)
    response = api_instance.preview_aws_metric_name_filter(aws_account_config_id="aws_account_config_id", body=body)

    print(response)
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
##### 

```ruby
# Preview AWS metric name filter returns "AWS metric name filter preview result" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.preview_aws_metric_name_filter".to_sym] = true
end
api_instance = DatadogAPIClient::V2::AWSIntegrationAPI.new

body = DatadogAPIClient::V2::AWSMetricNameFilterPreviewRequest.new({
  data: DatadogAPIClient::V2::AWSMetricNameFilterPreviewRequestData.new({
    attributes: DatadogAPIClient::V2::AWSMetricNameFilterPreviewRequestAttributes.new({
      metric_name_filters: [
        DatadogAPIClient::V2::AWSMetricNameFiltersIncludeOnly.new({
          include_only: [
            "aws.ec2.network_in",
          ],
          namespace: "AWS/EC2",
        }),
      ],
    }),
    type: DatadogAPIClient::V2::AWSMetricNameFilterPreviewType::METRIC_NAME_FILTER_PREVIEW,
  }),
})
p api_instance.preview_aws_metric_name_filter("aws_account_config_id", body)
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
##### 

```go
// Preview AWS metric name filter returns "AWS metric name filter preview result" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.AWSMetricNameFilterPreviewRequest{
		Data: datadogV2.AWSMetricNameFilterPreviewRequestData{
			Attributes: datadogV2.AWSMetricNameFilterPreviewRequestAttributes{
				MetricNameFilters: []datadogV2.AWSMetricNameFilters{
					datadogV2.AWSMetricNameFilters{
						AWSMetricNameFiltersIncludeOnly: &datadogV2.AWSMetricNameFiltersIncludeOnly{
							IncludeOnly: []string{
								"aws.ec2.network_in",
							},
							Namespace: "AWS/EC2",
						}},
				},
			},
			Type: datadogV2.AWSMETRICNAMEFILTERPREVIEWTYPE_METRIC_NAME_FILTER_PREVIEW,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.PreviewAWSMetricNameFilter", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewAWSIntegrationApi(apiClient)
	resp, r, err := api.PreviewAWSMetricNameFilter(ctx, "aws_account_config_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AWSIntegrationApi.PreviewAWSMetricNameFilter`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `AWSIntegrationApi.PreviewAWSMetricNameFilter`:\n%s\n", responseContent)
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
##### 

```java
// Preview AWS metric name filter returns "AWS metric name filter preview result" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AwsIntegrationApi;
import com.datadog.api.client.v2.model.AWSMetricNameFilterPreviewRequest;
import com.datadog.api.client.v2.model.AWSMetricNameFilterPreviewRequestAttributes;
import com.datadog.api.client.v2.model.AWSMetricNameFilterPreviewRequestData;
import com.datadog.api.client.v2.model.AWSMetricNameFilterPreviewResponse;
import com.datadog.api.client.v2.model.AWSMetricNameFilterPreviewType;
import com.datadog.api.client.v2.model.AWSMetricNameFilters;
import com.datadog.api.client.v2.model.AWSMetricNameFiltersIncludeOnly;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.previewAWSMetricNameFilter", true);
    AwsIntegrationApi apiInstance = new AwsIntegrationApi(defaultClient);

    AWSMetricNameFilterPreviewRequest body =
        new AWSMetricNameFilterPreviewRequest()
            .data(
                new AWSMetricNameFilterPreviewRequestData()
                    .attributes(
                        new AWSMetricNameFilterPreviewRequestAttributes()
                            .metricNameFilters(
                                Collections.singletonList(
                                    new AWSMetricNameFilters(
                                        new AWSMetricNameFiltersIncludeOnly()
                                            .includeOnly(
                                                Collections.singletonList("aws.ec2.network_in"))
                                            .namespace("AWS/EC2")))))
                    .type(AWSMetricNameFilterPreviewType.METRIC_NAME_FILTER_PREVIEW));

    try {
      AWSMetricNameFilterPreviewResponse result =
          apiInstance.previewAWSMetricNameFilter("aws_account_config_id", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AwsIntegrationApi#previewAWSMetricNameFilter");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
##### 

```rust
// Preview AWS metric name filter returns "AWS metric name filter preview result"
// response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_aws_integration::AWSIntegrationAPI;
use datadog_api_client::datadogV2::model::AWSMetricNameFilterPreviewRequest;
use datadog_api_client::datadogV2::model::AWSMetricNameFilterPreviewRequestAttributes;
use datadog_api_client::datadogV2::model::AWSMetricNameFilterPreviewRequestData;
use datadog_api_client::datadogV2::model::AWSMetricNameFilterPreviewType;
use datadog_api_client::datadogV2::model::AWSMetricNameFilters;
use datadog_api_client::datadogV2::model::AWSMetricNameFiltersIncludeOnly;

#[tokio::main]
async fn main() {
    let body = AWSMetricNameFilterPreviewRequest::new(AWSMetricNameFilterPreviewRequestData::new(
        AWSMetricNameFilterPreviewRequestAttributes::new(vec![
            AWSMetricNameFilters::AWSMetricNameFiltersIncludeOnly(Box::new(
                AWSMetricNameFiltersIncludeOnly::new(
                    vec!["aws.ec2.network_in".to_string()],
                    "AWS/EC2".to_string(),
                ),
            )),
        ]),
        AWSMetricNameFilterPreviewType::METRIC_NAME_FILTER_PREVIEW,
    ));
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.PreviewAWSMetricNameFilter", true);
    let api = AWSIntegrationAPI::with_config(configuration);
    let resp = api
        .preview_aws_metric_name_filter("aws_account_config_id".to_string(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
##### 

```typescript
/**
 * Preview AWS metric name filter returns "AWS metric name filter preview result" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.previewAWSMetricNameFilter"] = true;
const apiInstance = new v2.AWSIntegrationApi(configuration);

const params: v2.AWSIntegrationApiPreviewAWSMetricNameFilterRequest = {
  body: {
    data: {
      attributes: {
        metricNameFilters: [
          {
            includeOnly: ["aws.ec2.network_in"],
            namespace: "AWS/EC2",
          },
        ],
      },
      type: "metric_name_filter_preview",
    },
  },
  awsAccountConfigId: "aws_account_config_id",
};

apiInstance
  .previewAWSMetricNameFilter(params)
  .then((data: v2.AWSMetricNameFilterPreviewResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
{% /tab %}