Class: AWS.LookoutMetrics

var params = {
  AnomalyDetectorArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.backTestAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Action: { /* required */
    LambdaConfiguration: {
      LambdaArn: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE' /* required */
    },
    SNSConfiguration: {
      RoleArn: 'STRING_VALUE', /* required */
      SnsTopicArn: 'STRING_VALUE', /* required */
      SnsFormat: LONG_TEXT | SHORT_TEXT | JSON
    }
  },
  AlertName: 'STRING_VALUE', /* required */
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AlertDescription: 'STRING_VALUE',
  AlertFilters: {
    DimensionFilterList: [
      {
        DimensionName: 'STRING_VALUE',
        DimensionValueList: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    MetricList: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  AlertSensitivityThreshold: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lookoutmetrics.createAlert(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AlertName — (String)

    The name of the alert.

  • AlertSensitivityThreshold — (Integer)

    An integer from 0 to 100 specifying the alert sensitivity threshold.

  • AlertDescription — (String)

    A description of the alert.

  • AnomalyDetectorArn — (String)

    The ARN of the detector to which the alert is attached.

  • Action — (map)

    Action that will be triggered when there is an alert.

    • SNSConfiguration — (map)

      A configuration for an Amazon SNS channel.

      • RoleArn — required — (String)

        The ARN of the IAM role that has access to the target SNS topic.

      • SnsTopicArn — required — (String)

        The ARN of the target SNS topic.

      • SnsFormat — (String)

        The format of the SNS topic.

        • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

        • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

        • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

        Possible values include:
        • "LONG_TEXT"
        • "SHORT_TEXT"
        • "JSON"
    • LambdaConfiguration — (map)

      A configuration for an AWS Lambda channel.

      • RoleArn — required — (String)

        The ARN of an IAM role that has permission to invoke the Lambda function.

      • LambdaArn — required — (String)

        The ARN of the Lambda function.

  • Tags — (map<String>)

    A list of tags to apply to the alert.

  • AlertFilters — (map)

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    • MetricList — (Array<String>)

      The list of measures that you want to get alerts for.

    • DimensionFilterList — (Array<map>)

      The list of DimensionFilter objects that are used for dimension-based filtering.

      • DimensionName — (String)

        The name of the dimension to filter on.

      • DimensionValueList — (Array<String>)

        The list of values for the dimension specified in DimensionName that you want to filter on.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AlertArn — (String)

      The ARN of the alert.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorConfig: { /* required */
    AnomalyDetectorFrequency: P1D | PT1H | PT10M | PT5M
  },
  AnomalyDetectorName: 'STRING_VALUE', /* required */
  AnomalyDetectorDescription: 'STRING_VALUE',
  KmsKeyArn: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lookoutmetrics.createAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorName — (String)

    The name of the detector.

  • AnomalyDetectorDescription — (String)

    A description of the detector.

  • AnomalyDetectorConfig — (map)

    Contains information about the configuration of the anomaly detector.

    • AnomalyDetectorFrequency — (String)

      The frequency at which the detector analyzes its source data.

      Possible values include:
      • "P1D"
      • "PT1H"
      • "PT10M"
      • "PT5M"
  • KmsKeyArn — (String)

    The ARN of the KMS key to use to encrypt your data.

  • Tags — (map<String>)

    A list of tags to apply to the anomaly detector.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyDetectorArn — (String)

      The ARN of the detector.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  MetricList: [ /* required */
    {
      AggregationFunction: AVG | SUM, /* required */
      MetricName: 'STRING_VALUE', /* required */
      Namespace: 'STRING_VALUE'
    },
    /* more items */
  ],
  MetricSetName: 'STRING_VALUE', /* required */
  MetricSource: { /* required */
    AppFlowConfig: {
      FlowName: 'STRING_VALUE',
      RoleArn: 'STRING_VALUE'
    },
    AthenaSourceConfig: {
      BackTestConfiguration: {
        RunBackTestMode: true || false /* required */
      },
      DataCatalog: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      RoleArn: 'STRING_VALUE',
      S3ResultsPath: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      WorkGroupName: 'STRING_VALUE'
    },
    CloudWatchConfig: {
      BackTestConfiguration: {
        RunBackTestMode: true || false /* required */
      },
      RoleArn: 'STRING_VALUE'
    },
    RDSSourceConfig: {
      DBInstanceIdentifier: 'STRING_VALUE',
      DatabaseHost: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      DatabasePort: 'NUMBER_VALUE',
      RoleArn: 'STRING_VALUE',
      SecretManagerArn: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      VpcConfiguration: {
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    RedshiftSourceConfig: {
      ClusterIdentifier: 'STRING_VALUE',
      DatabaseHost: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      DatabasePort: 'NUMBER_VALUE',
      RoleArn: 'STRING_VALUE',
      SecretManagerArn: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      VpcConfiguration: {
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    S3SourceConfig: {
      FileFormatDescriptor: {
        CsvFormatDescriptor: {
          Charset: 'STRING_VALUE',
          ContainsHeader: true || false,
          Delimiter: 'STRING_VALUE',
          FileCompression: NONE | GZIP,
          HeaderList: [
            'STRING_VALUE',
            /* more items */
          ],
          QuoteSymbol: 'STRING_VALUE'
        },
        JsonFormatDescriptor: {
          Charset: 'STRING_VALUE',
          FileCompression: NONE | GZIP
        }
      },
      HistoricalDataPathList: [
        'STRING_VALUE',
        /* more items */
      ],
      RoleArn: 'STRING_VALUE',
      TemplatedPathList: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  DimensionFilterList: [
    {
      FilterList: [
        {
          DimensionValue: 'STRING_VALUE',
          FilterOperation: EQUALS
        },
        /* more items */
      ],
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  DimensionList: [
    'STRING_VALUE',
    /* more items */
  ],
  MetricSetDescription: 'STRING_VALUE',
  MetricSetFrequency: P1D | PT1H | PT10M | PT5M,
  Offset: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TimestampColumn: {
    ColumnFormat: 'STRING_VALUE',
    ColumnName: 'STRING_VALUE'
  },
  Timezone: 'STRING_VALUE'
};
lookoutmetrics.createMetricSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the anomaly detector that will use the dataset.

  • MetricSetName — (String)

    The name of the dataset.

  • MetricSetDescription — (String)

    A description of the dataset you are creating.

  • MetricList — (Array<map>)

    A list of metrics that the dataset will contain.

    • MetricName — required — (String)

      The name of the metric.

    • AggregationFunction — required — (String)

      The function with which the metric is calculated.

      Possible values include:
      • "AVG"
      • "SUM"
    • Namespace — (String)

      The namespace for the metric.

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

  • TimestampColumn — (map)

    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 — (Array<String>)

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

  • MetricSetFrequency — (String)

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

    Possible values include:
    • "P1D"
    • "PT1H"
    • "PT10M"
    • "PT5M"
  • MetricSource — (map)

    Contains information about how the source data should be interpreted.

    • S3SourceConfig — (map)

      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 — (Array<String>)

        A list of templated paths to the source files.

      • HistoricalDataPathList — (Array<String>)

        A list of paths to the historical data files.

      • FileFormatDescriptor — (map)

        Contains information about a source file's formatting.

        • CsvFormatDescriptor — (map)

          Contains information about how a source CSV data file should be analyzed.

          • FileCompression — (String)

            The level of compression of the source CSV file.

            Possible values include:
            • "NONE"
            • "GZIP"
          • 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 — (Array<String>)

            A list of the source CSV file's headers, if any.

          • QuoteSymbol — (String)

            The character used as a quote character.

        • JsonFormatDescriptor — (map)

          Contains information about how a source JSON data file should be analyzed.

          • FileCompression — (String)

            The level of compression of the source CSV file.

            Possible values include:
            • "NONE"
            • "GZIP"
          • Charset — (String)

            The character set in which the source JSON file is written.

    • AppFlowConfig — (map)

      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 — (map)

      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 — (map)

        Settings for backtest mode.

        • RunBackTestMode — required — (Boolean)

          Run a backtest instead of monitoring new data.

    • RDSSourceConfig — (map)

      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 — (map)

        An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList — required — (Array<String>)

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

        • SecurityGroupIdList — required — (Array<String>)

          An array of strings containing the list of security groups.

    • RedshiftSourceConfig — (map)

      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 — (map)

        Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList — required — (Array<String>)

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

        • SecurityGroupIdList — required — (Array<String>)

          An array of strings containing the list of security groups.

    • AthenaSourceConfig — (map)

      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 — (map)

        Settings for backtest mode.

        • RunBackTestMode — required — (Boolean)

          Run a backtest instead of monitoring new data.

  • Timezone — (String)

    The time zone in which your source data was recorded.

  • Tags — (map<String>)

    A list of tags to apply to the dataset.

  • DimensionFilterList — (Array<map>)

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

    • Name — (String)

      The dimension that you want to filter on.

    • FilterList — (Array<map>)

      The list of filters that you are applying.

      • DimensionValue — (String)

        The value that you want to include in the filter.

      • FilterOperation — (String)

        The condition to apply.

        Possible values include:
        • "EQUALS"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MetricSetArn — (String)

      The ARN of the dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.deactivateAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AlertArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.deleteAlert(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AlertArn — (String)

    The ARN of the alert to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.deleteAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the detector to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AlertArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.describeAlert(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AlertArn — (String)

    The ARN of the alert to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Alert — (map)

      Contains information about an alert.

      • Action — (map)

        Action that will be triggered when there is an alert.

        • SNSConfiguration — (map)

          A configuration for an Amazon SNS channel.

          • RoleArn — required — (String)

            The ARN of the IAM role that has access to the target SNS topic.

          • SnsTopicArn — required — (String)

            The ARN of the target SNS topic.

          • SnsFormat — (String)

            The format of the SNS topic.

            • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

            • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

            • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

            Possible values include:
            • "LONG_TEXT"
            • "SHORT_TEXT"
            • "JSON"
        • LambdaConfiguration — (map)

          A configuration for an AWS Lambda channel.

          • RoleArn — required — (String)

            The ARN of an IAM role that has permission to invoke the Lambda function.

          • LambdaArn — required — (String)

            The ARN of the Lambda function.

      • AlertDescription — (String)

        A description of the alert.

      • AlertArn — (String)

        The ARN of the alert.

      • AnomalyDetectorArn — (String)

        The ARN of the detector to which the alert is attached.

      • AlertName — (String)

        The name of the alert.

      • AlertSensitivityThreshold — (Integer)

        The minimum severity for an anomaly to trigger the alert.

      • AlertType — (String)

        The type of the alert.

        Possible values include:
        • "SNS"
        • "LAMBDA"
      • AlertStatus — (String)

        The status of the alert.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • LastModificationTime — (Date)

        The time at which the alert was last modified.

      • CreationTime — (Date)

        The time at which the alert was created.

      • AlertFilters — (map)

        The configuration of the alert filters, containing MetricList and DimensionFilter.

        • MetricList — (Array<String>)

          The list of measures that you want to get alerts for.

        • DimensionFilterList — (Array<map>)

          The list of DimensionFilter objects that are used for dimension-based filtering.

          • DimensionName — (String)

            The name of the dimension to filter on.

          • DimensionValueList — (Array<String>)

            The list of values for the dimension specified in DimensionName that you want to filter on.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Timestamp: 'STRING_VALUE'
};
lookoutmetrics.describeAnomalyDetectionExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • Timestamp — (String)

    The timestamp of the anomaly detection job.

  • MaxResults — (Integer)

    The number of items to return in the response.

  • NextToken — (String)

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ExecutionList — (Array<map>)

      A list of detection jobs.

      • Timestamp — (String)

        The run's timestamp.

      • Status — (String)

        The run's status.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "FAILED_TO_SCHEDULE"
      • FailureReason — (String)

        The reason that the run failed, if applicable.

    • NextToken — (String)

      The pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.describeAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the detector to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyDetectorArn — (String)

      The ARN of the detector.

    • AnomalyDetectorName — (String)

      The name of the detector.

    • AnomalyDetectorDescription — (String)

      A description of the detector.

    • AnomalyDetectorConfig — (map)

      Contains information about the detector's configuration.

      • AnomalyDetectorFrequency — (String)

        The interval at which the detector analyzes its source data.

        Possible values include:
        • "P1D"
        • "PT1H"
        • "PT10M"
        • "PT5M"
    • CreationTime — (Date)

      The time at which the detector was created.

    • LastModificationTime — (Date)

      The time at which the detector was last modified.

    • Status — (String)

      The status of the detector.

      Possible values include:
      • "ACTIVE"
      • "ACTIVATING"
      • "DELETING"
      • "FAILED"
      • "INACTIVE"
      • "LEARNING"
      • "BACK_TEST_ACTIVATING"
      • "BACK_TEST_ACTIVE"
      • "BACK_TEST_COMPLETE"
      • "DEACTIVATED"
      • "DEACTIVATING"
    • FailureReason — (String)

      The reason that the detector failed.

    • KmsKeyArn — (String)

      The ARN of the KMS key to use to encrypt your data.

    • FailureType — (String)

      The process that caused the detector to fail.

      Possible values include:
      • "ACTIVATION_FAILURE"
      • "BACK_TEST_ACTIVATION_FAILURE"
      • "DELETION_FAILURE"
      • "DEACTIVATION_FAILURE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MetricSetArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.describeMetricSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MetricSetArn — (String)

    The ARN of the dataset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Date)

      The time at which the dataset was created.

    • LastModificationTime — (Date)

      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 — (Array<map>)

      A list of the metrics defined by the dataset.

      • MetricName — required — (String)

        The name of the metric.

      • AggregationFunction — required — (String)

        The function with which the metric is calculated.

        Possible values include:
        • "AVG"
        • "SUM"
      • Namespace — (String)

        The namespace for the metric.

    • TimestampColumn — (map)

      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 — (Array<String>)

      A list of the dimensions chosen for analysis.

    • MetricSetFrequency — (String)

      The interval at which the data will be analyzed for anomalies.

      Possible values include:
      • "P1D"
      • "PT1H"
      • "PT10M"
      • "PT5M"
    • Timezone — (String)

      The time zone in which the dataset's data was recorded.

    • MetricSource — (map)

      Contains information about the dataset's source data.

      • S3SourceConfig — (map)

        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 — (Array<String>)

          A list of templated paths to the source files.

        • HistoricalDataPathList — (Array<String>)

          A list of paths to the historical data files.

        • FileFormatDescriptor — (map)

          Contains information about a source file's formatting.

          • CsvFormatDescriptor — (map)

            Contains information about how a source CSV data file should be analyzed.

            • FileCompression — (String)

              The level of compression of the source CSV file.

              Possible values include:
              • "NONE"
              • "GZIP"
            • 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 — (Array<String>)

              A list of the source CSV file's headers, if any.

            • QuoteSymbol — (String)

              The character used as a quote character.

          • JsonFormatDescriptor — (map)

            Contains information about how a source JSON data file should be analyzed.

            • FileCompression — (String)

              The level of compression of the source CSV file.

              Possible values include:
              • "NONE"
              • "GZIP"
            • Charset — (String)

              The character set in which the source JSON file is written.

      • AppFlowConfig — (map)

        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 — (map)

        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 — (map)

          Settings for backtest mode.

          • RunBackTestMode — required — (Boolean)

            Run a backtest instead of monitoring new data.

      • RDSSourceConfig — (map)

        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 — (map)

          An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

          • SubnetIdList — required — (Array<String>)

            An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

          • SecurityGroupIdList — required — (Array<String>)

            An array of strings containing the list of security groups.

      • RedshiftSourceConfig — (map)

        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 — (map)

          Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

          • SubnetIdList — required — (Array<String>)

            An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

          • SecurityGroupIdList — required — (Array<String>)

            An array of strings containing the list of security groups.

      • AthenaSourceConfig — (map)

        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 — (map)

          Settings for backtest mode.

          • RunBackTestMode — required — (Boolean)

            Run a backtest instead of monitoring new data.

    • DimensionFilterList — (Array<map>)

      The dimensions and their values that were used to filter the dataset.

      • Name — (String)

        The dimension that you want to filter on.

      • FilterList — (Array<map>)

        The list of filters that you are applying.

        • DimensionValue — (String)

          The value that you want to include in the filter.

        • FilterOperation — (String)

          The condition to apply.

          Possible values include:
          • "EQUALS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AutoDetectionMetricSource: { /* required */
    S3SourceConfig: {
      HistoricalDataPathList: [
        'STRING_VALUE',
        /* more items */
      ],
      TemplatedPathList: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
lookoutmetrics.detectMetricSetConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    An anomaly detector ARN.

  • AutoDetectionMetricSource — (map)

    A data source.

    • S3SourceConfig — (map)

      The source's source config.

      • TemplatedPathList — (Array<String>)

        The config's templated path list.

      • HistoricalDataPathList — (Array<String>)

        The config's historical data path list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DetectedMetricSetConfig — (map)

      The inferred dataset configuration for the datasource.

      • Offset — (map)

        The dataset's offset.

        • Value — (map)

          The field's value.

          • S — (String)

            A string.

          • N — (String)

            A number.

          • B — (String)

            A binary value.

          • SS — (Array<String>)

            A list of strings.

          • NS — (Array<String>)

            A list of numbers.

          • BS — (Array<String>)

            A list of binary values.

        • Confidence — (String)

          The field's confidence.

          Possible values include:
          • "HIGH"
          • "LOW"
          • "NONE"
        • Message — (String)

          The field's message.

      • MetricSetFrequency — (map)

        The dataset's interval.

        • Value — (map)

          The field's value.

          • S — (String)

            A string.

          • N — (String)

            A number.

          • B — (String)

            A binary value.

          • SS — (Array<String>)

            A list of strings.

          • NS — (Array<String>)

            A list of numbers.

          • BS — (Array<String>)

            A list of binary values.

        • Confidence — (String)

          The field's confidence.

          Possible values include:
          • "HIGH"
          • "LOW"
          • "NONE"
        • Message — (String)

          The field's message.

      • MetricSource — (map)

        The dataset's data source.

        • S3SourceConfig — (map)

          The data source's source configuration.

          • FileFormatDescriptor — (map)

            The source's file format descriptor.

            • CsvFormatDescriptor — (map)

              Details about a CSV format.

              • FileCompression — (map)

                The format's file compression.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • Charset — (map)

                The format's charset.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • ContainsHeader — (map)

                Whether the format includes a header.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • Delimiter — (map)

                The format's delimiter.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • HeaderList — (map)

                The format's header list.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • QuoteSymbol — (map)

                The format's quote symbol.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

            • JsonFormatDescriptor — (map)

              Details about a JSON format.

              • FileCompression — (map)

                The format's file compression.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

              • Charset — (map)

                The format's character set.

                • Value — (map)

                  The field's value.

                  • S — (String)

                    A string.

                  • N — (String)

                    A number.

                  • B — (String)

                    A binary value.

                  • SS — (Array<String>)

                    A list of strings.

                  • NS — (Array<String>)

                    A list of numbers.

                  • BS — (Array<String>)

                    A list of binary values.

                • Confidence — (String)

                  The field's confidence.

                  Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "NONE"
                • Message — (String)

                  The field's message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyGroupId: 'STRING_VALUE' /* required */
};
lookoutmetrics.getAnomalyGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyGroupId — (String)

    The ID of the anomaly group.

  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyGroup — (map)

      Details about the anomaly group.

      • StartTime — (String)

        The start time for the group.

      • EndTime — (String)

        The end time for the group.

      • AnomalyGroupId — (String)

        The ID of the anomaly group.

      • AnomalyGroupScore — (Float)

        The severity score of the group.

      • PrimaryMetricName — (String)

        The name of the primary affected measure for the group.

      • MetricLevelImpactList — (Array<map>)

        A list of measures affected by the anomaly.

        • MetricName — (String)

          The name of the measure.

        • NumTimeSeries — (Integer)

          The number of anomalous metrics for the measure.

        • ContributionMatrix — (map)

          Details about the dimensions that contributed to the anomaly.

          • DimensionContributionList — (Array<map>)

            A list of contributing dimensions.

            • DimensionName — (String)

              The name of the dimension.

            • DimensionValueContributionList — (Array<map>)

              A list of dimension values that contributed to the anomaly.

              • DimensionValue — (String)

                The value of the dimension.

              • ContributionScore — (Float)

                The severity score of the value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  MetricSetArn: 'STRING_VALUE'
};
lookoutmetrics.getDataQualityMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

  • MetricSetArn — (String)

    The Amazon Resource Name (ARN) of a specific data quality metric set.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyDetectorDataQualityMetricList — (Array<map>)

      A list of the data quality metrics for the AnomalyDetectorArn that you requested.

      • StartTimestamp — (Date)

        The start time for the data quality metrics collection.

      • MetricSetDataQualityMetricList — (Array<map>)

        An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.

        • MetricSetArn — (String)

          The Amazon Resource Name (ARN) of the data quality metric array.

        • DataQualityMetricList — (Array<map>)

          The array of data quality metrics contained in the data quality metric set.

          • MetricType — (String)

            The name of the data quality metric.

            Possible values include:
            • "COLUMN_COMPLETENESS"
            • "DIMENSION_UNIQUENESS"
            • "TIME_SERIES_COUNT"
            • "ROWS_PROCESSED"
            • "ROWS_PARTIAL_COMPLIANCE"
            • "INVALID_ROWS_COMPLIANCE"
            • "BACKTEST_TRAINING_DATA_START_TIME_STAMP"
            • "BACKTEST_TRAINING_DATA_END_TIME_STAMP"
            • "BACKTEST_INFERENCE_DATA_START_TIME_STAMP"
            • "BACKTEST_INFERENCE_DATA_END_TIME_STAMP"
          • MetricDescription — (String)

            A description of the data quality metric.

          • RelatedColumnName — (String)

            The column that is being monitored.

          • MetricValue — (Float)

            The value of the data quality metric.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyGroupTimeSeriesFeedback: { /* required */
    AnomalyGroupId: 'STRING_VALUE', /* required */
    TimeSeriesId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.getFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupTimeSeriesFeedback — (map)

    The anomalous metric and group ID.

    • AnomalyGroupId — required — (String)

      The ID of the anomaly group.

    • TimeSeriesId — (String)

      The ID of the metric.

  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyGroupTimeSeriesFeedback — (Array<map>)

      Feedback for an anomalous metric.

      • TimeSeriesId — (String)

        The ID of the metric.

      • IsAnomaly — (Boolean)

        Feedback on whether the metric is a legitimate anomaly.

    • NextToken — (String)

      The pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  S3SourceConfig: {
    FileFormatDescriptor: { /* required */
      CsvFormatDescriptor: {
        Charset: 'STRING_VALUE',
        ContainsHeader: true || false,
        Delimiter: 'STRING_VALUE',
        FileCompression: NONE | GZIP,
        HeaderList: [
          'STRING_VALUE',
          /* more items */
        ],
        QuoteSymbol: 'STRING_VALUE'
      },
      JsonFormatDescriptor: {
        Charset: 'STRING_VALUE',
        FileCompression: NONE | GZIP
      }
    },
    RoleArn: 'STRING_VALUE', /* required */
    HistoricalDataPathList: [
      'STRING_VALUE',
      /* more items */
    ],
    TemplatedPathList: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
lookoutmetrics.getSampleData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • S3SourceConfig — (map)

    A datasource bucket in Amazon S3.

    • RoleArn — required — (String)

      The Amazon Resource Name (ARN) of the role.

    • TemplatedPathList — (Array<String>)

      An array of strings containing the list of templated paths.

    • HistoricalDataPathList — (Array<String>)

      An array of strings containing the historical set of data paths.

    • FileFormatDescriptor — required — (map)

      Contains information about a source file's formatting.

      • CsvFormatDescriptor — (map)

        Contains information about how a source CSV data file should be analyzed.

        • FileCompression — (String)

          The level of compression of the source CSV file.

          Possible values include:
          • "NONE"
          • "GZIP"
        • 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 — (Array<String>)

          A list of the source CSV file's headers, if any.

        • QuoteSymbol — (String)

          The character used as a quote character.

      • JsonFormatDescriptor — (map)

        Contains information about how a source JSON data file should be analyzed.

        • FileCompression — (String)

          The level of compression of the source CSV file.

          Possible values include:
          • "NONE"
          • "GZIP"
        • Charset — (String)

          The character set in which the source JSON file is written.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HeaderValues — (Array<String>)

      A list of header labels for the records.

    • SampleRows — (Array<Array<String>>)

      A list of records.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.listAlerts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the alert's detector.

  • NextToken — (String)

    If the result of the previous request is truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

  • MaxResults — (Integer)

    The maximum number of results that will be displayed by the request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AlertSummaryList — (Array<map>)

      Contains information about an alert.

      • AlertArn — (String)

        The ARN of the alert.

      • AnomalyDetectorArn — (String)

        The ARN of the detector to which the alert is attached.

      • AlertName — (String)

        The name of the alert.

      • AlertSensitivityThreshold — (Integer)

        The minimum severity for an anomaly to trigger the alert.

      • AlertType — (String)

        The type of the alert.

        Possible values include:
        • "SNS"
        • "LAMBDA"
      • AlertStatus — (String)

        The status of the alert.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • LastModificationTime — (Date)

        The time at which the alert was last modified.

      • CreationTime — (Date)

        The time at which the alert was created.

      • Tags — (map<String>)

        The alert's tags.

    • NextToken — (String)

      If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.listAnomalyDetectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyDetectorSummaryList — (Array<map>)

      A list of anomaly detectors in the account in the current region.

      • AnomalyDetectorArn — (String)

        The ARN of the detector.

      • AnomalyDetectorName — (String)

        The name of the detector.

      • AnomalyDetectorDescription — (String)

        A description of the detector.

      • CreationTime — (Date)

        The time at which the detector was created.

      • LastModificationTime — (Date)

        The time at which the detector was last modified.

      • Status — (String)

        The status of detector.

        Possible values include:
        • "ACTIVE"
        • "ACTIVATING"
        • "DELETING"
        • "FAILED"
        • "INACTIVE"
        • "LEARNING"
        • "BACK_TEST_ACTIVATING"
        • "BACK_TEST_ACTIVE"
        • "BACK_TEST_COMPLETE"
        • "DEACTIVATED"
        • "DEACTIVATING"
      • Tags — (map<String>)

        The detector's tags.

    • NextToken — (String)

      If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyGroupId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RelationshipTypeFilter: CAUSE_OF_INPUT_ANOMALY_GROUP | EFFECT_OF_INPUT_ANOMALY_GROUP
};
lookoutmetrics.listAnomalyGroupRelatedMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupId — (String)

    The ID of the anomaly group.

  • RelationshipTypeFilter — (String)

    Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

    Possible values include:
    • "CAUSE_OF_INPUT_ANOMALY_GROUP"
    • "EFFECT_OF_INPUT_ANOMALY_GROUP"
  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InterMetricImpactList — (Array<map>)

      Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

      • MetricName — (String)

        The name of the measure.

      • AnomalyGroupId — (String)

        The ID of the anomaly group.

      • RelationshipType — (String)

        Whether a measure is a potential cause of the anomaly group (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).

        Possible values include:
        • "CAUSE_OF_INPUT_ANOMALY_GROUP"
        • "EFFECT_OF_INPUT_ANOMALY_GROUP"
      • ContributionPercentage — (Float)

        For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies.

    • NextToken — (String)

      The pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  SensitivityThreshold: 'NUMBER_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.listAnomalyGroupSummaries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • SensitivityThreshold — (Integer)

    The minimum severity score for inclusion in the output.

  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyGroupSummaryList — (Array<map>)

      A list of anomaly group summaries.

      • StartTime — (String)

        The start time for the group.

      • EndTime — (String)

        The end time for the group.

      • AnomalyGroupId — (String)

        The ID of the anomaly group.

      • AnomalyGroupScore — (Float)

        The severity score of the group.

      • PrimaryMetricName — (String)

        The name of the primary affected measure for the group.

    • AnomalyGroupStatistics — (map)

      Aggregated details about the anomaly groups.

      • EvaluationStartDate — (String)

        The start of the time range that was searched.

      • TotalCount — (Integer)

        The number of groups found.

      • ItemizedMetricStatsList — (Array<map>)

        Statistics for individual metrics within the group.

        • MetricName — (String)

          The name of the measure.

        • OccurrenceCount — (Integer)

          The number of times that the measure appears.

    • NextToken — (String)

      The pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyGroupId: 'STRING_VALUE', /* required */
  MetricName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.listAnomalyGroupTimeSeries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupId — (String)

    The ID of the anomaly group.

  • MetricName — (String)

    The name of the measure field.

  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyGroupId — (String)

      The ID of the anomaly group.

    • MetricName — (String)

      The name of the measure field.

    • TimestampList — (Array<String>)

      Timestamps for the anomalous metrics.

    • NextToken — (String)

      The pagination token that's included if more results are available.

    • TimeSeriesList — (Array<map>)

      A list of anomalous metrics.

      • TimeSeriesId — required — (String)

        The ID of the metric.

      • DimensionList — required — (Array<map>)

        The dimensions of the metric.

        • DimensionName — required — (String)

          The name of the dimension.

        • DimensionValue — required — (String)

          The value of the dimension.

      • MetricValueList — required — (Array<Float>)

        The values for the metric.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutmetrics.listMetricSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the anomaly detector containing the metrics sets to list.

  • MaxResults — (Integer)

    The maximum number of results to return.

  • NextToken — (String)

    If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MetricSetSummaryList — (Array<map>)

      A list of the datasets in the AWS Region, with configuration details for each.

      • MetricSetArn — (String)

        The ARN of the dataset.

      • AnomalyDetectorArn — (String)

        The ARN of the detector to which the dataset belongs.

      • MetricSetDescription — (String)

        The description of the dataset.

      • MetricSetName — (String)

        The name of the dataset.

      • CreationTime — (Date)

        The time at which the dataset was created.

      • LastModificationTime — (Date)

        The time at which the dataset was last modified.

      • Tags — (map<String>)

        The dataset's tags.

    • NextToken — (String)

      If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The resource's Amazon Resource Name (ARN).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The resource's tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyGroupTimeSeriesFeedback: { /* required */
    AnomalyGroupId: 'STRING_VALUE', /* required */
    IsAnomaly: true || false, /* required */
    TimeSeriesId: 'STRING_VALUE' /* required */
  }
};
lookoutmetrics.putFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupTimeSeriesFeedback — (map)

    Feedback for an anomalous metric.

    • AnomalyGroupId — required — (String)

      The ID of the anomaly group.

    • TimeSeriesId — required — (String)

      The ID of the metric.

    • IsAnomaly — required — (Boolean)

      Feedback on whether the metric is a legitimate anomaly.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lookoutmetrics.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The resource's Amazon Resource Name (ARN).

  • Tags — (map<String>)

    Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
lookoutmetrics.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The resource's Amazon Resource Name (ARN).

  • TagKeys — (Array<String>)

    Keys to remove from the resource's tags.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AlertArn: 'STRING_VALUE', /* required */
  Action: {
    LambdaConfiguration: {
      LambdaArn: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE' /* required */
    },
    SNSConfiguration: {
      RoleArn: 'STRING_VALUE', /* required */
      SnsTopicArn: 'STRING_VALUE', /* required */
      SnsFormat: LONG_TEXT | SHORT_TEXT | JSON
    }
  },
  AlertDescription: 'STRING_VALUE',
  AlertFilters: {
    DimensionFilterList: [
      {
        DimensionName: 'STRING_VALUE',
        DimensionValueList: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    MetricList: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  AlertSensitivityThreshold: 'NUMBER_VALUE'
};
lookoutmetrics.updateAlert(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AlertArn — (String)

    The ARN of the alert to update.

  • AlertDescription — (String)

    A description of the alert.

  • AlertSensitivityThreshold — (Integer)

    An integer from 0 to 100 specifying the alert sensitivity threshold.

  • Action — (map)

    Action that will be triggered when there is an alert.

    • SNSConfiguration — (map)

      A configuration for an Amazon SNS channel.

      • RoleArn — required — (String)

        The ARN of the IAM role that has access to the target SNS topic.

      • SnsTopicArn — required — (String)

        The ARN of the target SNS topic.

      • SnsFormat — (String)

        The format of the SNS topic.

        • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

        • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

        • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

        Possible values include:
        • "LONG_TEXT"
        • "SHORT_TEXT"
        • "JSON"
    • LambdaConfiguration — (map)

      A configuration for an AWS Lambda channel.

      • RoleArn — required — (String)

        The ARN of an IAM role that has permission to invoke the Lambda function.

      • LambdaArn — required — (String)

        The ARN of the Lambda function.

  • AlertFilters — (map)

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    • MetricList — (Array<String>)

      The list of measures that you want to get alerts for.

    • DimensionFilterList — (Array<map>)

      The list of DimensionFilter objects that are used for dimension-based filtering.

      • DimensionName — (String)

        The name of the dimension to filter on.

      • DimensionValueList — (Array<String>)

        The list of values for the dimension specified in DimensionName that you want to filter on.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AlertArn — (String)

      The ARN of the updated alert.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AnomalyDetectorConfig: {
    AnomalyDetectorFrequency: P1D | PT1H | PT10M | PT5M
  },
  AnomalyDetectorDescription: 'STRING_VALUE',
  KmsKeyArn: 'STRING_VALUE'
};
lookoutmetrics.updateAnomalyDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalyDetectorArn — (String)

    The ARN of the detector to update.

  • KmsKeyArn — (String)

    The Amazon Resource Name (ARN) of an AWS KMS encryption key.

  • AnomalyDetectorDescription — (String)

    The updated detector description.

  • AnomalyDetectorConfig — (map)

    Contains information about the configuration to which the detector will be updated.

    • AnomalyDetectorFrequency — (String)

      The frequency at which the detector analyzes its source data.

      Possible values include:
      • "P1D"
      • "PT1H"
      • "PT10M"
      • "PT5M"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyDetectorArn — (String)

      The ARN of the updated detector.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MetricSetArn: 'STRING_VALUE', /* required */
  DimensionFilterList: [
    {
      FilterList: [
        {
          DimensionValue: 'STRING_VALUE',
          FilterOperation: EQUALS
        },
        /* more items */
      ],
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  DimensionList: [
    'STRING_VALUE',
    /* more items */
  ],
  MetricList: [
    {
      AggregationFunction: AVG | SUM, /* required */
      MetricName: 'STRING_VALUE', /* required */
      Namespace: 'STRING_VALUE'
    },
    /* more items */
  ],
  MetricSetDescription: 'STRING_VALUE',
  MetricSetFrequency: P1D | PT1H | PT10M | PT5M,
  MetricSource: {
    AppFlowConfig: {
      FlowName: 'STRING_VALUE',
      RoleArn: 'STRING_VALUE'
    },
    AthenaSourceConfig: {
      BackTestConfiguration: {
        RunBackTestMode: true || false /* required */
      },
      DataCatalog: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      RoleArn: 'STRING_VALUE',
      S3ResultsPath: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      WorkGroupName: 'STRING_VALUE'
    },
    CloudWatchConfig: {
      BackTestConfiguration: {
        RunBackTestMode: true || false /* required */
      },
      RoleArn: 'STRING_VALUE'
    },
    RDSSourceConfig: {
      DBInstanceIdentifier: 'STRING_VALUE',
      DatabaseHost: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      DatabasePort: 'NUMBER_VALUE',
      RoleArn: 'STRING_VALUE',
      SecretManagerArn: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      VpcConfiguration: {
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    RedshiftSourceConfig: {
      ClusterIdentifier: 'STRING_VALUE',
      DatabaseHost: 'STRING_VALUE',
      DatabaseName: 'STRING_VALUE',
      DatabasePort: 'NUMBER_VALUE',
      RoleArn: 'STRING_VALUE',
      SecretManagerArn: 'STRING_VALUE',
      TableName: 'STRING_VALUE',
      VpcConfiguration: {
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    S3SourceConfig: {
      FileFormatDescriptor: {
        CsvFormatDescriptor: {
          Charset: 'STRING_VALUE',
          ContainsHeader: true || false,
          Delimiter: 'STRING_VALUE',
          FileCompression: NONE | GZIP,
          HeaderList: [
            'STRING_VALUE',
            /* more items */
          ],
          QuoteSymbol: 'STRING_VALUE'
        },
        JsonFormatDescriptor: {
          Charset: 'STRING_VALUE',
          FileCompression: NONE | GZIP
        }
      },
      HistoricalDataPathList: [
        'STRING_VALUE',
        /* more items */
      ],
      RoleArn: 'STRING_VALUE',
      TemplatedPathList: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  Offset: 'NUMBER_VALUE',
  TimestampColumn: {
    ColumnFormat: 'STRING_VALUE',
    ColumnName: 'STRING_VALUE'
  }
};
lookoutmetrics.updateMetricSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MetricSetArn — (String)

    The ARN of the dataset to update.

  • MetricSetDescription — (String)

    The dataset's description.

  • MetricList — (Array<map>)

    The metric list.

    • MetricName — required — (String)

      The name of the metric.

    • AggregationFunction — required — (String)

      The function with which the metric is calculated.

      Possible values include:
      • "AVG"
      • "SUM"
    • Namespace — (String)

      The namespace for the metric.

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

  • TimestampColumn — (map)

    The timestamp column.

    • ColumnName — (String)

      The name of the timestamp column.

    • ColumnFormat — (String)

      The format of the timestamp column.

  • DimensionList — (Array<String>)

    The dimension list.

  • MetricSetFrequency — (String)

    The dataset's interval.

    Possible values include:
    • "P1D"
    • "PT1H"
    • "PT10M"
    • "PT5M"
  • MetricSource — (map)

    Contains information about source data used to generate metrics.

    • S3SourceConfig — (map)

      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 — (Array<String>)

        A list of templated paths to the source files.

      • HistoricalDataPathList — (Array<String>)

        A list of paths to the historical data files.

      • FileFormatDescriptor — (map)

        Contains information about a source file's formatting.

        • CsvFormatDescriptor — (map)

          Contains information about how a source CSV data file should be analyzed.

          • FileCompression — (String)

            The level of compression of the source CSV file.

            Possible values include:
            • "NONE"
            • "GZIP"
          • 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 — (Array<String>)

            A list of the source CSV file's headers, if any.

          • QuoteSymbol — (String)

            The character used as a quote character.

        • JsonFormatDescriptor — (map)

          Contains information about how a source JSON data file should be analyzed.

          • FileCompression — (String)

            The level of compression of the source CSV file.

            Possible values include:
            • "NONE"
            • "GZIP"
          • Charset — (String)

            The character set in which the source JSON file is written.

    • AppFlowConfig — (map)

      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 — (map)

      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 — (map)

        Settings for backtest mode.

        • RunBackTestMode — required — (Boolean)

          Run a backtest instead of monitoring new data.

    • RDSSourceConfig — (map)

      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 — (map)

        An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList — required — (Array<String>)

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

        • SecurityGroupIdList — required — (Array<String>)

          An array of strings containing the list of security groups.

    • RedshiftSourceConfig — (map)

      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 — (map)

        Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList — required — (Array<String>)

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

        • SecurityGroupIdList — required — (Array<String>)

          An array of strings containing the list of security groups.

    • AthenaSourceConfig — (map)

      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 — (map)

        Settings for backtest mode.

        • RunBackTestMode — required — (Boolean)

          Run a backtest instead of monitoring new data.

  • DimensionFilterList — (Array<map>)

    Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

    • Name — (String)

      The dimension that you want to filter on.

    • FilterList — (Array<map>)

      The list of filters that you are applying.

      • DimensionValue — (String)

        The value that you want to include in the filter.

      • FilterOperation — (String)

        The condition to apply.

        Possible values include:
        • "EQUALS"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MetricSetArn — (String)

      The ARN of the dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.