Class: AWS.LookoutVision

var params = {
  OutputConfig: { /* required */
    S3Location: { /* required */
      Bucket: 'STRING_VALUE', /* required */
      Prefix: 'STRING_VALUE'
    }
  },
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The name of the project in which you want to create a model version.

  • Description — (String)

    A description for the version of the model.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from starting multiple training jobs. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.

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

    The location where Amazon Lookout for Vision saves the training results.

    • S3Location — required — (map)

      The S3 location for the output.

      • Bucket — required — (String)

        The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

      • Prefix — (String)

        The path of the folder, within the S3 bucket, that contains the output.

  • KmsKeyId — (String)

    The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

  • Tags — (Array<map>)

    A set of tags (key-value pairs) that you want to attach to the model.

    • Key — required — (String)

      The key of the tag that is attached to the specified model.

    • Value — required — (String)

      The value of the tag that is attached to the specified 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:

    • ModelMetadata — (map)

      The response from a call to CreateModel.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the model was created.

      • ModelVersion — (String)

        The version of the model.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model.

      • Description — (String)

        The description for the model.

      • Status — (String)

        The status of the model.

        Possible values include:
        • "TRAINING"
        • "TRAINED"
        • "TRAINING_FAILED"
        • "STARTING_HOSTING"
        • "HOSTED"
        • "HOSTING_FAILED"
        • "STOPPING_HOSTING"
        • "SYSTEM_UPDATING"
        • "DELETING"
      • StatusMessage — (String)

        The status message for the model.

      • Performance — (map)

        Performance metrics for the model. Not available until training has successfully completed.

        • F1Score — (Float)

          The overall F1 score metric for the trained model.

        • Recall — (Float)

          The overall recall metric value for the trained model.

        • Precision — (Float)

          The overall precision metric value for the trained model.

Returns:

• (AWS.Request) —

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

var params = {
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.createProject(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: {}) —
  • ProjectName — (String)

    The name for the project.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to CreateProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateProject. In this case, safely retry your call to CreateProject by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project creation requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateProject. An idempotency token is active for 8 hours.

    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:

    • ProjectMetadata — (map)

      Information about the project.

      • ProjectArn — (String)

        The Amazon Resource Name (ARN) of the project.

      • ProjectName — (String)

        The name of the project.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the project was created.

Returns:

• (AWS.Request) —

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

var params = {
  DatasetType: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The name of the project that contains the dataset that you want to delete.

  • DatasetType — (String)

    The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to DeleteDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset. In this case, safely retry your call to DeleteDataset by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple deletetion requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteDataset. An idempotency token is active for 8 hours.

    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.

Returns:

• (AWS.Request) —

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

var params = {
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model that you want to delete.

  • ModelVersion — (String)

    The version of the model that you want to delete.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple model deletion requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteModel. An idempotency token is active for 8 hours.

    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:

    • ModelArn — (String)

      The Amazon Resource Name (ARN) of the model that was deleted.

Returns:

• (AWS.Request) —

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

var params = {
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.deleteProject(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: {}) —
  • ProjectName — (String)

    The name of the project to delete.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to DeleteProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteProject. In this case, safely retry your call to DeleteProject by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project deletion requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteProject. An idempotency token is active for 8 hours.

    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:

    • ProjectArn — (String)

      The Amazon Resource Name (ARN) of the project that was deleted.

Returns:

• (AWS.Request) —

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

var params = {
  DatasetType: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE' /* required */
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The name of the project that contains the dataset that you want to describe.

  • DatasetType — (String)

    The type of the dataset to describe. Specify train to describe the training dataset. Specify test to describe the test dataset. If you have a single dataset project, specify train

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:

    • DatasetDescription — (map)

      The description of the requested dataset.

      • ProjectName — (String)

        The name of the project that contains the dataset.

      • DatasetType — (String)

        The type of the dataset. The value train represents a training dataset or single dataset project. The value test represents a test dataset.

      • CreationTimestamp — (Date)

        The Unix timestamp for the time and date that the dataset was created.

      • LastUpdatedTimestamp — (Date)

        The Unix timestamp for the date and time that the dataset was last updated.

      • Status — (String)

        The status of the dataset.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_COMPLETE"
        • "CREATE_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_COMPLETE"
        • "UPDATE_FAILED_ROLLBACK_IN_PROGRESS"
        • "UPDATE_FAILED_ROLLBACK_COMPLETE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
      • StatusMessage — (String)

        The status message for the dataset.

      • ImageStats — (map)

        Statistics about the images in a dataset.

        • Total — (Integer)

          The total number of images in the dataset.

        • Labeled — (Integer)

          The total number of labeled images.

        • Normal — (Integer)

          The total number of images labeled as normal.

        • Anomaly — (Integer)

          the total number of images labeled as an anomaly.

Returns:

• (AWS.Request) —

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

var params = {
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE' /* required */
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The project that contains the version of a model that you want to describe.

  • ModelVersion — (String)

    The version of the model that you want to describe.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ModelDescription — (map)

      Contains the description of the model.

      • ModelVersion — (String)

        The version of the model

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the model was created.

      • Description — (String)

        The description for the model.

      • Status — (String)

        The status of the model.

        Possible values include:
        • "TRAINING"
        • "TRAINED"
        • "TRAINING_FAILED"
        • "STARTING_HOSTING"
        • "HOSTED"
        • "HOSTING_FAILED"
        • "STOPPING_HOSTING"
        • "SYSTEM_UPDATING"
        • "DELETING"
      • StatusMessage — (String)

        The status message for the model.

      • Performance — (map)

        Performance metrics for the model. Created during training.

        • F1Score — (Float)

          The overall F1 score metric for the trained model.

        • Recall — (Float)

          The overall recall metric value for the trained model.

        • Precision — (Float)

          The overall precision metric value for the trained model.

      • OutputConfig — (map)

        The S3 location where Amazon Lookout for Vision saves model training files.

        • S3Location — required — (map)

          The S3 location for the output.

          • Bucket — required — (String)

            The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

          • Prefix — (String)

            The path of the folder, within the S3 bucket, that contains the output.

      • EvaluationManifest — (map)

        The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

        • Bucket — required — (String)

          The bucket that contains the training output.

        • Key — required — (String)

          The location of the training output in the bucket.

      • EvaluationResult — (map)

        The S3 location where Amazon Lookout for Vision saves the performance metrics.

        • Bucket — required — (String)

          The bucket that contains the training output.

        • Key — required — (String)

          The location of the training output in the bucket.

      • EvaluationEndTimestamp — (Date)

        The unix timestamp for the date and time that the evaluation ended.

      • KmsKeyId — (String)

        The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

      • MinInferenceUnits — (Integer)

        The minimum number of inference units used by the model. For more information, see StartModel

      • MaxInferenceUnits — (Integer)

        The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

Returns:

• (AWS.Request) —

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

var params = {
  JobName: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE' /* required */
};
lookoutvision.describeModelPackagingJob(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model packaging job that you want to describe.

  • JobName — (String)

    The job name for the model packaging 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:

    • ModelPackagingDescription — (map)

      The description of the model packaging job.

      • JobName — (String)

        The name of the model packaging job.

      • ProjectName — (String)

        The name of the project that's associated with a model that's in the model package.

      • ModelVersion — (String)

        The version of the model used in the model packaging job.

      • ModelPackagingConfiguration — (map)

        The configuration information used in the model packaging job.

        • Greengrass — required — (map)

          Configuration information for the AWS IoT Greengrass component in a model packaging job.

          • CompilerOptions — (String)

            Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don't specify CompilerOptions.

            For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

          • TargetDevice — (String)

            The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.

            Possible values include:
            • "jetson_xavier"
          • TargetPlatform — (map)

            The target platform for the model. If you specify TargetPlatform, you can't specify TargetDevice.

            • Os — required — (String)

              The target operating system for the model. Linux is the only operating system that is currently supported.

              Possible values include:
              • "LINUX"
            • Arch — required — (String)

              The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).

              Possible values include:
              • "ARM64"
              • "X86_64"
            • Accelerator — (String)

              The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver, and cuda-ver compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:

              • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}

              • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

              Possible values include:
              • "NVIDIA"
          • S3OutputLocation — required — (map)

            An S3 location in which Lookout for Vision stores the component artifacts.

            • Bucket — required — (String)

              The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

            • Prefix — (String)

              The path of the folder, within the S3 bucket, that contains the output.

          • ComponentName — required — (String)

            A name for the AWS IoT Greengrass component.

          • ComponentVersion — (String)

            A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0 is used.

          • ComponentDescription — (String)

            A description for the AWS IoT Greengrass component.

          • Tags — (Array<map>)

            A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

            • Key — required — (String)

              The key of the tag that is attached to the specified model.

            • Value — required — (String)

              The value of the tag that is attached to the specified model.

      • ModelPackagingJobDescription — (String)

        The description for the model packaging job.

      • ModelPackagingMethod — (String)

        The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

      • ModelPackagingOutputDetails — (map)

        Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob.

        • Greengrass — (map)

          Information about the AWS IoT Greengrass component in a model packaging job.

          • ComponentVersionArn — (String)

            The Amazon Resource Name (ARN) of the component.

          • ComponentName — (String)

            The name of the component.

          • ComponentVersion — (String)

            The version of the component.

      • Status — (String)

        The status of the model packaging job.

        Possible values include:
        • "CREATED"
        • "RUNNING"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        The status message for the model packaging job.

      • CreationTimestamp — (Date)

        The Unix timestamp for the time and date that the model packaging job was created.

      • LastUpdatedTimestamp — (Date)

        The Unix timestamp for the time and date that the model packaging job was last updated.

Returns:

• (AWS.Request) —

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

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

    The name of the project that you want to describe.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectDescription — (map)

      The description of the project.

      • ProjectArn — (String)

        The Amazon Resource Name (ARN) of the project.

      • ProjectName — (String)

        The name of the project.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the project was created.

      • Datasets — (Array<map>)

        A list of datasets in the project.

        • DatasetType — (String)

          The type of the dataset.

        • CreationTimestamp — (Date)

          The Unix timestamp for the date and time that the dataset was created.

        • Status — (String)

          The status for the dataset.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_COMPLETE"
          • "CREATE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_FAILED_ROLLBACK_IN_PROGRESS"
          • "UPDATE_FAILED_ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_COMPLETE"
          • "DELETE_FAILED"
        • StatusMessage — (String)

          The status message for the dataset.

Returns:

• (AWS.Request) —

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

var params = {
  Body: Buffer.from('...') || 'STRING_VALUE' || streamObject, /* required */
  ContentType: 'STRING_VALUE', /* required */
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE' /* required */
};
lookoutvision.detectAnomalies(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model version that you want to use.

  • ModelVersion — (String)

    The version of the model that you want to use.

  • Body — (Buffer, Typed Array, Blob, String, ReadableStream)

    The unencrypted image bytes that you want to analyze.

  • ContentType — (String)

    The type of the image passed in Body. Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

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:

    • DetectAnomalyResult — (map)

      The results of the DetectAnomalies operation.

      • Source — (map)

        The source of the image that was analyzed. direct means that the images was supplied from the local computer. No other values are supported.

        • Type — (String)

          The type of the image.

      • IsAnomalous — (Boolean)

        True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.

      • Confidence — (Float)

        The confidence that Lookout for Vision has in the accuracy of the classification in IsAnomalous.

      • Anomalies — (Array<map>)

        If the model is an image segmentation model, Anomalies contains a list of anomaly types found in the image. There is one entry for each type of anomaly found (even if multiple instances of an anomaly type exist on the image). The first element in the list is always an anomaly type representing the image background ('background') and shouldn't be considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the response, and you don't need to declare a background anomaly type in your dataset.

        If the list has one entry ('background'), no anomalies were found on the image.

        An image classification model doesn't return an Anomalies list.

        • Name — (String)

          The name of an anomaly type found in an image. Name maps to an anomaly type in the training dataset, apart from the anomaly type background. The service automatically inserts the background anomaly type into the response from DetectAnomalies.

        • PixelAnomaly — (map)

          Information about the pixel mask that covers an anomaly type.

          • TotalPercentageArea — (Float)

            The percentage area of the image that the anomaly type covers.

          • Color — (String)

            A hex color value for the mask that covers an anomaly type. Each anomaly type has a different mask color. The color maps to the color of the anomaly type used in the training dataset.

      • AnomalyMask — (Buffer, Typed Array, Blob, String)

        If the model is an image segmentation model, AnomalyMask contains pixel masks that covers all anomaly types found on the image. Each anomaly type has a different mask color. To map a color to an anomaly type, see the color field of the PixelAnomaly object.

        An image classification model doesn't return an Anomalies list.

Returns:

• (AWS.Request) —

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

var params = {
  DatasetType: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  AfterCreationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  AnomalyClass: 'STRING_VALUE',
  BeforeCreationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Labeled: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SourceRefContains: 'STRING_VALUE'
};
lookoutvision.listDatasetEntries(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the dataset that you want to list.

  • DatasetType — (String)

    The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

  • Labeled — (Boolean)

    Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

  • AnomalyClass — (String)

    Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

  • BeforeCreationDate — (Date)

    Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

  • AfterCreationDate — (Date)

    Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

  • NextToken — (String)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

  • SourceRefContains — (String)

    Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches IMG_17.

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:

    • DatasetEntries — (Array<String>)

      A list of the entries (JSON Lines) within the dataset.

    • NextToken — (String)

      If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

Returns:

• (AWS.Request) —

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

var params = {
  ProjectName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutvision.listModelPackagingJobs(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: {}) —
  • ProjectName — (String)

    The name of the project for which you want to list the model packaging jobs.

  • NextToken — (String)

    If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

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:

    • ModelPackagingJobs — (Array<map>)

      A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.

      • JobName — (String)

        The name of the model packaging job.

      • ProjectName — (String)

        The project that contains the model that is in the model package.

      • ModelVersion — (String)

        The version of the model that is in the model package.

      • ModelPackagingJobDescription — (String)

        The description for the model packaging job.

      • ModelPackagingMethod — (String)

        The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

      • Status — (String)

        The status of the model packaging job.

        Possible values include:
        • "CREATED"
        • "RUNNING"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        The status message for the model packaging job.

      • CreationTimestamp — (Date)

        The Unix timestamp for the time and date that the model packaging job was created.

      • LastUpdatedTimestamp — (Date)

        The Unix timestamp for the time and date that the model packaging job was last updated.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  ProjectName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutvision.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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model versions that you want to list.

  • NextToken — (String)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

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:

    • Models — (Array<map>)

      A list of model versions in the specified project.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the model was created.

      • ModelVersion — (String)

        The version of the model.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model.

      • Description — (String)

        The description for the model.

      • Status — (String)

        The status of the model.

        Possible values include:
        • "TRAINING"
        • "TRAINED"
        • "TRAINING_FAILED"
        • "STARTING_HOSTING"
        • "HOSTED"
        • "HOSTING_FAILED"
        • "STOPPING_HOSTING"
        • "SYSTEM_UPDATING"
        • "DELETING"
      • StatusMessage — (String)

        The status message for the model.

      • Performance — (map)

        Performance metrics for the model. Not available until training has successfully completed.

        • F1Score — (Float)

          The overall F1 score metric for the trained model.

        • Recall — (Float)

          The overall recall metric value for the trained model.

        • Precision — (Float)

          The overall precision metric value for the trained model.

    • NextToken — (String)

      If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lookoutvision.listProjects(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)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

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:

    • Projects — (Array<map>)

      A list of projects in your AWS account.

      • ProjectArn — (String)

        The Amazon Resource Name (ARN) of the project.

      • ProjectName — (String)

        The name of the project.

      • CreationTimestamp — (Date)

        The unix timestamp for the date and time that the project was created.

    • NextToken — (String)

      If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lookoutvision.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 model for which you want to list tags.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Tags — (Array<map>)

      A map of tag keys and values attached to the specified model.

      • Key — required — (String)

        The key of the tag that is attached to the specified model.

      • Value — required — (String)

        The value of the tag that is attached to the specified model.

Returns:

• (AWS.Request) —

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

var params = {
  MinInferenceUnits: 'NUMBER_VALUE', /* required */
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  MaxInferenceUnits: 'NUMBER_VALUE'
};
lookoutvision.startModel(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model that you want to start.

  • ModelVersion — (String)

    The version of the model that you want to start.

  • MinInferenceUnits — (Integer)

    The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModel. An idempotency token is active for 8 hours.

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

    The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the 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:

    • Status — (String)

      The current running status of the model.

      Possible values include:
      • "STARTING_HOSTING"
      • "HOSTED"
      • "HOSTING_FAILED"
      • "STOPPING_HOSTING"
      • "SYSTEM_UPDATING"

Returns:

• (AWS.Request) —

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

var params = {
  Configuration: { /* required */
    Greengrass: { /* required */
      ComponentName: 'STRING_VALUE', /* required */
      S3OutputLocation: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Prefix: 'STRING_VALUE'
      },
      CompilerOptions: 'STRING_VALUE',
      ComponentDescription: 'STRING_VALUE',
      ComponentVersion: 'STRING_VALUE',
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      TargetDevice: jetson_xavier,
      TargetPlatform: {
        Arch: ARM64 | X86_64, /* required */
        Os: LINUX, /* required */
        Accelerator: NVIDIA
      }
    }
  },
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  JobName: 'STRING_VALUE'
};
lookoutvision.startModelPackagingJob(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: {}) —
  • ProjectName — (String)

    The name of the project which contains the version of the model that you want to package.

  • ModelVersion — (String)

    The version of the model within the project that you want to package.

  • JobName — (String)

    A name for the model packaging job. If you don't supply a value, the service creates a job name for you.

  • Configuration — (map)

    The configuration for the model packaging job.

    • Greengrass — required — (map)

      Configuration information for the AWS IoT Greengrass component in a model packaging job.

      • CompilerOptions — (String)

        Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don't specify CompilerOptions.

        For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

      • TargetDevice — (String)

        The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.

        Possible values include:
        • "jetson_xavier"
      • TargetPlatform — (map)

        The target platform for the model. If you specify TargetPlatform, you can't specify TargetDevice.

        • Os — required — (String)

          The target operating system for the model. Linux is the only operating system that is currently supported.

          Possible values include:
          • "LINUX"
        • Arch — required — (String)

          The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).

          Possible values include:
          • "ARM64"
          • "X86_64"
        • Accelerator — (String)

          The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver, and cuda-ver compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:

          • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}

          • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

          Possible values include:
          • "NVIDIA"
      • S3OutputLocation — required — (map)

        An S3 location in which Lookout for Vision stores the component artifacts.

        • Bucket — required — (String)

          The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

        • Prefix — (String)

          The path of the folder, within the S3 bucket, that contains the output.

      • ComponentName — required — (String)

        A name for the AWS IoT Greengrass component.

      • ComponentVersion — (String)

        A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0 is used.

      • ComponentDescription — (String)

        A description for the AWS IoT Greengrass component.

      • Tags — (Array<map>)

        A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

        • Key — required — (String)

          The key of the tag that is attached to the specified model.

        • Value — required — (String)

          The value of the tag that is attached to the specified model.

  • Description — (String)

    A description for the model packaging job.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency token is active for 8 hours.

    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:

    • JobName — (String)

      The job name for the model packaging job. If you don't supply a job name in the JobName input parameter, the service creates a job name for you.

Returns:

• (AWS.Request) —

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

var params = {
  ModelVersion: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.stopModel(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the model that you want to stop.

  • ModelVersion — (String)

    The version of the model that you want to stop.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to StopModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StopModel. In this case, safely retry your call to StopModel by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple stop requests. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StopModel. An idempotency token is active for 8 hours.

    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:

    • Status — (String)

      The status of the model.

      Possible values include:
      • "STARTING_HOSTING"
      • "HOSTED"
      • "HOSTING_FAILED"
      • "STOPPING_HOSTING"
      • "SYSTEM_UPDATING"

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Amazon Resource Name (ARN) of the model to assign the tags.

  • Tags — (Array<map>)

    The key-value tags to assign to the model.

    • Key — required — (String)

      The key of the tag that is attached to the specified model.

    • Value — required — (String)

      The value of the tag that is attached to the specified 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.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Amazon Resource Name (ARN) of the model from which you want to remove tags.

  • TagKeys — (Array<String>)

    A list of the keys of the tags that you want to remove.

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 = {
  Changes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  DatasetType: 'STRING_VALUE', /* required */
  ProjectName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
lookoutvision.updateDatasetEntries(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: {}) —
  • ProjectName — (String)

    The name of the project that contains the dataset that you want to update.

  • DatasetType — (String)

    The type of the dataset that you want to update. Specify train to update the training dataset. Specify test to update the test dataset. If you have a single dataset project, specify train.

  • Changes — (Buffer, Typed Array, Blob, String)

    The entries to add to the dataset.

  • ClientToken — (String)

    ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries by using the same ClientToken parameter value.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple updates with the same dataset entries. You'll need to provide your own value for other use cases.

    An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to UpdateDatasetEntries. An idempotency token is active for 8 hours.

    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:

    • Status — (String)

      The status of the dataset update.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "CREATE_COMPLETE"
      • "CREATE_FAILED"
      • "UPDATE_IN_PROGRESS"
      • "UPDATE_COMPLETE"
      • "UPDATE_FAILED_ROLLBACK_IN_PROGRESS"
      • "UPDATE_FAILED_ROLLBACK_COMPLETE"
      • "DELETE_IN_PROGRESS"
      • "DELETE_COMPLETE"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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