---
title: "POST /DescribeMetricSet"
method: POST
path: "/DescribeMetricSet"
---

# POST /DescribeMetricSet

`POST /DescribeMetricSet`

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

## Request body

- object
  - `MetricSetArn` string, required — The ARN of the dataset.

## Response `200`

Success

- DescribeMetricSetResponse
  - `MetricSetArn` string — The ARN of the dataset.
  - `AnomalyDetectorArn` string — The ARN of the detector that contains the dataset.
  - `MetricSetName` string — The name of the dataset.
  - `MetricSetDescription` string — The dataset's description.
  - `CreationTime` string, date-time — The time at which the dataset was created.
  - `LastModificationTime` string, date-time — The time at which the dataset was last modified.
  - `Offset` integer — After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
  - `MetricList` Metric[] — A list of the metrics defined by the dataset.
    - `MetricName` string, required — The name of the metric.
    - `AggregationFunction` 'AVG' | 'SUM', required — The function with which the metric is calculated.
    - `Namespace` string — The namespace for the metric.
  - `TimestampColumn` object — Contains information about the column used for tracking time in your source data.
    - `ColumnName` string — The name of the timestamp column.
    - `ColumnFormat` string — The format of the timestamp column.
  - `DimensionList` ColumnName[] — A list of the dimensions chosen for analysis.
  - `MetricSetFrequency` 'P1D' | 'PT1H' | 'PT10M' | 'PT5M' — The interval at which the data will be analyzed for anomalies.
  - `Timezone` string — The time zone in which the dataset's data was recorded.
  - `MetricSource` object — Contains information about the dataset's source data.
    - `S3SourceConfig` S3SourceConfig — Contains information about the configuration of the S3 bucket that contains source files.
      - `RoleArn` string — The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
      - `TemplatedPathList` TemplatedPath[] — A list of templated paths to the source files.
      - `HistoricalDataPathList` HistoricalDataPath[] — A list of paths to the historical data files.
      - `FileFormatDescriptor` object — Contains information about a source file's formatting.
        - `CsvFormatDescriptor` object — Contains information about how a source CSV data file should be analyzed.
          - `FileCompression` 'NONE' | 'GZIP' — The level of compression of the source CSV file.
          - `Charset` string — The character set in which the source CSV file is written.
          - `ContainsHeader` boolean — Whether or not the source CSV file contains a header.
          - `Delimiter` string — The character used to delimit the source CSV file.
          - `HeaderList` ColumnName[] — A list of the source CSV file's headers, if any.
          - `QuoteSymbol` string — The character used as a quote character.
        - `JsonFormatDescriptor` object — Contains information about how a source JSON data file should be analyzed.
          - `FileCompression` 'NONE' | 'GZIP' — The level of compression of the source CSV file.
          - `Charset` string — The character set in which the source JSON file is written.
    - `AppFlowConfig` object — Details about an AppFlow datasource.
      - `RoleArn` string — An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
      - `FlowName` string — name of the flow.
    - `CloudWatchConfig` object — Details about an Amazon CloudWatch monitoring datasource.
      - `RoleArn` string — An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
      - `BackTestConfiguration` object — Settings for backtest mode.
        - `RunBackTestMode` boolean, required — Run a backtest instead of monitoring new data.
    - `RDSSourceConfig` object — Details about an Amazon Relational Database Service (RDS) datasource.
      - `DBInstanceIdentifier` string — A string identifying the database instance.
      - `DatabaseHost` string — The host name of the database.
      - `DatabasePort` integer — The port number where the database can be accessed.
      - `SecretManagerArn` string — The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
      - `DatabaseName` string — The name of the RDS database.
      - `TableName` string — The name of the table in the database.
      - `RoleArn` string — The Amazon Resource Name (ARN) of the role.
      - `VpcConfiguration` object — An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
        - `SubnetIdList` SubnetId[], required — An array of strings containing the Amazon VPC subnet IDs (e.g., <code>subnet-0bb1c79de3EXAMPLE</code>.
        - `SecurityGroupIdList` SecurityGroupId[], required — An array of strings containing the list of security groups.
    - `RedshiftSourceConfig` object — Details about an Amazon Redshift database datasource.
      - `ClusterIdentifier` string — A string identifying the Redshift cluster.
      - `DatabaseHost` string — The name of the database host.
      - `DatabasePort` integer — The port number where the database can be accessed.
      - `SecretManagerArn` string — The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
      - `DatabaseName` string — The Redshift database name.
      - `TableName` string — The table name of the Redshift database.
      - `RoleArn` string — The Amazon Resource Name (ARN) of the role providing access to the database.
      - `VpcConfiguration` object — Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
        - `SubnetIdList` SubnetId[], required — An array of strings containing the Amazon VPC subnet IDs (e.g., <code>subnet-0bb1c79de3EXAMPLE</code>.
        - `SecurityGroupIdList` SecurityGroupId[], required — An array of strings containing the list of security groups.
    - `AthenaSourceConfig` object — Details about an Amazon Athena datasource.
      - `RoleArn` string — An IAM role that gives Amazon Lookout for Metrics permission to access the data.
      - `DatabaseName` string — The database's name.
      - `DataCatalog` string — The database's data catalog.
      - `TableName` string — The database's table name.
      - `WorkGroupName` string — The database's work group name.
      - `S3ResultsPath` string — The database's results path.
      - `BackTestConfiguration` object — Settings for backtest mode.
        - `RunBackTestMode` boolean, required — Run a backtest instead of monitoring new data.
  - `DimensionFilterList` MetricSetDimensionFilter[] — The dimensions and their values that were used to filter the dataset.
    - `Name` string — The dimension that you want to filter on.
    - `FilterList` Filter[] — The list of filters that you are applying.
      - `DimensionValue` string — The value that you want to include in the filter.
      - `FilterOperation` 'EQUALS' — The condition to apply.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ValidationException
- `482` — AccessDeniedException
- `483` — TooManyRequestsException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lookoutmetrics.md) · [All operations](https://skmtc.net/aws/apis/lookoutmetrics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lookoutmetrics/versions/aace1e573660/schema)