You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.LookoutMetrics

Inherits:
AWS.Service show all
Identifier:
lookoutmetrics
API Version:
2017-07-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide.

Sending a Request Using LookoutMetrics

var lookoutmetrics = new AWS.LookoutMetrics();
lookoutmetrics.activateAnomalyDetector(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the LookoutMetrics object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lookoutmetrics = new AWS.LookoutMetrics({apiVersion: '2017-07-25'});

You can also set the API version globally in AWS.config.apiVersions using the lookoutmetrics service identifier:

AWS.config.apiVersions = {
  lookoutmetrics: '2017-07-25',
  // other service API versions
};

var lookoutmetrics = new AWS.LookoutMetrics();

Version:

  • 2017-07-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

new AWS.LookoutMetrics(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a LookoutMetrics object

var lookoutmetrics = new AWS.LookoutMetrics({apiVersion: '2017-07-25'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.LookoutMetrics.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.LookoutMetrics.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.LookoutMetrics.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

activateAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Activates an anomaly detector.

Service Reference:

Examples:

Calling the activateAnomalyDetector operation

var params = {
  AnomalyDetectorArn: 'STRING_VALUE' /* required */
};
lookoutmetrics.activateAnomalyDetector(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.

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.

backTestAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Runs a backtest for anomaly detection for the specified resource.

Service Reference:

Examples:

Calling the backTestAnomalyDetector operation

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.

createAlert(params = {}, callback) ⇒ AWS.Request

Creates an alert for an anomaly detector.

Service Reference:

Examples:

Calling the createAlert operation

var params = {
  Action: { /* required */
    LambdaConfiguration: {
      LambdaArn: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE' /* required */
    },
    SNSConfiguration: {
      RoleArn: 'STRING_VALUE', /* required */
      SnsTopicArn: 'STRING_VALUE' /* required */
    }
  },
  AlertName: 'STRING_VALUE', /* required */
  AlertSensitivityThreshold: 'NUMBER_VALUE', /* required */
  AnomalyDetectorArn: 'STRING_VALUE', /* required */
  AlertDescription: 'STRING_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.

        • RoleArnrequired — (String)

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

        • SnsTopicArnrequired — (String)

          The ARN of the target SNS topic.

      • LambdaConfiguration — (map)

        A configuration for an AWS Lambda channel.

        • RoleArnrequired — (String)

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

        • LambdaArnrequired — (String)

          The ARN of the Lambda function.

    • Tags — (map<String>)

      A list of tags to apply to the alert.

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.

createAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Creates an anomaly detector.

Service Reference:

Examples:

Calling the createAnomalyDetector operation

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.

createMetricSet(params = {}, callback) ⇒ AWS.Request

Creates a dataset.

Service Reference:

Examples:

Calling the createMetricSet operation

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', /* required */
      RoleArn: 'STRING_VALUE' /* required */
    },
    CloudWatchConfig: {
      RoleArn: 'STRING_VALUE' /* required */
    },
    RDSSourceConfig: {
      DBInstanceIdentifier: 'STRING_VALUE', /* required */
      DatabaseHost: 'STRING_VALUE', /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      DatabasePort: 'NUMBER_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecretManagerArn: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      VpcConfiguration: { /* required */
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    RedshiftSourceConfig: {
      ClusterIdentifier: 'STRING_VALUE', /* required */
      DatabaseHost: 'STRING_VALUE', /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      DatabasePort: 'NUMBER_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecretManagerArn: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      VpcConfiguration: { /* required */
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    S3SourceConfig: {
      RoleArn: 'STRING_VALUE', /* required */
      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 */
      ],
      TemplatedPathList: [
        '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.

      • MetricNamerequired — (String)

        The name of the metric.

      • AggregationFunctionrequired — (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 and Redshift 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.

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

        An object containing information about the AppFlow configuration.

        • RoleArnrequired — (String)

          An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

        • FlowNamerequired — (String)

          name of the flow.

      • CloudWatchConfig — (map)

        An object containing information about the Amazon CloudWatch monitoring configuration.

        • RoleArnrequired — (String)

          An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

      • RDSSourceConfig — (map)

        An object containing information about the Amazon Relational Database Service (RDS) configuration.

        • DBInstanceIdentifierrequired — (String)

          A string identifying the database instance.

        • DatabaseHostrequired — (String)

          The host name of the database.

        • DatabasePortrequired — (Integer)

          The port number where the database can be accessed.

        • SecretManagerArnrequired — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseNamerequired — (String)

          The name of the RDS database.

        • TableNamerequired — (String)

          The name of the table in the database.

        • RoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role.

        • VpcConfigurationrequired — (map)

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

          • SubnetIdListrequired — (Array<String>)

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

          • SecurityGroupIdListrequired — (Array<String>)

            An array of strings containing the list of security groups.

      • RedshiftSourceConfig — (map)

        An object containing information about the Amazon Redshift database configuration.

        • ClusterIdentifierrequired — (String)

          A string identifying the Redshift cluster.

        • DatabaseHostrequired — (String)

          The name of the database host.

        • DatabasePortrequired — (Integer)

          The port number where the database can be accessed.

        • SecretManagerArnrequired — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseNamerequired — (String)

          The Redshift database name.

        • TableNamerequired — (String)

          The table name of the Redshift database.

        • RoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role providing access to the database.

        • VpcConfigurationrequired — (map)

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

          • SubnetIdListrequired — (Array<String>)

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

          • SecurityGroupIdListrequired — (Array<String>)

            An array of strings containing the list of security groups.

    • Timezone — (String)

      The time zone in which your source data was recorded.

    • Tags — (map<String>)

      A list of tags to apply to 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.

Returns:

  • (AWS.Request)

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

deleteAlert(params = {}, callback) ⇒ AWS.Request

Deletes an alert.

Service Reference:

Examples:

Calling the deleteAlert operation

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.

deleteAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.

Service Reference:

Examples:

Calling the deleteAnomalyDetector operation

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.

describeAlert(params = {}, callback) ⇒ AWS.Request

Describes an alert.

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

Service Reference:

Examples:

Calling the describeAlert operation

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.

            • RoleArnrequired — (String)

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

            • SnsTopicArnrequired — (String)

              The ARN of the target SNS topic.

          • LambdaConfiguration — (map)

            A configuration for an AWS Lambda channel.

            • RoleArnrequired — (String)

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

            • LambdaArnrequired — (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.

Returns:

  • (AWS.Request)

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

describeAnomalyDetectionExecutions(params = {}, callback) ⇒ AWS.Request

Returns information about the status of the specified anomaly detection jobs.

Examples:

Calling the describeAnomalyDetectionExecutions operation

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.

describeAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Describes a detector.

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

Service Reference:

Examples:

Calling the describeAnomalyDetector operation

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"
      • FailureReason — (String)

        The reason that the detector failed, if any.

      • KmsKeyArn — (String)

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

Returns:

  • (AWS.Request)

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

describeMetricSet(params = {}, callback) ⇒ AWS.Request

Describes a dataset.

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

Service Reference:

Examples:

Calling the describeMetricSet operation

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)

        The offset in seconds. Only supported for S3 and Redshift datasources.

      • MetricList — (Array<map>)

        A list of the metrics defined by the dataset.

        • MetricNamerequired — (String)

          The name of the metric.

        • AggregationFunctionrequired — (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.

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

          An object containing information about the AppFlow configuration.

          • RoleArnrequired — (String)

            An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

          • FlowNamerequired — (String)

            name of the flow.

        • CloudWatchConfig — (map)

          An object containing information about the Amazon CloudWatch monitoring configuration.

          • RoleArnrequired — (String)

            An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

        • RDSSourceConfig — (map)

          An object containing information about the Amazon Relational Database Service (RDS) configuration.

          • DBInstanceIdentifierrequired — (String)

            A string identifying the database instance.

          • DatabaseHostrequired — (String)

            The host name of the database.

          • DatabasePortrequired — (Integer)

            The port number where the database can be accessed.

          • SecretManagerArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

          • DatabaseNamerequired — (String)

            The name of the RDS database.

          • TableNamerequired — (String)

            The name of the table in the database.

          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the role.

          • VpcConfigurationrequired — (map)

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

            • SubnetIdListrequired — (Array<String>)

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

            • SecurityGroupIdListrequired — (Array<String>)

              An array of strings containing the list of security groups.

        • RedshiftSourceConfig — (map)

          An object containing information about the Amazon Redshift database configuration.

          • ClusterIdentifierrequired — (String)

            A string identifying the Redshift cluster.

          • DatabaseHostrequired — (String)

            The name of the database host.

          • DatabasePortrequired — (Integer)

            The port number where the database can be accessed.

          • SecretManagerArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

          • DatabaseNamerequired — (String)

            The Redshift database name.

          • TableNamerequired — (String)

            The table name of the Redshift database.

          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the role providing access to the database.

          • VpcConfigurationrequired — (map)

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

            • SubnetIdListrequired — (Array<String>)

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

            • SecurityGroupIdListrequired — (Array<String>)

              An array of strings containing the list of security groups.

Returns:

  • (AWS.Request)

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

getAnomalyGroup(params = {}, callback) ⇒ AWS.Request

Returns details about a group of anomalous metrics.

Service Reference:

Examples:

Calling the getAnomalyGroup operation

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.

getFeedback(params = {}, callback) ⇒ AWS.Request

Get feedback for an anomaly group.

Service Reference:

Examples:

Calling the getFeedback operation

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.

      • AnomalyGroupIdrequired — (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.

getSampleData(params = {}, callback) ⇒ AWS.Request

Returns a selection of sample records from an Amazon S3 datasource.

Service Reference:

Examples:

Calling the getSampleData operation

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.

      • RoleArnrequired — (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.

      • FileFormatDescriptorrequired — (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.

listAlerts(params = {}, callback) ⇒ AWS.Request

Lists the alerts attached to a detector.

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

Service Reference:

Examples:

Calling the listAlerts operation

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.

listAnomalyDetectors(params = {}, callback) ⇒ AWS.Request

Lists the detectors in the current AWS Region.

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

Service Reference:

Examples:

Calling the listAnomalyDetectors operation

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

listAnomalyGroupSummaries(params = {}, callback) ⇒ AWS.Request

Returns a list of anomaly groups.

Service Reference:

Examples:

Calling the listAnomalyGroupSummaries operation

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.

listAnomalyGroupTimeSeries(params = {}, callback) ⇒ AWS.Request

Gets a list of anomalous metrics for a measure in an anomaly group.

Service Reference:

Examples:

Calling the listAnomalyGroupTimeSeries operation

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.

        • TimeSeriesIdrequired — (String)

          The ID of the metric.

        • DimensionListrequired — (Array<map>)

          The dimensions of the metric.

          • DimensionNamerequired — (String)

            The name of the dimension.

          • DimensionValuerequired — (String)

            The value of the dimension.

        • MetricValueListrequired — (Array<Float>)

          The values for the metric.

Returns:

  • (AWS.Request)

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

listMetricSets(params = {}, callback) ⇒ AWS.Request

Lists the datasets in the current AWS Region.

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

Service Reference:

Examples:

Calling the listMetricSets operation

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.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Gets a list of tags for a detector, dataset, or alert.

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

putFeedback(params = {}, callback) ⇒ AWS.Request

Add feedback for an anomalous metric.

Service Reference:

Examples:

Calling the putFeedback operation

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.

      • AnomalyGroupIdrequired — (String)

        The ID of the anomaly group.

      • TimeSeriesIdrequired — (String)

        The ID of the metric.

      • IsAnomalyrequired — (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.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags to a detector, dataset, or alert.

Service Reference:

Examples:

Calling the tagResource operation

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a detector, dataset, or alert.

Service Reference:

Examples:

Calling the untagResource operation

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.

updateAnomalyDetector(params = {}, callback) ⇒ AWS.Request

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

Service Reference:

Examples:

Calling the updateAnomalyDetector operation

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.

updateMetricSet(params = {}, callback) ⇒ AWS.Request

Updates a dataset.

Service Reference:

Examples:

Calling the updateMetricSet operation

var params = {
  MetricSetArn: 'STRING_VALUE', /* required */
  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', /* required */
      RoleArn: 'STRING_VALUE' /* required */
    },
    CloudWatchConfig: {
      RoleArn: 'STRING_VALUE' /* required */
    },
    RDSSourceConfig: {
      DBInstanceIdentifier: 'STRING_VALUE', /* required */
      DatabaseHost: 'STRING_VALUE', /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      DatabasePort: 'NUMBER_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecretManagerArn: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      VpcConfiguration: { /* required */
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    RedshiftSourceConfig: {
      ClusterIdentifier: 'STRING_VALUE', /* required */
      DatabaseHost: 'STRING_VALUE', /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      DatabasePort: 'NUMBER_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecretManagerArn: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      VpcConfiguration: { /* required */
        SecurityGroupIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdList: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    S3SourceConfig: {
      RoleArn: 'STRING_VALUE', /* required */
      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 */
      ],
      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.

      • MetricNamerequired — (String)

        The name of the metric.

      • AggregationFunctionrequired — (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 and Redshift 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 a metric.

      • S3SourceConfig — (map)

        Contains information about the configuration of the S3 bucket that contains source files.

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

        An object containing information about the AppFlow configuration.

        • RoleArnrequired — (String)

          An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

        • FlowNamerequired — (String)

          name of the flow.

      • CloudWatchConfig — (map)

        An object containing information about the Amazon CloudWatch monitoring configuration.

        • RoleArnrequired — (String)

          An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

      • RDSSourceConfig — (map)

        An object containing information about the Amazon Relational Database Service (RDS) configuration.

        • DBInstanceIdentifierrequired — (String)

          A string identifying the database instance.

        • DatabaseHostrequired — (String)

          The host name of the database.

        • DatabasePortrequired — (Integer)

          The port number where the database can be accessed.

        • SecretManagerArnrequired — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseNamerequired — (String)

          The name of the RDS database.

        • TableNamerequired — (String)

          The name of the table in the database.

        • RoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role.

        • VpcConfigurationrequired — (map)

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

          • SubnetIdListrequired — (Array<String>)

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

          • SecurityGroupIdListrequired — (Array<String>)

            An array of strings containing the list of security groups.

      • RedshiftSourceConfig — (map)

        An object containing information about the Amazon Redshift database configuration.

        • ClusterIdentifierrequired — (String)

          A string identifying the Redshift cluster.

        • DatabaseHostrequired — (String)

          The name of the database host.

        • DatabasePortrequired — (Integer)

          The port number where the database can be accessed.

        • SecretManagerArnrequired — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseNamerequired — (String)

          The Redshift database name.

        • TableNamerequired — (String)

          The table name of the Redshift database.

        • RoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role providing access to the database.

        • VpcConfigurationrequired — (map)

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

          • SubnetIdListrequired — (Array<String>)

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

          • SecurityGroupIdListrequired — (Array<String>)

            An array of strings containing the list of security groups.

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.