Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

Class: AWS.LookoutEquipment

Inherits:
AWS.Service show all
Identifier:
lookoutequipment
API Version:
2020-12-15
Defined in:
(unknown)

Overview

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

Service Description

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify anomalies in machines from sensor data for use in predictive maintenance.

Sending a Request Using LookoutEquipment

var lookoutequipment = new AWS.LookoutEquipment();
lookoutequipment.createDataset(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 LookoutEquipment object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lookoutequipment = new AWS.LookoutEquipment({apiVersion: '2020-12-15'});

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

AWS.config.apiVersions = {
  lookoutequipment: '2020-12-15',
  // other service API versions
};

var lookoutequipment = new AWS.LookoutEquipment();

Version:

  • 2020-12-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a LookoutEquipment object

var lookoutequipment = new AWS.LookoutEquipment({apiVersion: '2020-12-15'});

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.LookoutEquipment.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.LookoutEquipment.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

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

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE', /* required */
  DatasetSchema: { /* required */
    InlineDataSchema: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
  },
  ServerSideKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.createDataset(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: {})
    • DatasetName — (String)

      The name of the dataset being created.

    • DatasetSchema — (map)

      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

      • InlineDataSchema — (String)

    • ServerSideKmsKeyId — (String)

      Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt dataset data by Amazon Lookout for Equipment.

    • ClientToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Any tags associated with the ingested data described in the dataset.

      • Keyrequired — (String)

        The key for the specified tag.

      • Valuerequired — (String)

        The value for the specified tag.

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:

      • DatasetName — (String)

        The name of the dataset being created.

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset being created.

      • Status — (String)

        Indicates the status of the CreateDataset operation.

        Possible values include:
        • "CREATED"
        • "INGESTION_IN_PROGRESS"
        • "ACTIVE"

Returns:

  • (AWS.Request)

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

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

Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

Service Reference:

Examples:

Calling the createInferenceScheduler operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DataInputConfiguration: { /* required */
    InferenceInputNameConfiguration: {
      ComponentTimestampDelimiter: 'STRING_VALUE',
      TimestampFormat: 'STRING_VALUE'
    },
    InputTimeZoneOffset: 'STRING_VALUE',
    S3InputConfiguration: {
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  DataOutputConfiguration: { /* required */
    S3OutputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    },
    KmsKeyId: 'STRING_VALUE'
  },
  DataUploadFrequency: PT5M | PT10M | PT15M | PT30M | PT1H, /* required */
  InferenceSchedulerName: 'STRING_VALUE', /* required */
  ModelName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  DataDelayOffsetInMinutes: 'NUMBER_VALUE',
  ServerSideKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.createInferenceScheduler(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: {})
    • ModelName — (String)

      The name of the previously trained ML model being used to create the inference scheduler.

    • InferenceSchedulerName — (String)

      The name of the inference scheduler being created.

    • DataDelayOffsetInMinutes — (Integer)

      A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

    • DataUploadFrequency — (String)

      How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

      Possible values include:
      • "PT5M"
      • "PT10M"
      • "PT15M"
      • "PT30M"
      • "PT1H"
    • DataInputConfiguration — (map)

      Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

      • S3InputConfiguration — (map)

        Specifies configuration information for the input data for the inference, including S3 location of input data..

        • Bucketrequired — (String)

          The bucket containing the input dataset for the inference.

        • Prefix — (String)

          The prefix for the S3 bucket used for the input data for the inference.

      • InputTimeZoneOffset — (String)

        Indicates the difference between your time zone and Greenwich Mean Time (GMT).

      • InferenceInputNameConfiguration — (map)

        > Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

        • TimestampFormat — (String)

          The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

        • ComponentTimestampDelimiter — (String)

          Indicates the delimiter character used between items in the data.

    • DataOutputConfiguration — (map)

      Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.

      • S3OutputConfigurationrequired — (map)

        Specifies configuration information for the output results from for the inference, output S3 location.

        • Bucketrequired — (String)

          The bucket containing the output results from the inference

        • Prefix — (String)

          The prefix for the S3 bucket used for the output results from the inference.

      • KmsKeyId — (String)

        The ID number for the AWS KMS key used to encrypt the inference output.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

    • ServerSideKmsKeyId — (String)

      Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.

    • ClientToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Any tags associated with the inference scheduler.

      • Keyrequired — (String)

        The key for the specified tag.

      • Valuerequired — (String)

        The value for the specified tag.

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:

      • InferenceSchedulerArn — (String)

        The Amazon Resource Name (ARN) of the inference scheduler being created.

      • InferenceSchedulerName — (String)

        The name of inference scheduler being created.

      • Status — (String)

        Indicates the status of the CreateInferenceScheduler operation.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"

Returns:

  • (AWS.Request)

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

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

Creates an ML model for data inference.

A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.

Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

Service Reference:

Examples:

Calling the createModel operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE', /* required */
  ModelName: 'STRING_VALUE', /* required */
  DataPreProcessingConfiguration: {
    TargetSamplingRate: PT1S | PT5S | PT10S | PT15S | PT30S | PT1M | PT5M | PT10M | PT15M | PT30M | PT1H
  },
  DatasetSchema: {
    InlineDataSchema: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
  },
  EvaluationDataEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EvaluationDataStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LabelsInputConfiguration: {
    S3InputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  RoleArn: 'STRING_VALUE',
  ServerSideKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TrainingDataEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TrainingDataStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
lookoutequipment.createModel(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: {})
    • ModelName — (String)

      The name for the ML model to be created.

    • DatasetName — (String)

      The name of the dataset for the ML model being created.

    • DatasetSchema — (map)

      The data schema for the ML model being created.

      • InlineDataSchema — (String)

    • LabelsInputConfiguration — (map)

      The input configuration for the labels being used for the ML model that's being created.

      • S3InputConfigurationrequired — (map)

        Contains location information for the S3 location being used for label data.

        • Bucketrequired — (String)

          The name of the S3 bucket holding the label data.

        • Prefix — (String)

          The prefix for the S3 bucket used for the label data.

    • ClientToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      If a token is not provided, the SDK will use a version 4 UUID.
    • TrainingDataStartTime — (Date)

      Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

    • TrainingDataEndTime — (Date)

      Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.

    • EvaluationDataStartTime — (Date)

      Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.

    • EvaluationDataEndTime — (Date)

      Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.

    • DataPreProcessingConfiguration — (map)

      The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

      • TargetSamplingRate — (String)

        The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

        When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

        Possible values include:
        • "PT1S"
        • "PT5S"
        • "PT10S"
        • "PT15S"
        • "PT30S"
        • "PT1M"
        • "PT5M"
        • "PT10M"
        • "PT15M"
        • "PT30M"
        • "PT1H"
    • ServerSideKmsKeyId — (String)

      Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt model data by Amazon Lookout for Equipment.

    • Tags — (Array<map>)

      Any tags associated with the ML model being created.

      • Keyrequired — (String)

        The key for the specified tag.

      • Valuerequired — (String)

        The value for the specified tag.

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:

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model being created.

      • Status — (String)

        Indicates the status of the CreateModel operation.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

Service Reference:

Examples:

Calling the deleteDataset operation

var params = {
  DatasetName: 'STRING_VALUE' /* required */
};
lookoutequipment.deleteDataset(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: {})
    • DatasetName — (String)

      The name of the dataset to be deleted.

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.

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

Deletes an inference scheduler that has been set up. Already processed output results are not affected.

Service Reference:

Examples:

Calling the deleteInferenceScheduler operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE' /* required */
};
lookoutequipment.deleteInferenceScheduler(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: {})
    • InferenceSchedulerName — (String)

      The name of the inference scheduler to be deleted.

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.

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

Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

Service Reference:

Examples:

Calling the deleteModel operation

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.deleteModel(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: {})
    • ModelName — (String)

      The name of the ML model to be deleted.

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.

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

Provides information on a specific data ingestion job such as creation time, dataset ARN, status, and so on.

Service Reference:

Examples:

Calling the describeDataIngestionJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
lookoutequipment.describeDataIngestionJob(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: {})
    • JobId — (String)

      The job ID of the data ingestion job.

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:

      • JobId — (String)

        Indicates the job ID of the data ingestion job.

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

      • IngestionInputConfiguration — (map)

        Specifies the S3 location configuration for the data input for the data ingestion job.

        • S3InputConfigurationrequired — (map)

          The location information for the S3 bucket used for input data for the data ingestion.

          • Bucketrequired — (String)

            The name of the S3 bucket used for the input data for the data ingestion.

          • Prefix — (String)

            The prefix for the S3 location being used for the input data for the data ingestion.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

      • CreatedAt — (Date)

        The time at which the data ingestion job was created.

      • Status — (String)

        Indicates the status of the DataIngestionJob operation.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
      • FailedReason — (String)

        Specifies the reason for failure when a data ingestion job has failed.

Returns:

  • (AWS.Request)

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

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

Provides information on a specified dataset such as the schema location, status, and so on.

Service Reference:

Examples:

Calling the describeDataset operation

var params = {
  DatasetName: 'STRING_VALUE' /* required */
};
lookoutequipment.describeDataset(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: {})
    • DatasetName — (String)

      The name of the dataset to be described.

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:

      • DatasetName — (String)

        The name of the dataset being described.

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset being described.

      • CreatedAt — (Date)

        Specifies the time the dataset was created in Amazon Lookout for Equipment.

      • LastUpdatedAt — (Date)

        Specifies the time the dataset was last updated, if it was.

      • Status — (String)

        Indicates the status of the dataset.

        Possible values include:
        • "CREATED"
        • "INGESTION_IN_PROGRESS"
        • "ACTIVE"
      • Schema — (String)

        A JSON description of the data that is in each time series dataset, including names, column names, and data types.

      • ServerSideKmsKeyId — (String)

        Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt dataset data by Amazon Lookout for Equipment.

      • IngestionInputConfiguration — (map)

        Specifies the S3 location configuration for the data input for the data ingestion job.

        • S3InputConfigurationrequired — (map)

          The location information for the S3 bucket used for input data for the data ingestion.

          • Bucketrequired — (String)

            The name of the S3 bucket used for the input data for the data ingestion.

          • Prefix — (String)

            The prefix for the S3 location being used for the input data for the data ingestion.

Returns:

  • (AWS.Request)

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

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

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

Service Reference:

Examples:

Calling the describeInferenceScheduler operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE' /* required */
};
lookoutequipment.describeInferenceScheduler(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: {})
    • InferenceSchedulerName — (String)

      The name of the inference scheduler being described.

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:

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

      • ModelName — (String)

        The name of the ML model of the inference scheduler being described.

      • InferenceSchedulerName — (String)

        The name of the inference scheduler being described.

      • InferenceSchedulerArn — (String)

        The Amazon Resource Name (ARN) of the inference scheduler being described.

      • Status — (String)

        Indicates the status of the inference scheduler.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"
      • DataDelayOffsetInMinutes — (Integer)

        A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

      • DataUploadFrequency — (String)

        Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

        Possible values include:
        • "PT5M"
        • "PT10M"
        • "PT15M"
        • "PT30M"
        • "PT1H"
      • CreatedAt — (Date)

        Specifies the time at which the inference scheduler was created.

      • UpdatedAt — (Date)

        Specifies the time at which the inference scheduler was last updated, if it was.

      • DataInputConfiguration — (map)

        Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

        • S3InputConfiguration — (map)

          Specifies configuration information for the input data for the inference, including S3 location of input data..

          • Bucketrequired — (String)

            The bucket containing the input dataset for the inference.

          • Prefix — (String)

            The prefix for the S3 bucket used for the input data for the inference.

        • InputTimeZoneOffset — (String)

          Indicates the difference between your time zone and Greenwich Mean Time (GMT).

        • InferenceInputNameConfiguration — (map)

          > Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

          • TimestampFormat — (String)

            The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

          • ComponentTimestampDelimiter — (String)

            Indicates the delimiter character used between items in the data.

      • DataOutputConfiguration — (map)

        Specifies information for the output results for the inference scheduler, including the output S3 location.

        • S3OutputConfigurationrequired — (map)

          Specifies configuration information for the output results from for the inference, output S3 location.

          • Bucketrequired — (String)

            The bucket containing the output results from the inference

          • Prefix — (String)

            The prefix for the S3 bucket used for the output results from the inference.

        • KmsKeyId — (String)

          The ID number for the AWS KMS key used to encrypt the inference output.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

      • ServerSideKmsKeyId — (String)

        Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.

Returns:

  • (AWS.Request)

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

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

Provides overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.

Service Reference:

Examples:

Calling the describeModel operation

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.describeModel(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: {})
    • ModelName — (String)

      The name of the ML model to be described.

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:

      • ModelName — (String)

        The name of the ML model being described.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the ML model being described.

      • DatasetName — (String)

        The name of the dataset being used by the ML being described.

      • DatasetArn — (String)

        The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

      • Schema — (String)

        A JSON description of the data that is in each time series dataset, including names, column names, and data types.

      • LabelsInputConfiguration — (map)

        Specifies configuration information about the labels input, including its S3 location.

        • S3InputConfigurationrequired — (map)

          Contains location information for the S3 location being used for label data.

          • Bucketrequired — (String)

            The name of the S3 bucket holding the label data.

          • Prefix — (String)

            The prefix for the S3 bucket used for the label data.

      • TrainingDataStartTime — (Date)

        Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.

      • TrainingDataEndTime — (Date)

        Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.

      • EvaluationDataStartTime — (Date)

        Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.

      • EvaluationDataEndTime — (Date)

        Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.

      • DataPreProcessingConfiguration — (map)

        The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

        When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

        • TargetSamplingRate — (String)

          The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

          When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

          Possible values include:
          • "PT1S"
          • "PT5S"
          • "PT10S"
          • "PT15S"
          • "PT30S"
          • "PT1M"
          • "PT5M"
          • "PT10M"
          • "PT15M"
          • "PT30M"
          • "PT1H"
      • Status — (String)

        Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
      • TrainingExecutionStartTime — (Date)

        Indicates the time at which the training of the ML model began.

      • TrainingExecutionEndTime — (Date)

        Indicates the time at which the training of the ML model was completed.

      • FailedReason — (String)

        If the training of the ML model failed, this indicates the reason for that failure.

      • ModelMetrics — (String)

        The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

      • LastUpdatedTime — (Date)

        Indicates the last time the ML model was updated. The type of update is not specified.

      • CreatedAt — (Date)

        Indicates the time and date at which the ML model was created.

      • ServerSideKmsKeyId — (String)

        Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt model data by Amazon Lookout for Equipment.

Returns:

  • (AWS.Request)

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

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

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

Service Reference:

Examples:

Calling the listDataIngestionJobs operation

var params = {
  DatasetName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: IN_PROGRESS | SUCCESS | FAILED
};
lookoutequipment.listDataIngestionJobs(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: {})
    • DatasetName — (String)

      The name of the dataset being used for the data ingestion job.

    • NextToken — (String)

      An opaque pagination token indicating where to continue the listing of data ingestion jobs.

    • MaxResults — (Integer)

      Specifies the maximum number of data ingestion jobs to list.

    • Status — (String)

      Indicates the status of the data ingestion job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"

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:

      • NextToken — (String)

        An opaque pagination token indicating where to continue the listing of data ingestion jobs.

      • DataIngestionJobSummaries — (Array<map>)

        Specifies information about the specific data ingestion job, including dataset name and status.

        • JobId — (String)

          Indicates the job ID of the data ingestion job.

        • DatasetName — (String)

          The name of the dataset used for the data ingestion job.

        • DatasetArn — (String)

          The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.

        • IngestionInputConfiguration — (map)

          Specifies information for the input data for the data inference job, including data S3 location parameters.

          • S3InputConfigurationrequired — (map)

            The location information for the S3 bucket used for input data for the data ingestion.

            • Bucketrequired — (String)

              The name of the S3 bucket used for the input data for the data ingestion.

            • Prefix — (String)

              The prefix for the S3 location being used for the input data for the data ingestion.

        • Status — (String)

          Indicates the status of the data ingestion job.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"

Returns:

  • (AWS.Request)

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

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

Lists all datasets currently available in your account, filtering on the dataset name.

Service Reference:

Examples:

Calling the listDatasets operation

var params = {
  DatasetNameBeginsWith: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutequipment.listDatasets(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: {})
    • NextToken — (String)

      An opaque pagination token indicating where to continue the listing of datasets.

    • MaxResults — (Integer)

      Specifies the maximum number of datasets to list.

    • DatasetNameBeginsWith — (String)

      The beginning of the name of the datasets to be listed.

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:

      • NextToken — (String)

        An opaque pagination token indicating where to continue the listing of datasets.

      • DatasetSummaries — (Array<map>)

        Provides information about the specified dataset, including creation time, dataset ARN, and status.

        • DatasetName — (String)

          The name of the dataset.

        • DatasetArn — (String)

          The Amazon Resource Name (ARN) of the specified dataset.

        • Status — (String)

          Indicates the status of the dataset.

          Possible values include:
          • "CREATED"
          • "INGESTION_IN_PROGRESS"
          • "ACTIVE"
        • CreatedAt — (Date)

          The time at which the dataset was created in Amazon Lookout for Equipment.

Returns:

  • (AWS.Request)

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

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

Lists all inference executions that have been performed by the specified inference scheduler.

Service Reference:

Examples:

Calling the listInferenceExecutions operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE', /* required */
  DataEndTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  DataStartTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: IN_PROGRESS | SUCCESS | FAILED
};
lookoutequipment.listInferenceExecutions(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: {})
    • NextToken — (String)

      An opaque pagination token indicating where to continue the listing of inference executions.

    • MaxResults — (Integer)

      Specifies the maximum number of inference executions to list.

    • InferenceSchedulerName — (String)

      The name of the inference scheduler for the inference execution listed.

    • DataStartTimeAfter — (Date)

      The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.

    • DataEndTimeBefore — (Date)

      The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.

    • Status — (String)

      The status of the inference execution.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"

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:

      • NextToken — (String)

        An opaque pagination token indicating where to continue the listing of inference executions.

      • InferenceExecutionSummaries — (Array<map>)

        Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.

        • ModelName — (String)

          The name of the ML model being used for the inference execution.

        • ModelArn — (String)

          The Amazon Resource Name (ARN) of the ML model used for the inference execution.

        • InferenceSchedulerName — (String)

          The name of the inference scheduler being used for the inference execution.

        • InferenceSchedulerArn — (String)

          The Amazon Resource Name (ARN) of the inference scheduler being used for the inference execution.

        • ScheduledStartTime — (Date)

          Indicates the start time at which the inference scheduler began the specific inference execution.

        • DataStartTime — (Date)

          Indicates the time reference in the dataset at which the inference execution began.

        • DataEndTime — (Date)

          Indicates the time reference in the dataset at which the inference execution stopped.

        • DataInputConfiguration — (map)

          Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

          • S3InputConfiguration — (map)

            Specifies configuration information for the input data for the inference, including S3 location of input data..

            • Bucketrequired — (String)

              The bucket containing the input dataset for the inference.

            • Prefix — (String)

              The prefix for the S3 bucket used for the input data for the inference.

          • InputTimeZoneOffset — (String)

            Indicates the difference between your time zone and Greenwich Mean Time (GMT).

          • InferenceInputNameConfiguration — (map)

            > Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

            • TimestampFormat — (String)

              The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

            • ComponentTimestampDelimiter — (String)

              Indicates the delimiter character used between items in the data.

        • DataOutputConfiguration — (map)

          Specifies configuration information for the output results from for the inference execution, including the output S3 location.

          • S3OutputConfigurationrequired — (map)

            Specifies configuration information for the output results from for the inference, output S3 location.

            • Bucketrequired — (String)

              The bucket containing the output results from the inference

            • Prefix — (String)

              The prefix for the S3 bucket used for the output results from the inference.

          • KmsKeyId — (String)

            The ID number for the AWS KMS key used to encrypt the inference output.

        • CustomerResultObject — (map)

          • Bucketrequired — (String)

            The name of the specific S3 bucket.

          • Keyrequired — (String)

            The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.

        • Status — (String)

          Indicates the status of the inference execution.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
        • FailedReason — (String)

          Specifies the reason for failure when an inference execution has failed.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of all inference schedulers currently available for your account.

Service Reference:

Examples:

Calling the listInferenceSchedulers operation

var params = {
  InferenceSchedulerNameBeginsWith: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  ModelName: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutequipment.listInferenceSchedulers(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: {})
    • NextToken — (String)

      An opaque pagination token indicating where to continue the listing of inference schedulers.

    • MaxResults — (Integer)

      Specifies the maximum number of inference schedulers to list.

    • InferenceSchedulerNameBeginsWith — (String)

      The beginning of the name of the inference schedulers to be listed.

    • ModelName — (String)

      The name of the ML model used by the inference scheduler to be listed.

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:

      • NextToken — (String)

        An opaque pagination token indicating where to continue the listing of inference schedulers.

      • InferenceSchedulerSummaries — (Array<map>)

        Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status.

        • ModelName — (String)

          The name of the ML model used for the inference scheduler.

        • ModelArn — (String)

          The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.

        • InferenceSchedulerName — (String)

          The name of the inference scheduler.

        • InferenceSchedulerArn — (String)

          The Amazon Resource Name (ARN) of the inference scheduler.

        • Status — (String)

          Indicates the status of the inference scheduler.

          Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • DataDelayOffsetInMinutes — (Integer)

          > A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

        • DataUploadFrequency — (String)

          How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

          Possible values include:
          • "PT5M"
          • "PT10M"
          • "PT15M"
          • "PT30M"
          • "PT1H"

Returns:

  • (AWS.Request)

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

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

Generates a list of all models in the account, including model name and ARN, dataset, and status.

Service Reference:

Examples:

Calling the listModels operation

var params = {
  DatasetNameBeginsWith: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  ModelNameBeginsWith: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: IN_PROGRESS | SUCCESS | FAILED
};
lookoutequipment.listModels(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: {})
    • NextToken — (String)

      An opaque pagination token indicating where to continue the listing of ML models.

    • MaxResults — (Integer)

      Specifies the maximum number of ML models to list.

    • Status — (String)

      The status of the ML model.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"
    • ModelNameBeginsWith — (String)

      The beginning of the name of the ML models being listed.

    • DatasetNameBeginsWith — (String)

      The beginning of the name of the dataset of the ML models to be listed.

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:

      • NextToken — (String)

        An opaque pagination token indicating where to continue the listing of ML models.

      • ModelSummaries — (Array<map>)

        Provides information on the specified model, including created time, model and dataset ARNs, and status.

        • ModelName — (String)

          The name of the ML model.

        • ModelArn — (String)

          The Amazon Resource Name (ARN) of the ML model.

        • DatasetName — (String)

          The name of the dataset being used for the ML model.

        • DatasetArn — (String)

          The Amazon Resource Name (ARN) of the dataset used to create the model.

        • Status — (String)

          Indicates the status of the ML model.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
        • CreatedAt — (Date)

          The time at which the specific model was created.

Returns:

  • (AWS.Request)

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

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

Lists all the tags for a specified resource, including key and value.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lookoutequipment.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 Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is the focus of the ListTagsForResource operation.

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

        Any tags associated with the resource.

        • Keyrequired — (String)

          The key for the specified tag.

        • Valuerequired — (String)

          The value for the specified tag.

Returns:

  • (AWS.Request)

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

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

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

Service Reference:

Examples:

Calling the startDataIngestionJob operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE', /* required */
  IngestionInputConfiguration: { /* required */
    S3InputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  RoleArn: 'STRING_VALUE' /* required */
};
lookoutequipment.startDataIngestionJob(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: {})
    • DatasetName — (String)

      The name of the dataset being used by the data ingestion job.

    • IngestionInputConfiguration — (map)

      Specifies information for the input data for the data ingestion job, including dataset S3 location.

      • S3InputConfigurationrequired — (map)

        The location information for the S3 bucket used for input data for the data ingestion.

        • Bucketrequired — (String)

          The name of the S3 bucket used for the input data for the data ingestion.

        • Prefix — (String)

          The prefix for the S3 location being used for the input data for the data ingestion.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

    • ClientToken — (String)

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • JobId — (String)

        Indicates the job ID of the data ingestion job.

      • Status — (String)

        Indicates the status of the StartDataIngestionJob operation.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Starts an inference scheduler.

Service Reference:

Examples:

Calling the startInferenceScheduler operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE' /* required */
};
lookoutequipment.startInferenceScheduler(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: {})
    • InferenceSchedulerName — (String)

      The name of the inference scheduler to be started.

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:

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.

      • ModelName — (String)

        The name of the ML model being used by the inference scheduler.

      • InferenceSchedulerName — (String)

        The name of the inference scheduler being started.

      • InferenceSchedulerArn — (String)

        The Amazon Resource Name (ARN) of the inference scheduler being started.

      • Status — (String)

        Indicates the status of the inference scheduler.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"

Returns:

  • (AWS.Request)

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

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

Stops an inference scheduler.

Service Reference:

Examples:

Calling the stopInferenceScheduler operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE' /* required */
};
lookoutequipment.stopInferenceScheduler(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: {})
    • InferenceSchedulerName — (String)

      The name of the inference scheduler to be stopped.

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:

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being stopped.

      • ModelName — (String)

        The name of the ML model used by the inference scheduler being stopped.

      • InferenceSchedulerName — (String)

        The name of the inference scheduler being stopped.

      • InferenceSchedulerArn — (String)

        The Amazon Resource Name (ARN) of the inference schedule being stopped.

      • Status — (String)

        Indicates the status of the inference scheduler.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"

