Class: AWS.LookoutEquipment

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 machine learning model being used to create the inference scheduler.

  • InferenceSchedulerName — (String)

    The name of the inference scheduler being created.

  • DataDelayOffsetInMinutes — (Integer)

    The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

    For more information, see Understanding the inference process.

  • DataUploadFrequency — (String)

    How often data is uploaded to the source Amazon 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 runs inference on your data.

    For more information, see Understanding the inference process.

    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 Amazon S3 location of input data.

      • Bucket — required — (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 Coordinated Universal Time (UTC).

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

    • S3OutputConfiguration — required — (map)

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

      • Bucket — required — (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 KMS key 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 KMS key 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.

    • Key — required — (String)

      The key for the specified tag.

    • Value — required — (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"
    • ModelQuality — (String)

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      Possible values include:
      • "QUALITY_THRESHOLD_MET"
      • "CANNOT_DETERMINE_QUALITY"
      • "POOR_QUALITY_DETECTED"

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  LabelGroupName: 'STRING_VALUE', /* required */
  Rating: ANOMALY | NO_ANOMALY | NEUTRAL, /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Equipment: 'STRING_VALUE',
  FaultCode: 'STRING_VALUE',
  Notes: 'STRING_VALUE'
};
lookoutequipment.createLabel(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: {}) —
  • LabelGroupName — (String)

    The name of a group of labels.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • StartTime — (Date)

    The start time of the labeled event.

  • EndTime — (Date)

    The end time of the labeled event.

  • Rating — (String)

    Indicates whether a labeled event represents an anomaly.

    Possible values include:
    • "ANOMALY"
    • "NO_ANOMALY"
    • "NEUTRAL"
  • FaultCode — (String)

    Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • Notes — (String)

    Metadata providing additional information about the label.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • Equipment — (String)

    Indicates that a label pertains to a particular piece of equipment.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • ClientToken — (String)

    A unique identifier for the request to create a label. If you do not set the client request token, 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:

    • LabelId — (String)

      The ID of the label that you have created.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  LabelGroupName: 'STRING_VALUE', /* required */
  FaultCodes: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.createLabelGroup(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: {}) —
  • LabelGroupName — (String)

    Names a group of labels.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • FaultCodes — (Array<String>)

    The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • ClientToken — (String)

    A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.

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

    Tags that provide metadata about the label group you are creating.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • Key — required — (String)

      The key for the specified tag.

    • Value — required — (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:

    • LabelGroupName — (String)

      The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • LabelGroupArn — (String)

      The Amazon Resource Name (ARN) of the label group that you have created.

Returns:

• (AWS.Request) —

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

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: {
    LabelGroupName: 'STRING_VALUE',
    S3InputConfiguration: {
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  ModelDiagnosticsOutputConfiguration: {
    S3OutputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    },
    KmsKeyId: 'STRING_VALUE'
  },
  OffCondition: '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 machine learning model to be created.

  • DatasetName — (String)

    The name of the dataset for the machine learning model being created.

  • DatasetSchema — (map)

    The data schema for the machine learning model being created.

    • InlineDataSchema — (String)

      The data schema used within the given dataset.

  • LabelsInputConfiguration — (map)

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

    • S3InputConfiguration — (map)

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

      • Bucket — required — (String)

        The name of the S3 bucket holding the label data.

      • Prefix — (String)

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

    • LabelGroupName — (String)

      The name of the label group to be used for 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 machine learning model.

  • TrainingDataEndTime — (Date)

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

  • EvaluationDataStartTime — (Date)

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

  • EvaluationDataEndTime — (Date)

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

  • RoleArn — (String)

    The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning 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 KMS key used to encrypt model data by Amazon Lookout for Equipment.

  • Tags — (Array<map>)

    Any tags associated with the machine learning model being created.

    • Key — required — (String)

      The key for the specified tag.

    • Value — required — (String)

      The value for the specified tag.

  • OffCondition — (String)

    Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

  • ModelDiagnosticsOutputConfiguration — (map)

    The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.

    • S3OutputConfiguration — required — (map)

      The Amazon S3 location for the pointwise model diagnostics.

      • Bucket — required — (String)

        The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

      • Prefix — (String)

        The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket).

        When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.

        When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.

    • KmsKeyId — (String)

      The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

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

Returns:

• (AWS.Request) —

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

/*  */

 var params = {
  ClientToken: "sample-client-token", 
  LookbackWindow: "P360D", 
  ModelName: "sample-model", 
  PromoteMode: "MANUAL", 
  RetrainingFrequency: "P1M"
 };
 lookoutequipment.createRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
    ModelName: "sample-model", 
    Status: "PENDING"
   }
   */
 });

/*  */

 var params = {
  ClientToken: "sample-client-token", 
  LookbackWindow: "P360D", 
  ModelName: "sample-model", 
  RetrainingFrequency: "P1M", 
  RetrainingStartDate: <Date Representation>
 };
 lookoutequipment.createRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
    ModelName: "sample-model", 
    Status: "PENDING"
   }
   */
 });

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  LookbackWindow: 'STRING_VALUE', /* required */
  ModelName: 'STRING_VALUE', /* required */
  RetrainingFrequency: 'STRING_VALUE', /* required */
  PromoteMode: MANAGED | MANUAL,
  RetrainingStartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
