Create Metric Set

lookoutmetrics_create_metric_set

R Documentation

Creates a dataset

Description

Creates a dataset.

Usage

lookoutmetrics_create_metric_set(AnomalyDetectorArn, MetricSetName,
  MetricSetDescription, MetricList, Offset, TimestampColumn,
  DimensionList, MetricSetFrequency, MetricSource, Timezone, Tags,
  DimensionFilterList)

Arguments

AnomalyDetectorArn

[required] The ARN of the anomaly detector that will use the dataset.

MetricSetName

[required] The name of the dataset.

MetricSetDescription

A description of the dataset you are creating.

MetricList

[required] A list of metrics that the dataset will contain.

Offset

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.

TimestampColumn

Contains information about the column used for tracking time in your source data.

DimensionList

A list of the fields you want to treat as dimensions.

MetricSetFrequency

The frequency with which the source data will be analyzed for anomalies.

MetricSource

[required] Contains information about how the source data should be interpreted.

Timezone

The time zone in which your source data was recorded.

Tags

A list of tags to apply to the dataset.

DimensionFilterList

A list of filters that specify which data is kept for anomaly detection.

Value

A list with the following syntax:

list(
  MetricSetArn = "string"
)

Request syntax

svc$create_metric_set(
  AnomalyDetectorArn = "string",
  MetricSetName = "string",
  MetricSetDescription = "string",
  MetricList = list(
    list(
      MetricName = "string",
      AggregationFunction = "AVG"|"SUM",
      Namespace = "string"
    )
  ),
  Offset = 123,
  TimestampColumn = list(
    ColumnName = "string",
    ColumnFormat = "string"
  ),
  DimensionList = list(
    "string"
  ),
  MetricSetFrequency = "P1D"|"PT1H"|"PT10M"|"PT5M",
  MetricSource = list(
    S3SourceConfig = list(
      RoleArn = "string",
      TemplatedPathList = list(
        "string"
      ),
      HistoricalDataPathList = list(
        "string"
      ),
      FileFormatDescriptor = list(
        CsvFormatDescriptor = list(
          FileCompression = "NONE"|"GZIP",
          Charset = "string",
          ContainsHeader = TRUE|FALSE,
          Delimiter = "string",
          HeaderList = list(
            "string"
          ),
          QuoteSymbol = "string"
        ),
        JsonFormatDescriptor = list(
          FileCompression = "NONE"|"GZIP",
          Charset = "string"
        )
      )
    ),
    AppFlowConfig = list(
      RoleArn = "string",
      FlowName = "string"
    ),
    CloudWatchConfig = list(
      RoleArn = "string",
      BackTestConfiguration = list(
        RunBackTestMode = TRUE|FALSE
      )
    ),
    RDSSourceConfig = list(
      DBInstanceIdentifier = "string",
      DatabaseHost = "string",
      DatabasePort = 123,
      SecretManagerArn = "string",
      DatabaseName = "string",
      TableName = "string",
      RoleArn = "string",
      VpcConfiguration = list(
        SubnetIdList = list(
          "string"
        ),
        SecurityGroupIdList = list(
          "string"
        )
      )
    ),
    RedshiftSourceConfig = list(
      ClusterIdentifier = "string",
      DatabaseHost = "string",
      DatabasePort = 123,
      SecretManagerArn = "string",
      DatabaseName = "string",
      TableName = "string",
      RoleArn = "string",
      VpcConfiguration = list(
        SubnetIdList = list(
          "string"
        ),
        SecurityGroupIdList = list(
          "string"
        )
      )
    ),
    AthenaSourceConfig = list(
      RoleArn = "string",
      DatabaseName = "string",
      DataCatalog = "string",
      TableName = "string",
      WorkGroupName = "string",
      S3ResultsPath = "string",
      BackTestConfiguration = list(
        RunBackTestMode = TRUE|FALSE
      )
    )
  ),
  Timezone = "string",
  Tags = list(
    "string"
  ),
  DimensionFilterList = list(
    list(
      Name = "string",
      FilterList = list(
        list(
          DimensionValue = "string",
          FilterOperation = "EQUALS"
        )
      )
    )
  )
)