Returns:

  • (AWS.Request)

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

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

Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.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 Amazon Resource Name (ARN) of the specific resource to which the tag should be associated.

    • Tags — (Array<map>)

      The tag or tags to be associated with a specific resource. Both the tag key and value are specified.

      • Keyrequired — (String)

        The key for the specified tag.

      • Valuerequired — (String)

        The value for the specified tag.

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 a specific tag from a given resource. The tag is specified by its key.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
lookoutequipment.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 Amazon Resource Name (ARN) of the resource to which the tag is currently associated.

    • TagKeys — (Array<String>)

      Specifies the key of the tag to be removed from a specified resource.

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.

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

Updates an inference scheduler.

Service Reference:

Examples:

Calling the updateInferenceScheduler operation

var params = {
  InferenceSchedulerName: 'STRING_VALUE', /* required */
  DataDelayOffsetInMinutes: 'NUMBER_VALUE',
  DataInputConfiguration: {
    InferenceInputNameConfiguration: {
      ComponentTimestampDelimiter: 'STRING_VALUE',
      TimestampFormat: 'STRING_VALUE'
    },
    InputTimeZoneOffset: 'STRING_VALUE',
    S3InputConfiguration: {
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  DataOutputConfiguration: {
    S3OutputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    },
    KmsKeyId: 'STRING_VALUE'
  },
  DataUploadFrequency: PT5M | PT10M | PT15M | PT30M | PT1H,
  RoleArn: 'STRING_VALUE'
};
lookoutequipment.updateInferenceScheduler(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: {})
    • InferenceSchedulerName — (String)

      The name of the inference scheduler to be updated.

    • DataDelayOffsetInMinutes — (Integer)

      > A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

    • DataUploadFrequency — (String)

      How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

      Possible values include:
      • "PT5M"
      • "PT10M"
      • "PT15M"
      • "PT30M"
      • "PT1H"
    • DataInputConfiguration — (map)

      Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

      • S3InputConfiguration — (map)

        Specifies configuration information for the input data for the inference, including S3 location of input data..

        • Bucketrequired — (String)

          The bucket containing the input dataset for the inference.

        • Prefix — (String)

          The prefix for the S3 bucket used for the input data for the inference.

      • InputTimeZoneOffset — (String)

        Indicates the difference between your time zone and Greenwich Mean Time (GMT).

      • InferenceInputNameConfiguration — (map)

        > Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

        • TimestampFormat — (String)

          The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

        • ComponentTimestampDelimiter — (String)

          Indicates the delimiter character used between items in the data.

    • DataOutputConfiguration — (map)

      Specifies information for the output results from the inference scheduler, including the output S3 location.

      • S3OutputConfigurationrequired — (map)

        Specifies configuration information for the output results from for the inference, output S3 location.

        • Bucketrequired — (String)

          The bucket containing the output results from the inference

        • Prefix — (String)

          The prefix for the S3 bucket used for the output results from the inference.

      • KmsKeyId — (String)

        The ID number for the AWS KMS key used to encrypt the inference output.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

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.