lookoutequipment.createRetrainingScheduler(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 model to add the retraining scheduler to.

  • RetrainingStartDate — (Date)

    The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

  • RetrainingFrequency — (String)

    This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:

    • P3M15D – Every 3 months and 15 days

    • P2M – Every 2 months

    • P150D – Every 150 days

  • LookbackWindow — (String)

    The number of past days of data that will be used for retraining.

  • PromoteMode — (String)

    Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.

    Possible values include:
    • "MANAGED"
    • "MANUAL"
  • 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:

    • ModelName — (String)

      The name of the model that you added the retraining scheduler to.

    • ModelArn — (String)

      The ARN of the model that you added the retraining scheduler to.

    • Status — (String)

      The status of the retraining scheduler.

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

Returns:

• (AWS.Request) —

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

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.

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.

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

    The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • LabelId — (String)

    The ID of the label that you want to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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 machine learning 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.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lookoutequipment.deleteResourcePolicy(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 for which the resource policy should 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.

/*  */

 var params = {
  ModelName: "sample-model"
 };
 lookoutequipment.deleteRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.deleteRetrainingScheduler(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 model whose retraining scheduler you want to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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.

      • S3InputConfiguration — required — (map)

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

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

        • KeyPattern — (String)

          The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/ is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

          Valid Values: {prefix}/{component_name}_ | {prefix}/{component_name}/ | {prefix}/{component_name}[DELIMITER] (Allowed delimiters : space, dot, underscore, hyphen)

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

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

    • DataQualitySummary — (map)

      Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

      • InsufficientSensorData — required — (map)

        Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.

        • MissingCompleteSensorData — required — (map)

          Parameter that describes the total number of sensors that have data completely missing for it.

          • AffectedSensorCount — required — (Integer)

            Indicates the number of sensors that have data missing completely.

        • SensorsWithShortDateRange — required — (map)

          Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall.

          • AffectedSensorCount — required — (Integer)

            Indicates the number of sensors that have less than 14 days of data.

      • MissingSensorData — required — (map)

        Parameter that gives information about data that is missing over all the sensors in the input data.

        • AffectedSensorCount — required — (Integer)

          Indicates the number of sensors that have atleast some data missing.

        • TotalNumberOfMissingValues — required — (Integer)

          Indicates the total number of missing values across all the sensors.

      • InvalidSensorData — required — (map)

        Parameter that gives information about data that is invalid over all the sensors in the input data.

        • AffectedSensorCount — required — (Integer)

          Indicates the number of sensors that have at least some invalid values.

        • TotalNumberOfInvalidValues — required — (Integer)

          Indicates the total number of invalid values across all the sensors.

      • UnsupportedTimestamps — required — (map)

        Parameter that gives information about unsupported timestamps in the input data.

        • TotalNumberOfUnsupportedTimestamps — required — (Integer)

          Indicates the total number of unsupported timestamps across the ingested data.

      • DuplicateTimestamps — required — (map)

        Parameter that gives information about duplicate timestamps in the input data.

        • TotalNumberOfDuplicateTimestamps — required — (Integer)

          Indicates the total number of duplicate timestamps.

    • IngestedFilesSummary — (map)

      Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

      • TotalNumberOfFiles — required — (Integer)

        Indicates the total number of files that were submitted for ingestion.

      • IngestedNumberOfFiles — required — (Integer)

        Indicates the number of files that were successfully ingested.

      • DiscardedFiles — (Array<map>)

        Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

        • Bucket — required — (String)

          The name of the specific S3 bucket.

        • Key — required — (String)

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

    • StatusDetail — (String)

      Provides details about status of the ingestion job that is currently in progress.

    • IngestedDataSize — (Integer)

      Indicates the size of the ingested dataset.

    • DataStartTime — (Date)

      Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

    • DataEndTime — (Date)

      Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

    • SourceDatasetArn — (String)

      The Amazon Resource Name (ARN) of the source dataset from which the data used for the data ingestion job was imported from.

Returns:

• (AWS.Request) —

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

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 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"
      • "IMPORT_IN_PROGRESS"
    • 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 KMS key 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.

      • S3InputConfiguration — required — (map)

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

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

        • KeyPattern — (String)

          The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/ is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

          Valid Values: {prefix}/{component_name}_ | {prefix}/{component_name}/ | {prefix}/{component_name}[DELIMITER] (Allowed delimiters : space, dot, underscore, hyphen)

    • DataQualitySummary — (map)

      Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

      • InsufficientSensorData — required — (map)

        Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.

        • MissingCompleteSensorData — required — (map)

          Parameter that describes the total number of sensors that have data completely missing for it.

          • AffectedSensorCount — required — (Integer)

            Indicates the number of sensors that have data missing completely.

        • SensorsWithShortDateRange — required — (map)

          Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall.

          • AffectedSensorCount — required — (Integer)

            Indicates the number of sensors that have less than 14 days of data.

      • MissingSensorData — required — (map)

        Parameter that gives information about data that is missing over all the sensors in the input data.

        • AffectedSensorCount — required — (Integer)

          Indicates the number of sensors that have atleast some data missing.

        • TotalNumberOfMissingValues — required — (Integer)

          Indicates the total number of missing values across all the sensors.

      • InvalidSensorData — required — (map)

        Parameter that gives information about data that is invalid over all the sensors in the input data.

        • AffectedSensorCount — required — (Integer)

          Indicates the number of sensors that have at least some invalid values.

        • TotalNumberOfInvalidValues — required — (Integer)

          Indicates the total number of invalid values across all the sensors.

      • UnsupportedTimestamps — required — (map)

        Parameter that gives information about unsupported timestamps in the input data.

        • TotalNumberOfUnsupportedTimestamps — required — (Integer)

          Indicates the total number of unsupported timestamps across the ingested data.

      • DuplicateTimestamps — required — (map)

        Parameter that gives information about duplicate timestamps in the input data.

        • TotalNumberOfDuplicateTimestamps — required — (Integer)

          Indicates the total number of duplicate timestamps.

    • IngestedFilesSummary — (map)

      IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

      • TotalNumberOfFiles — required — (Integer)

        Indicates the total number of files that were submitted for ingestion.

      • IngestedNumberOfFiles — required — (Integer)

        Indicates the number of files that were successfully ingested.

      • DiscardedFiles — (Array<map>)

        Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

        • Bucket — required — (String)

          The name of the specific S3 bucket.

        • Key — required — (String)

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

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

    • DataStartTime — (Date)

      Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

    • DataEndTime — (Date)

      Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

    • SourceDatasetArn — (String)

      The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

Returns:

• (AWS.Request) —

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

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 machine learning model of the inference scheduler being described.

    • ModelName — (String)

      The name of the machine learning 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 Amazon S3 location of input data.

        • Bucket — required — (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 Coordinated Universal Time (UTC).

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

      • S3OutputConfiguration — required — (map)

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

        • Bucket — required — (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 KMS key 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 KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

    • LatestInferenceResult — (String)

      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

      Possible values include:
      • "ANOMALOUS"
      • "NORMAL"

Returns:

• (AWS.Request) —

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

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

    Returns the name of the group containing the label.

  • LabelId — (String)

    Returns the ID of the label.

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:

    • LabelGroupName — (String)

      The name of the requested label group.

    • LabelGroupArn — (String)

      The Amazon Resource Name (ARN) of the requested label group.

    • LabelId — (String)

      The ID of the requested label.

    • StartTime — (Date)

      The start time of the requested label.

    • EndTime — (Date)

      The end time of the requested label.

    • Rating — (String)

      Indicates whether a labeled event represents an anomaly.

      Possible values include:
      • "ANOMALY"
      • "NO_ANOMALY"
      • "NEUTRAL"
    • FaultCode — (String)

      Indicates the type of anomaly associated with the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • Notes — (String)

      Metadata providing additional information about the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • Equipment — (String)

      Indicates that a label pertains to a particular piece of equipment.

    • CreatedAt — (Date)

      The time at which the label was created.

Returns:

• (AWS.Request) —

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

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

    Returns the name of the label group.

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:

    • LabelGroupName — (String)

      The name of the label group.

    • LabelGroupArn — (String)

      The Amazon Resource Name (ARN) of the label group.

    • FaultCodes — (Array<String>)

      Codes indicating the type of anomaly associated with the labels in the lagbel group.

    • CreatedAt — (Date)

      The time at which the label group was created.

    • UpdatedAt — (Date)

      The time at which the label group was updated.

Returns:

• (AWS.Request) —

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

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 machine learning 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 machine learning model being described.

    • ModelArn — (String)

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

    • DatasetName — (String)

      The name of the dataset being used by the machine learning being described.

    • DatasetArn — (String)

      The Amazon Resouce Name (ARN) of the dataset used to create the machine learning 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.

      • S3InputConfiguration — (map)

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

        • Bucket — required — (String)

          The name of the S3 bucket holding the label data.

        • Prefix — (String)

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

      • LabelGroupName — (String)

        The name of the label group to be used for label data.

    • TrainingDataStartTime — (Date)

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

    • TrainingDataEndTime — (Date)

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

    • EvaluationDataStartTime — (Date)

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

    • EvaluationDataEndTime — (Date)

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

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning 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"
      • "IMPORT_IN_PROGRESS"
    • TrainingExecutionStartTime — (Date)

      Indicates the time at which the training of the machine learning model began.

    • TrainingExecutionEndTime — (Date)

      Indicates the time at which the training of the machine learning model was completed.

    • FailedReason — (String)

      If the training of the machine learning 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 machine learning model was updated. The type of update is not specified.

    • CreatedAt — (Date)

      Indicates the time and date at which the machine learning model was created.

    • ServerSideKmsKeyId — (String)

      Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

    • OffCondition — (String)

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

    • SourceModelVersionArn — (String)

      The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.

    • ImportJobStartTime — (Date)

      The date and time when the import job was started. This field appears if the active model version was imported.

    • ImportJobEndTime — (Date)

      The date and time when the import job was completed. This field appears if the active model version was imported.

    • ActiveModelVersion — (Integer)

      The name of the model version used by the inference schedular when running a scheduled inference execution.

    • ActiveModelVersionArn — (String)

      The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.

    • ModelVersionActivatedAt — (Date)

      The date the active model version was activated.

    • PreviousActiveModelVersion — (Integer)

      The model version that was set as the active model version prior to the current active model version.

    • PreviousActiveModelVersionArn — (String)

      The ARN of the model version that was set as the active model version prior to the current active model version.

    • PreviousModelVersionActivatedAt — (Date)

      The date and time when the previous active model version was activated.

    • PriorModelMetrics — (String)

      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

    • LatestScheduledRetrainingFailedReason — (String)

      If the model version was generated by retraining and the training failed, this indicates the reason for that failure.

    • LatestScheduledRetrainingStatus — (String)

      Indicates the status of the most recent scheduled retraining run.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"
      • "IMPORT_IN_PROGRESS"
      • "CANCELED"
    • LatestScheduledRetrainingModelVersion — (Integer)

      Indicates the most recent model version that was generated by retraining.

    • LatestScheduledRetrainingStartTime — (Date)

      Indicates the start time of the most recent scheduled retraining run.

    • LatestScheduledRetrainingAvailableDataInDays — (Integer)

      Indicates the number of days of data used in the most recent scheduled retraining run.

    • NextScheduledRetrainingStartDate — (Date)

      Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

    • AccumulatedInferenceDataStartTime — (Date)

      Indicates the start time of the inference data that has been accumulated.

    • AccumulatedInferenceDataEndTime — (Date)

      Indicates the end time of the inference data that has been accumulated.

    • RetrainingSchedulerStatus — (String)

      Indicates the status of the retraining scheduler.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "STOPPING"
      • "STOPPED"
    • ModelDiagnosticsOutputConfiguration — (map)

      Configuration information for the model's pointwise model diagnostics.

      • S3OutputConfiguration — required — (map)

        The Amazon S3 location for the pointwise model diagnostics.

        • Bucket — required — (String)

          The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

        • Prefix — (String)

          The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket).

          When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.

          When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.

      • KmsKeyId — (String)

        The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

    • ModelQuality — (String)

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      Possible values include:
      • "QUALITY_THRESHOLD_MET"
      • "CANNOT_DETERMINE_QUALITY"
      • "POOR_QUALITY_DETECTED"

Returns:

• (AWS.Request) —

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

var params = {
  ModelName: 'STRING_VALUE', /* required */
  ModelVersion: 'NUMBER_VALUE' /* required */
};
lookoutequipment.describeModelVersion(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 machine learning model that this version belongs to.

  • ModelVersion — (Integer)

    The version of the machine learning model.

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 machine learning model that this version belongs to.

    • ModelArn — (String)

      The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.

    • ModelVersion — (Integer)

      The version of the machine learning model.

    • ModelVersionArn — (String)

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

    • Status — (String)

      The current status of the model version.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"
      • "IMPORT_IN_PROGRESS"
      • "CANCELED"
    • SourceType — (String)

      Indicates whether this model version was created by training or by importing.

      Possible values include:
      • "TRAINING"
      • "RETRAINING"
      • "IMPORT"
    • DatasetName — (String)

      The name of the dataset used to train the model version.

    • DatasetArn — (String)

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

    • Schema — (String)

      The schema of the data used to train the model version.

    • LabelsInputConfiguration — (map)

      Contains the configuration information for the S3 location being used to hold label data.

      • S3InputConfiguration — (map)

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

        • Bucket — required — (String)

          The name of the S3 bucket holding the label data.

        • Prefix — (String)

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

      • LabelGroupName — (String)

        The name of the label group to be used for label data.

    • TrainingDataStartTime — (Date)

      The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.

    • TrainingDataEndTime — (Date)

      The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.

    • EvaluationDataStartTime — (Date)

      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.

    • EvaluationDataEndTime — (Date)

      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the role that was used to train the model version.

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

      The time when the training of the version began.

    • TrainingExecutionEndTime — (Date)

      The time when the training of the version completed.

    • FailedReason — (String)

      The failure message if the training of the model version failed.

    • ModelMetrics — (String)

      Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.

    • LastUpdatedTime — (Date)

      Indicates the last time the machine learning model version was updated.

    • CreatedAt — (Date)

      Indicates the time and date at which the machine learning model version was created.

    • ServerSideKmsKeyId — (String)

      The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.

    • OffCondition — (String)

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

    • SourceModelVersionArn — (String)

      If model version was imported, then this field is the arn of the source model version.

    • ImportJobStartTime — (Date)

      The date and time when the import job began. This field appears if the model version was imported.

    • ImportJobEndTime — (Date)

      The date and time when the import job completed. This field appears if the model version was imported.

    • ImportedDataSizeInBytes — (Integer)

      The size in bytes of the imported data. This field appears if the model version was imported.

    • PriorModelMetrics — (String)

      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

    • RetrainingAvailableDataInDays — (Integer)

      Indicates the number of days of data used in the most recent scheduled retraining run.

    • AutoPromotionResult — (String)

      Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.

      Possible values include:
      • "MODEL_PROMOTED"
      • "MODEL_NOT_PROMOTED"
      • "RETRAINING_INTERNAL_ERROR"
      • "RETRAINING_CUSTOMER_ERROR"
      • "RETRAINING_CANCELLED"
    • AutoPromotionResultReason — (String)

      Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.

    • ModelDiagnosticsOutputConfiguration — (map)

      The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.

      • S3OutputConfiguration — required — (map)

        The Amazon S3 location for the pointwise model diagnostics.

        • Bucket — required — (String)

          The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

        • Prefix — (String)

          The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket).

          When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.

          When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.

      • KmsKeyId — (String)

        The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

    • ModelDiagnosticsResultsObject — (map)

      The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.

      • Bucket — required — (String)

        The name of the specific S3 bucket.

      • Key — required — (String)

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

    • ModelQuality — (String)

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      Possible values include:
      • "QUALITY_THRESHOLD_MET"
      • "CANNOT_DETERMINE_QUALITY"
      • "POOR_QUALITY_DETECTED"

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lookoutequipment.describeResourcePolicy(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 that is associated with the resource policy.

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:

    • PolicyRevisionId — (String)

      A unique identifier for a revision of the resource policy.

    • ResourcePolicy — (String)

      The resource policy in a JSON-formatted string.

    • CreationTime — (Date)

      The time when the resource policy was created.

    • LastModifiedTime — (Date)

      The time when the resource policy was last modified.

Returns:

• (AWS.Request) —

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

/*  */

 var params = {
  ModelName: "sample-model"
 };
 lookoutequipment.describeRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreatedAt: <Date Representation>, 
    LookbackWindow: "P360D", 
    ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
    ModelName: "sample-model", 
    PromoteMode: "MANAGED", 
    RetrainingFrequency: "P1M", 
    RetrainingStartDate: <Date Representation>, 
    Status: "RUNNING", 
    UpdatedAt: <Date Representation>
   }
   */
 });

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.describeRetrainingScheduler(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 model that the retraining scheduler is attached to.

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 model that the retraining scheduler is attached to.

    • ModelArn — (String)

      The ARN of the model that the retraining scheduler is attached to.

    • RetrainingStartDate — (Date)

      The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

    • RetrainingFrequency — (String)

      The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

    • LookbackWindow — (String)

      The number of past days of data used for retraining.

    • Status — (String)

      The status of the retraining scheduler.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "STOPPING"
      • "STOPPED"
    • PromoteMode — (String)

      Indicates how the service uses new models. In MANAGED mode, new models are used for inference if they have better performance than the current model. In MANUAL mode, the new models are not used until they are manually activated.

      Possible values include:
      • "MANAGED"
      • "MANUAL"
    • CreatedAt — (Date)

      Indicates the time and date at which the retraining scheduler was created.

    • UpdatedAt — (Date)

      Indicates the time and date at which the retraining scheduler was updated.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  SourceDatasetArn: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE',
  ServerSideKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.importDataset(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: {}) —
  • SourceDatasetArn — (String)

    The Amazon Resource Name (ARN) of the dataset to import.

  • DatasetName — (String)

    The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.

  • 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.
  • ServerSideKmsKeyId — (String)

    Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.

  • Tags — (Array<map>)

    Any tags associated with the dataset to be created.

    • Key — required — (String)

      The key for the specified tag.

    • Value — required — (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 created machine learning dataset.

    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset that was imported.

    • Status — (String)

      The status of the ImportDataset operation.

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

      A unique identifier for the job of importing the dataset.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE', /* required */
  SourceModelVersionArn: 'STRING_VALUE', /* required */
  InferenceDataImportStrategy: NO_IMPORT | ADD_WHEN_EMPTY | OVERWRITE,
  LabelsInputConfiguration: {
    LabelGroupName: 'STRING_VALUE',
    S3InputConfiguration: {
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  ModelName: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  ServerSideKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutequipment.importModelVersion(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: {}) —
  • SourceModelVersionArn — (String)

    The Amazon Resource Name (ARN) of the model version to import.

  • ModelName — (String)

    The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.

  • DatasetName — (String)

    The name of the dataset for the machine learning model being imported.

  • LabelsInputConfiguration — (map)

    Contains the configuration information for the S3 location being used to hold label data.

    • S3InputConfiguration — (map)

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

      • Bucket — required — (String)

        The name of the S3 bucket holding the label data.

      • Prefix — (String)

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

    • LabelGroupName — (String)

      The name of the label group to be used for 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.
  • RoleArn — (String)

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

  • ServerSideKmsKeyId — (String)

    Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.

  • Tags — (Array<map>)

    The tags associated with the machine learning model to be created.

    • Key — required — (String)

      The key for the specified tag.

    • Value — required — (String)

      The value for the specified tag.

  • InferenceDataImportStrategy — (String)

    Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:

    • NO_IMPORT – Don't import the data.

    • ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.

    • OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.

    Possible values include:
    • "NO_IMPORT"
    • "ADD_WHEN_EMPTY"
    • "OVERWRITE"

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 for the machine learning model.

    • ModelArn — (String)

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

    • ModelVersionArn — (String)

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

    • ModelVersion — (Integer)

      The version of the model being created.

    • Status — (String)

      The status of the ImportModelVersion operation.

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

Returns:

• (AWS.Request) —

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

var params = {
  DatasetName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS
};
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"
    • "IMPORT_IN_PROGRESS"

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 Amazon S3 location parameters.

        • S3InputConfiguration — required — (map)

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

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

          • KeyPattern — (String)

            The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/ is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

            Valid Values: {prefix}/{component_name}_ | {prefix}/{component_name}/ | {prefix}/{component_name}[DELIMITER] (Allowed delimiters : space, dot, underscore, hyphen)

      • Status — (String)

        Indicates the status of the data ingestion job.

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

Returns:

• (AWS.Request) —

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

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

var params = {
  InferenceSchedulerName: 'STRING_VALUE', /* required */
  IntervalEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  IntervalStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutequipment.listInferenceEvents(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 events.

  • MaxResults — (Integer)

    Specifies the maximum number of inference events to list.

  • InferenceSchedulerName — (String)

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

  • IntervalStartTime — (Date)

    Lookout for Equipment will return all the inference events with an end time equal to or greater than the start time given.

  • IntervalEndTime — (Date)

    Returns all the inference events with an end start time equal to or greater than less than the end time given.

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.

    • InferenceEventSummaries — (Array<map>)

      Provides an array of information about the individual inference events returned from the ListInferenceEvents operation, including scheduler used, event start time, event end time, diagnostics, and so on.

      • InferenceSchedulerArn — (String)

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

      • InferenceSchedulerName — (String)

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

      • EventStartTime — (Date)

        Indicates the starting time of an inference event.

      • EventEndTime — (Date)

        Indicates the ending time of an inference event.

      • Diagnostics — (String)

        An array which specifies the names and values of all sensors contributing to an inference event.

      • EventDurationInSeconds — (Integer)

        Indicates the size of an inference event in seconds.

Returns:

• (AWS.Request) —

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

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.

      Note: If you don't supply the InferenceSchedulerName request parameter, or if you supply the name of an inference scheduler that doesn't exist, ListInferenceExecutions returns an empty array in InferenceExecutionSummaries.
      • ModelName — (String)

        The name of the machine learning model being used for the inference execution.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the machine learning 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 Amazon S3 location of input data.

          • Bucket — required — (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 Coordinated Universal Time (UTC).

        • 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 Amazon S3 location.

        • S3OutputConfiguration — required — (map)

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

          • Bucket — required — (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 KMS key key used to encrypt the inference output.

      • CustomerResultObject — (map)

        The S3 object that the inference execution results were uploaded to.

        • Bucket — required — (String)

          The name of the specific S3 bucket.

        • Key — required — (String)

          The Amazon Web Services Key Management Service (KMS key) 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.

      • ModelVersion — (Integer)

        The model version used for the inference execution.

      • ModelVersionArn — (String)

        The Amazon Resource Number (ARN) of the model version used for the inference execution.

Returns:

• (AWS.Request) —

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

var params = {
  InferenceSchedulerNameBeginsWith: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  ModelName: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: PENDING | RUNNING | STOPPING | STOPPED
};
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 machine learning model used by the inference scheduler to be listed.

  • Status — (String)

    Specifies the current status of the inference schedulers.

    Possible values include:
    • "PENDING"
    • "RUNNING"
    • "STOPPING"
    • "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:

    • 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 machine learning model used for the inference scheduler.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the machine learning 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"
      • LatestInferenceResult — (String)

        Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

        Possible values include:
        • "ANOMALOUS"
        • "NORMAL"

Returns:

• (AWS.Request) —

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

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

    The beginning of the name of the label groups to be listed.

  • NextToken — (String)

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

  • MaxResults — (Integer)

    Specifies the maximum number of label groups to list.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextToken — (String)

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

    • LabelGroupSummaries — (Array<map>)

      A summary of the label groups.

      • LabelGroupName — (String)

        The name of the label group.

      • LabelGroupArn — (String)

        The Amazon Resource Name (ARN) of the label group.

      • CreatedAt — (Date)

        The time at which the label group was created.

      • UpdatedAt — (Date)

        The time at which the label group was updated.

Returns:

• (AWS.Request) —

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

var params = {
  LabelGroupName: 'STRING_VALUE', /* required */
  Equipment: 'STRING_VALUE',
  FaultCode: 'STRING_VALUE',
  IntervalEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  IntervalStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutequipment.listLabels(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: {}) —
  • LabelGroupName — (String)

    Returns the name of the label group.

  • IntervalStartTime — (Date)

    Returns all the labels with a end time equal to or later than the start time given.

  • IntervalEndTime — (Date)

    Returns all labels with a start time earlier than the end time given.

  • FaultCode — (String)

    Returns labels with a particular fault code.

  • Equipment — (String)

    Lists the labels that pertain to a particular piece of equipment.

  • NextToken — (String)

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

  • MaxResults — (Integer)

    Specifies the maximum number of labels to list.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextToken — (String)

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

    • LabelSummaries — (Array<map>)

      A summary of the items in the label group.

      Note: If you don't supply the LabelGroupName request parameter, or if you supply the name of a label group that doesn't exist, ListLabels returns an empty array in LabelSummaries.
      • LabelGroupName — (String)

        The name of the label group.

      • LabelId — (String)

        The ID of the label.

      • LabelGroupArn — (String)

        The Amazon Resource Name (ARN) of the label group.

      • StartTime — (Date)

        The timestamp indicating the start of the label.

      • EndTime — (Date)

        The timestamp indicating the end of the label.

      • Rating — (String)

        Indicates whether a labeled event represents an anomaly.

        Possible values include:
        • "ANOMALY"
        • "NO_ANOMALY"
        • "NEUTRAL"
      • FaultCode — (String)

        Indicates the type of anomaly associated with the label.

        Data in this field will be retained for service usage. Follow best practices for the security of your data.

      • Equipment — (String)

        Indicates that a label pertains to a particular piece of equipment.

      • CreatedAt — (Date)

        The time at which the label was created.

Returns:

• (AWS.Request) —

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

var params = {
  DatasetNameBeginsWith: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  ModelNameBeginsWith: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS
};
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 machine learning models.

  • MaxResults — (Integer)

    Specifies the maximum number of machine learning models to list.

  • Status — (String)

    The status of the machine learning model.

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

    The beginning of the name of the machine learning models being listed.

  • DatasetNameBeginsWith — (String)

    The beginning of the name of the dataset of the machine learning 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 machine learning 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 machine learning model.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the machine learning model.

      • DatasetName — (String)

        The name of the dataset being used for the machine learning model.

      • DatasetArn — (String)

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

      • Status — (String)

        Indicates the status of the machine learning model.

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

        The time at which the specific model was created.

      • ActiveModelVersion — (Integer)

        The model version that the inference scheduler uses to run an inference execution.

      • ActiveModelVersionArn — (String)

        The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.

      • LatestScheduledRetrainingStatus — (String)

        Indicates the status of the most recent scheduled retraining run.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
        • "IMPORT_IN_PROGRESS"
        • "CANCELED"
      • LatestScheduledRetrainingModelVersion — (Integer)

        Indicates the most recent model version that was generated by retraining.

      • LatestScheduledRetrainingStartTime — (Date)

        Indicates the start time of the most recent scheduled retraining run.

      • NextScheduledRetrainingStartDate — (Date)

        Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

      • RetrainingSchedulerStatus — (String)

        Indicates the status of the retraining scheduler.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"
      • ModelDiagnosticsOutputConfiguration — (map)

        Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

        • S3OutputConfiguration — required — (map)

          The Amazon S3 location for the pointwise model diagnostics.

          • Bucket — required — (String)

            The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

          • Prefix — (String)

            The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket).

            When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.

            When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.

        • KmsKeyId — (String)

          The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

      • ModelQuality — (String)

        Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about using labels with your models, see Understanding labeling.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Possible values include:
        • "QUALITY_THRESHOLD_MET"
        • "CANNOT_DETERMINE_QUALITY"
        • "POOR_QUALITY_DETECTED"

Returns:

• (AWS.Request) —

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

var params = {
  ModelName: 'STRING_VALUE', /* required */
  CreatedAtEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreatedAtStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxModelVersion: 'NUMBER_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MinModelVersion: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SourceType: TRAINING | RETRAINING | IMPORT,
  Status: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED
};
lookoutequipment.listModelVersions(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)

    Then name of the machine learning model for which the model versions are to be listed.

  • NextToken — (String)

    If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.

  • MaxResults — (Integer)

    Specifies the maximum number of machine learning model versions to list.

  • Status — (String)

    Filter the results based on the current status of the model version.

    Possible values include:
    • "IN_PROGRESS"
    • "SUCCESS"
    • "FAILED"
    • "IMPORT_IN_PROGRESS"
    • "CANCELED"
  • SourceType — (String)

    Filter the results based on the way the model version was generated.

    Possible values include:
    • "TRAINING"
    • "RETRAINING"
    • "IMPORT"
  • CreatedAtEndTime — (Date)

    Filter results to return all the model versions created before this time.

  • CreatedAtStartTime — (Date)

    Filter results to return all the model versions created after this time.

  • MaxModelVersion — (Integer)

    Specifies the highest version of the model to return in the list.

  • MinModelVersion — (Integer)

    Specifies the lowest version of the model to return in the list.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextToken — (String)

      If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.

    • ModelVersionSummaries — (Array<map>)

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

      Note: If you don't supply the ModelName request parameter, or if you supply the name of a model that doesn't exist, ListModelVersions returns an empty array in ModelVersionSummaries.
      • ModelName — (String)

        The name of the model that this model version is a version of.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model that this model version is a version of.

      • ModelVersion — (Integer)

        The version of the model.

      • ModelVersionArn — (String)

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

      • CreatedAt — (Date)

        The time when this model version was created.

      • Status — (String)

        The current status of the model version.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
        • "IMPORT_IN_PROGRESS"
        • "CANCELED"
      • SourceType — (String)

        Indicates how this model version was generated.

        Possible values include:
        • "TRAINING"
        • "RETRAINING"
        • "IMPORT"
      • ModelQuality — (String)

        Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Possible values include:
        • "QUALITY_THRESHOLD_MET"
        • "CANNOT_DETERMINE_QUALITY"
        • "POOR_QUALITY_DETECTED"

Returns:

• (AWS.Request) —

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

/*  */

 var params = {
  MaxResults: 50
 };
 lookoutequipment.listRetrainingSchedulers(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    RetrainingSchedulerSummaries: [
       {
      LookbackWindow: "P180D", 
      ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
      ModelName: "sample-model-1", 
      RetrainingFrequency: "P1M", 
      RetrainingStartDate: <Date Representation>, 
      Status: "RUNNING"
     }, 
       {
      LookbackWindow: "P180D", 
      ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", 
      ModelName: "sample-model-2", 
      RetrainingFrequency: "P30D", 
      RetrainingStartDate: <Date Representation>, 
      Status: "RUNNING"
     }, 
       {
      LookbackWindow: "P360D", 
      ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", 
      ModelName: "sample-model-3", 
      RetrainingFrequency: "P1M", 
      RetrainingStartDate: <Date Representation>, 
      Status: "STOPPED"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  ModelNameBeginsWith: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: PENDING | RUNNING | STOPPING | STOPPED
};
lookoutequipment.listRetrainingSchedulers(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: {}) —
  • ModelNameBeginsWith — (String)

    Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.

  • Status — (String)

    Specify this field to only list retraining schedulers whose status matches the value you specify.

    Possible values include:
    • "PENDING"
    • "RUNNING"
    • "STOPPING"
    • "STOPPED"
  • NextToken — (String)

    If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.

  • MaxResults — (Integer)

    Specifies the maximum number of retraining schedulers to list.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • RetrainingSchedulerSummaries — (Array<map>)

      Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.

      • ModelName — (String)

        The name of the model that the retraining scheduler is attached to.

      • ModelArn — (String)

        The ARN of the model that the retraining scheduler is attached to.

      • Status — (String)

        The status of the retraining scheduler.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"
      • RetrainingStartDate — (Date)

        The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

      • RetrainingFrequency — (String)

        The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

      • LookbackWindow — (String)

        The number of past days of data used for retraining.

    • NextToken — (String)

      If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.

Returns:

• (AWS.Request) —

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

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  IngestionJobId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutequipment.listSensorStatistics(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 associated with the list of Sensor Statistics.

  • IngestionJobId — (String)

    The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.

  • MaxResults — (Integer)

    Specifies the maximum number of sensors for which to retrieve statistics.

  • NextToken — (String)

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

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:

    • SensorStatisticsSummaries — (Array<map>)

      Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

      • ComponentName — (String)

        Name of the component to which the particular sensor belongs for which the statistics belong to.

      • SensorName — (String)

        Name of the sensor that the statistics belong to.

      • DataExists — (Boolean)

        Parameter that indicates whether data exists for the sensor that the statistics belong to.

      • MissingValues — (map)

        Parameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.

        • Count — required — (Integer)

          Indicates the count of occurences of the given statistic.

        • Percentage — required — (Float)

          Indicates the percentage of occurances of the given statistic.

      • InvalidValues — (map)

        Parameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.

        • Count — required — (Integer)

          Indicates the count of occurences of the given statistic.

        • Percentage — required — (Float)

          Indicates the percentage of occurances of the given statistic.

      • InvalidDateEntries — (map)

        Parameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.

        • Count — required — (Integer)

          Indicates the count of occurences of the given statistic.

        • Percentage — required — (Float)

          Indicates the percentage of occurances of the given statistic.

      • DuplicateTimestamps — (map)

        Parameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.

        • Count — required — (Integer)

          Indicates the count of occurences of the given statistic.

        • Percentage — required — (Float)

          Indicates the percentage of occurances of the given statistic.

      • CategoricalValues — (map)

        Parameter that describes potential risk about whether data associated with the sensor is categorical.

        • Status — required — (String)

          Indicates whether there is a potential data issue related to categorical values.

          Possible values include:
          • "POTENTIAL_ISSUE_DETECTED"
          • "NO_ISSUE_DETECTED"
        • NumberOfCategory — (Integer)

          Indicates the number of categories in the data.

      • MultipleOperatingModes — (map)

        Parameter that describes potential risk about whether data associated with the sensor has more than one operating mode.

        • Status — required — (String)

          Indicates whether there is a potential data issue related to having multiple operating modes.

          Possible values include:
          • "POTENTIAL_ISSUE_DETECTED"
          • "NO_ISSUE_DETECTED"
      • LargeTimestampGaps — (map)

        Parameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.

        • Status — required — (String)

          Indicates whether there is a potential data issue related to large gaps in timestamps.

          Possible values include:
          • "POTENTIAL_ISSUE_DETECTED"
          • "NO_ISSUE_DETECTED"
        • NumberOfLargeTimestampGaps — (Integer)

          Indicates the number of large timestamp gaps, if there are any.

        • MaxTimestampGapInDays — (Integer)

          Indicates the size of the largest timestamp gap, in days.

      • MonotonicValues — (map)

        Parameter that describes potential risk about whether data associated with the sensor is mostly monotonic.

        • Status — required — (String)

          Indicates whether there is a potential data issue related to having monotonic values.

          Possible values include:
          • "POTENTIAL_ISSUE_DETECTED"
          • "NO_ISSUE_DETECTED"
        • Monotonicity — (String)

          Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.

          Possible values include:
          • "DECREASING"
          • "INCREASING"
          • "STATIC"
      • DataStartTime — (Date)

        Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.

      • DataEndTime — (Date)

        Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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.

      • Key — required — (String)

        The key for the specified tag.

      • Value — required — (String)

        The value for the specified tag.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  ResourcePolicy: 'STRING_VALUE', /* required */
  PolicyRevisionId: 'STRING_VALUE'
};
lookoutequipment.putResourcePolicy(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 for which the policy is being created.

  • ResourcePolicy — (String)

    The JSON-formatted resource policy to create.

  • PolicyRevisionId — (String)

    A unique identifier for a revision of the resource policy.

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

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource for which the policy was created.

    • PolicyRevisionId — (String)

      A unique identifier for a revision of the resource policy.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE', /* required */
  IngestionInputConfiguration: { /* required */
    S3InputConfiguration: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      KeyPattern: 'STRING_VALUE',
      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.

    • S3InputConfiguration — required — (map)

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

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

      • KeyPattern — (String)

        The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/ is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

        Valid Values: {prefix}/{component_name}_ | {prefix}/{component_name}/ | {prefix}/{component_name}[DELIMITER] (Allowed delimiters : space, dot, underscore, hyphen)

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

Returns:

• (AWS.Request) —

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

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 machine learning model being used by the inference scheduler.

    • ModelName — (String)

      The name of the machine learning 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.

/*  */

 var params = {
  ModelName: "sample-model"
 };
 lookoutequipment.startRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
    ModelName: "sample-model", 
    Status: "PENDING"
   }
   */
 });

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.startRetrainingScheduler(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 model whose retraining scheduler you want to start.

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 model whose retraining scheduler is being started.

    • ModelArn — (String)

      The ARN of the model whose retraining scheduler is being started.

    • Status — (String)

      The status of the retraining scheduler.

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

Returns:

• (AWS.Request) —

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

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 machine learning model used by the inference scheduler being stopped.

    • ModelName — (String)

      The name of the machine learning 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.

/*  */

 var params = {
  ModelName: "sample-model"
 };
 lookoutequipment.stopRetrainingScheduler(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ModelArn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", 
    ModelName: "sample-model", 
    Status: "STOPPING"
   }
   */
 });

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
lookoutequipment.stopRetrainingScheduler(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 model whose retraining scheduler you want to stop.

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 model whose retraining scheduler is being stopped.

    • ModelArn — (String)

      The ARN of the model whose retraining scheduler is being stopped.

    • Status — (String)

      The status of the retraining scheduler.

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