Class: AWS.SageMaker

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

Overview

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

Service Description

Provides APIs for creating and managing Amazon SageMaker resources.

Sending a Request Using SageMaker

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

Locking the API Version

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

var sagemaker = new AWS.SageMaker({apiVersion: '2017-07-24'});

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

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

var sagemaker = new AWS.SageMaker();

Version:

  • 2017-07-24

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

notebookInstanceInService, notebookInstanceStopped, notebookInstanceDeleted, trainingJobCompletedOrStopped, endpointInService, endpointDeleted, transformJobCompletedOrStopped

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a SageMaker object

var sagemaker = new AWS.SageMaker({apiVersion: '2017-07-24'});

Options Hash (options):

  • params (map) —

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

  • endpoint (String) —

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

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

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

  • credentialProvider (AWS.CredentialProviderChain) —

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

  • region (String) —

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

  • retryDelayOptions (map) —

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

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

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

  • stsRegionalEndpoints ('legacy'|'regional') —

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies.

Note: Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Service Reference:

Examples:

Calling the addTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.addTags(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 you want to tag.

    • Tags — (Array<map>)

      An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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 list of tags associated with the Amazon SageMaker resource.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

Returns:

  • (AWS.Request) —

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

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

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.

Service Reference:

Examples:

Calling the createAlgorithm operation

var params = {
  AlgorithmName: 'STRING_VALUE', /* required */
  TrainingSpecification: { /* required */
    SupportedTrainingInstanceTypes: [ /* required */
      ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge,
      /* more items */
    ],
    TrainingChannels: [ /* required */
      {
        Name: 'STRING_VALUE', /* required */
        SupportedContentTypes: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SupportedInputModes: [ /* required */
          Pipe | File,
          /* more items */
        ],
        Description: 'STRING_VALUE',
        IsRequired: true || false,
        SupportedCompressionTypes: [
          None | Gzip,
          /* more items */
        ]
      },
      /* more items */
    ],
    TrainingImage: 'STRING_VALUE', /* required */
    MetricDefinitions: [
      {
        Name: 'STRING_VALUE', /* required */
        Regex: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    SupportedHyperParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Type: Integer | Continuous | Categorical | FreeText, /* required */
        DefaultValue: 'STRING_VALUE',
        Description: 'STRING_VALUE',
        IsRequired: true || false,
        IsTunable: true || false,
        Range: {
          CategoricalParameterRangeSpecification: {
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          ContinuousParameterRangeSpecification: {
            MaxValue: 'STRING_VALUE', /* required */
            MinValue: 'STRING_VALUE' /* required */
          },
          IntegerParameterRangeSpecification: {
            MaxValue: 'STRING_VALUE', /* required */
            MinValue: 'STRING_VALUE' /* required */
          }
        }
      },
      /* more items */
    ],
    SupportedTuningJobObjectiveMetrics: [
      {
        MetricName: 'STRING_VALUE', /* required */
        Type: Maximize | Minimize /* required */
      },
      /* more items */
    ],
    SupportsDistributedTraining: true || false,
    TrainingImageDigest: 'STRING_VALUE'
  },
  AlgorithmDescription: 'STRING_VALUE',
  CertifyForMarketplace: true || false,
  InferenceSpecification: {
    Containers: [ /* required */
      {
        Image: 'STRING_VALUE', /* required */
        ContainerHostname: 'STRING_VALUE',
        ImageDigest: 'STRING_VALUE',
        ModelDataUrl: 'STRING_VALUE',
        ProductId: 'STRING_VALUE'
      },
      /* more items */
    ],
    SupportedContentTypes: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SupportedRealtimeInferenceInstanceTypes: [ /* required */
      ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.c4.large | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.18xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge,
      /* more items */
    ],
    SupportedResponseMIMETypes: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SupportedTransformInstanceTypes: [ /* required */
      ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge,
      /* more items */
    ]
  },
  ValidationSpecification: {
    ValidationProfiles: [ /* required */
      {
        ProfileName: 'STRING_VALUE', /* required */
        TrainingJobDefinition: { /* required */
          InputDataConfig: [ /* required */
            {
              ChannelName: 'STRING_VALUE', /* required */
              DataSource: { /* required */
                FileSystemDataSource: {
                  DirectoryPath: 'STRING_VALUE', /* required */
                  FileSystemAccessMode: rw | ro, /* required */
                  FileSystemId: 'STRING_VALUE', /* required */
                  FileSystemType: EFS | FSxLustre /* required */
                },
                S3DataSource: {
                  S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
                  S3Uri: 'STRING_VALUE', /* required */
                  AttributeNames: [
                    'STRING_VALUE',
                    /* more items */
                  ],
                  S3DataDistributionType: FullyReplicated | ShardedByS3Key
                }
              },
              CompressionType: None | Gzip,
              ContentType: 'STRING_VALUE',
              InputMode: Pipe | File,
              RecordWrapperType: None | RecordIO,
              ShuffleConfig: {
                Seed: 'NUMBER_VALUE' /* required */
              }
            },
            /* more items */
          ],
          OutputDataConfig: { /* required */
            S3OutputPath: 'STRING_VALUE', /* required */
            KmsKeyId: 'STRING_VALUE'
          },
          ResourceConfig: { /* required */
            InstanceCount: 'NUMBER_VALUE', /* required */
            InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge, /* required */
            VolumeSizeInGB: 'NUMBER_VALUE', /* required */
            VolumeKmsKeyId: 'STRING_VALUE'
          },
          StoppingCondition: { /* required */
            MaxRuntimeInSeconds: 'NUMBER_VALUE',
            MaxWaitTimeInSeconds: 'NUMBER_VALUE'
          },
          TrainingInputMode: Pipe | File, /* required */
          HyperParameters: {
            '<ParameterKey>': 'STRING_VALUE',
            /* '<ParameterKey>': ... */
          }
        },
        TransformJobDefinition: {
          TransformInput: { /* required */
            DataSource: { /* required */
              S3DataSource: { /* required */
                S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
                S3Uri: 'STRING_VALUE' /* required */
              }
            },
            CompressionType: None | Gzip,
            ContentType: 'STRING_VALUE',
            SplitType: None | Line | RecordIO | TFRecord
          },
          TransformOutput: { /* required */
            S3OutputPath: 'STRING_VALUE', /* required */
            Accept: 'STRING_VALUE',
            AssembleWith: None | Line,
            KmsKeyId: 'STRING_VALUE'
          },
          TransformResources: { /* required */
            InstanceCount: 'NUMBER_VALUE', /* required */
            InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge, /* required */
            VolumeKmsKeyId: 'STRING_VALUE'
          },
          BatchStrategy: MultiRecord | SingleRecord,
          Environment: {
            '<TransformEnvironmentKey>': 'STRING_VALUE',
            /* '<TransformEnvironmentKey>': ... */
          },
          MaxConcurrentTransforms: 'NUMBER_VALUE',
          MaxPayloadInMB: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    ValidationRole: 'STRING_VALUE' /* required */
  }
};
sagemaker.createAlgorithm(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: {}) —
    • AlgorithmName — (String)

      The name of the algorithm.

    • AlgorithmDescription — (String)

      A description of the algorithm.

    • TrainingSpecification — (map)

      Specifies details about training jobs run by this algorithm, including the following:

      • The Amazon ECR path of the container and the version digest of the algorithm.

      • The hyperparameters that the algorithm supports.

      • The instance types that the algorithm supports for training.

      • Whether the algorithm supports distributed training.

      • The metrics that the algorithm emits to Amazon CloudWatch.

      • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

      • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

      • TrainingImage — required — (String)

        The Amazon ECR registry path of the Docker image that contains the training algorithm.

      • TrainingImageDigest — (String)

        An MD5 hash of the training algorithm that identifies the Docker image used for training.

      • SupportedHyperParameters — (Array<map>)

        A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

        • Name — required — (String)

          The name of this hyperparameter. The name must be unique.

        • Description — (String)

          A brief description of the hyperparameter.

        • Type — required — (String)

          The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

          Possible values include:
          • "Integer"
          • "Continuous"
          • "Categorical"
          • "FreeText"
        • Range — (map)

          The allowed range for this hyperparameter.

          • IntegerParameterRangeSpecification — (map)

            A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

            • MinValue — required — (String)

              The minimum integer value allowed.

            • MaxValue — required — (String)

              The maximum integer value allowed.

          • ContinuousParameterRangeSpecification — (map)

            A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

            • MinValue — required — (String)

              The minimum floating-point value allowed.

            • MaxValue — required — (String)

              The maximum floating-point value allowed.

          • CategoricalParameterRangeSpecification — (map)

            A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

            • Values — required — (Array<String>)

              The allowed categories for the hyperparameter.

        • IsTunable — (Boolean)

          Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

        • IsRequired — (Boolean)

          Indicates whether this hyperparameter is required.

        • DefaultValue — (String)

          The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

      • SupportedTrainingInstanceTypes — required — (Array<String>)

        A list of the instance types that this algorithm can use for training.

      • SupportsDistributedTraining — (Boolean)

        Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.

      • MetricDefinitions — (Array<map>)

        A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

        • Name — required — (String)

          The name of the metric.

        • Regex — required — (String)

          A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

      • TrainingChannels — required — (Array<map>)

        A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

        • Name — required — (String)

          The name of the channel.

        • Description — (String)

          A brief description of the channel.

        • IsRequired — (Boolean)

          Indicates whether the channel is required by the algorithm.

        • SupportedContentTypes — required — (Array<String>)

          The supported MIME types for the data.

        • SupportedCompressionTypes — (Array<String>)

          The allowed compression types, if data compression is used.

        • SupportedInputModes — required — (Array<String>)

          The allowed input mode, either FILE or PIPE.

          In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

          In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

      • SupportedTuningJobObjectiveMetrics — (Array<map>)

        A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

        • Type — required — (String)

          Whether to minimize or maximize the objective metric.

          Possible values include:
          • "Maximize"
          • "Minimize"
        • MetricName — required — (String)

          The name of the metric to use for the objective metric.

    • InferenceSpecification — (map)

      Specifies details about inference jobs that the algorithm runs, including the following:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the algorithm supports for inference.

      • Containers — required — (Array<map>)

        The Amazon ECR registry path of the Docker image that contains the inference code.

        • ContainerHostname — (String)

          The DNS host name for the Docker container.

        • Image — required — (String)

          The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

          If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

        • ImageDigest — (String)

          An MD5 hash of the training algorithm that identifies the Docker image used for training.

        • ModelDataUrl — (String)

          The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

        • ProductId — (String)

          The AWS Marketplace product ID of the model package.

      • SupportedTransformInstanceTypes — required — (Array<String>)

        A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

      • SupportedRealtimeInferenceInstanceTypes — required — (Array<String>)

        A list of the instance types that are used to generate inferences in real-time.

      • SupportedContentTypes — required — (Array<String>)

        The supported MIME types for the input data.

      • SupportedResponseMIMETypes — required — (Array<String>)

        The supported MIME types for the output data.

    • ValidationSpecification — (map)

      Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

      • ValidationRole — required — (String)

        The IAM roles that Amazon SageMaker uses to run the training jobs.

      • ValidationProfiles — required — (Array<map>)

        An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

        • ProfileName — required — (String)

          The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

        • TrainingJobDefinition — required — (map)

          The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.

          • TrainingInputMode — required — (String)

            The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

            If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

            Possible values include:
            • "Pipe"
            • "File"
          • HyperParameters — (map<String>)

            The hyperparameters used for the training job.

          • InputDataConfig — required — (Array<map>)

            An array of Channel objects, each of which specifies an input source.

            • ChannelName — required — (String)

              The name of the channel.

            • DataSource — required — (map)

              The location of the channel data.

              • S3DataSource — (map)

                The S3 location of the data source that is associated with a channel.

                • S3DataType — required — (String)

                  If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

                  If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

                  If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

                  Possible values include:
                  • "ManifestFile"
                  • "S3Prefix"
                  • "AugmentedManifestFile"
                • S3Uri — required — (String)

                  Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                  • A key name prefix might look like this: s3://bucketname/exampleprefix.

                  • A manifest might look like this: s3://bucketname/example.manifest

                    The manifest is an S3 object which is a JSON file with the following format:

                    [

                    {"prefix": "s3://customer_bucket/some/prefix/"},

                    "relative/path/to/custdata-1",

                    "relative/path/custdata-2",

                    ...

                    ]

                    The preceding JSON matches the following s3Uris:

                    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                    s3://customer_bucket/some/prefix/relative/path/custdata-2

                    ...

                    The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

                • S3DataDistributionType — (String)

                  If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

                  If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

                  Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

                  In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

                  Possible values include:
                  • "FullyReplicated"
                  • "ShardedByS3Key"
                • AttributeNames — (Array<String>)

                  A list of one or more attribute names to use that are found in a specified augmented manifest file.

              • FileSystemDataSource — (map)

                The file system that is associated with a channel.

                • FileSystemId — required — (String)

                  The file system id.

                • FileSystemAccessMode — required — (String)

                  The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

                  Possible values include:
                  • "rw"
                  • "ro"
                • FileSystemType — required — (String)

                  The file system type.

                  Possible values include:
                  • "EFS"
                  • "FSxLustre"
                • DirectoryPath — required — (String)

                  The full path to the directory to associate with the channel.

            • ContentType — (String)

              The MIME type of the data.

            • CompressionType — (String)

              If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

              Possible values include:
              • "None"
              • "Gzip"
            • RecordWrapperType — (String)

              Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

              In File mode, leave this field unset or set it to None.

              Possible values include:
              • "None"
              • "RecordIO"
            • InputMode — (String)

              (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

              To use a model for incremental training, choose File input model.

              Possible values include:
              • "Pipe"
              • "File"
            • ShuffleConfig — (map)

              A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

              For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

              • Seed — required — (Integer)

                Determines the shuffling order in ShuffleConfig value.

          • OutputDataConfig — required — (map)

            the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

            • KmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

              • // KMS Key Alias

                "alias/ExampleAlias"

              • // Amazon Resource Name (ARN) of a KMS Key Alias

                "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

              If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

              The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

            • S3OutputPath — required — (String)

              Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

          • ResourceConfig — required — (map)

            The resources, including the ML compute instances and ML storage volumes, to use for model training.

            • InstanceType — required — (String)

              The ML compute instance type.

              Possible values include:
              • "ml.m4.xlarge"
              • "ml.m4.2xlarge"
              • "ml.m4.4xlarge"
              • "ml.m4.10xlarge"
              • "ml.m4.16xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.24xlarge"
              • "ml.c4.xlarge"
              • "ml.c4.2xlarge"
              • "ml.c4.4xlarge"
              • "ml.c4.8xlarge"
              • "ml.p2.xlarge"
              • "ml.p2.8xlarge"
              • "ml.p2.16xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.p3dn.24xlarge"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.18xlarge"
            • InstanceCount — required — (Integer)

              The number of ML compute instances to use. For distributed training, provide a value greater than 1.

            • VolumeSizeInGB — required — (Integer)

              The size of the ML storage volume that you want to provision.

              ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

              You must specify sufficient ML storage for your scenario.

              Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
            • VolumeKmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

          • StoppingCondition — required — (map)

            Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

            To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

            • MaxRuntimeInSeconds — (Integer)

              The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

            • MaxWaitTimeInSeconds — (Integer)

              The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

        • TransformJobDefinition — (map)

          The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.

          • MaxConcurrentTransforms — (Integer)

            The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

          • MaxPayloadInMB — (Integer)

            The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

          • BatchStrategy — (String)

            A string that determines the number of records included in a single mini-batch.

            SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

            Possible values include:
            • "MultiRecord"
            • "SingleRecord"
          • Environment — (map<String>)

            The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

          • TransformInput — required — (map)

            A description of the input source and the way the transform job consumes it.

            • DataSource — required — (map)

              Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

              • S3DataSource — required — (map)

                The S3 location of the data source that is associated with a channel.

                • S3DataType — required — (String)

                  If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

                  If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

                  The following values are compatible: ManifestFile, S3Prefix

                  The following value is not compatible: AugmentedManifestFile

                  Possible values include:
                  • "ManifestFile"
                  • "S3Prefix"
                  • "AugmentedManifestFile"
                • S3Uri — required — (String)

                  Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                  • A key name prefix might look like this: s3://bucketname/exampleprefix.

                  • A manifest might look like this: s3://bucketname/example.manifest

                    The manifest is an S3 object which is a JSON file with the following format:

                    [

                    {"prefix": "s3://customer_bucket/some/prefix/"},

                    "relative/path/to/custdata-1",

                    "relative/path/custdata-2",

                    ...

                    ]

                    The preceding JSON matches the following S3Uris:

                    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                    s3://customer_bucket/some/prefix/relative/path/custdata-1

                    ...

                    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

            • ContentType — (String)

              The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

            • CompressionType — (String)

              If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

              Possible values include:
              • "None"
              • "Gzip"
            • SplitType — (String)

              The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

              When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

              Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
              Possible values include:
              • "None"
              • "Line"
              • "RecordIO"
              • "TFRecord"
          • TransformOutput — required — (map)

            Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

            • S3OutputPath — required — (String)

              The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

              For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

            • Accept — (String)

              The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

            • AssembleWith — (String)

              Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

              Possible values include:
              • "None"
              • "Line"
            • KmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

              • // KMS Key Alias

                "alias/ExampleAlias"

              • // Amazon Resource Name (ARN) of a KMS Key Alias

                "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

              If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

              The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

          • TransformResources — required — (map)

            Identifies the ML compute instances for the transform job.

            • InstanceType — required — (String)

              The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

              Possible values include:
              • "ml.m4.xlarge"
              • "ml.m4.2xlarge"
              • "ml.m4.4xlarge"
              • "ml.m4.10xlarge"
              • "ml.m4.16xlarge"
              • "ml.c4.xlarge"
              • "ml.c4.2xlarge"
              • "ml.c4.4xlarge"
              • "ml.c4.8xlarge"
              • "ml.p2.xlarge"
              • "ml.p2.8xlarge"
              • "ml.p2.16xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.18xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.24xlarge"
            • InstanceCount — required — (Integer)

              The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

            • VolumeKmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • CertifyForMarketplace — (Boolean)

      Whether to certify the algorithm so that it can be listed in AWS Marketplace.

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:

      • AlgorithmArn — (String)

        The Amazon Resource Name (ARN) of the new algorithm.

Returns:

  • (AWS.Request) —

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

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

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in AWS CodeCommit or in any other Git repository.

Service Reference:

Examples:

Calling the createCodeRepository operation

var params = {
  CodeRepositoryName: 'STRING_VALUE', /* required */
  GitConfig: { /* required */
    RepositoryUrl: 'STRING_VALUE', /* required */
    Branch: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE'
  }
};
sagemaker.createCodeRepository(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: {}) —
    • CodeRepositoryName — (String)

      The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    • GitConfig — (map)

      Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

      • RepositoryUrl — required — (String)

        The URL where the Git repository is located.

      • Branch — (String)

        The default branch for the Git repository.

      • SecretArn — (String)

        The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

        {"username": UserName, "password": Password}

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:

      • CodeRepositoryArn — (String)

        The Amazon Resource Name (ARN) of the new repository.

Returns:

  • (AWS.Request) —

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

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

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Service Reference:

Examples:

Calling the createCompilationJob operation

var params = {
  CompilationJobName: 'STRING_VALUE', /* required */
  InputConfig: { /* required */
    DataInputConfig: 'STRING_VALUE', /* required */
    Framework: TENSORFLOW | MXNET | ONNX | PYTORCH | XGBOOST, /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  OutputConfig: { /* required */
    S3OutputLocation: 'STRING_VALUE', /* required */
    TargetDevice: lambda | ml_m4 | ml_m5 | ml_c4 | ml_c5 | ml_p2 | ml_p3 | jetson_tx1 | jetson_tx2 | jetson_nano | rasp3b | deeplens | rk3399 | rk3288 | aisage | sbe_c | qcs605 | qcs603 /* required */
  },
  RoleArn: 'STRING_VALUE', /* required */
  StoppingCondition: { /* required */
    MaxRuntimeInSeconds: 'NUMBER_VALUE',
    MaxWaitTimeInSeconds: 'NUMBER_VALUE'
  }
};
sagemaker.createCompilationJob(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: {}) —
    • CompilationJobName — (String)

      A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

      During model compilation, Amazon SageMaker needs your permission to:

      • Read input data from an S3 bucket

      • Write model artifacts to an S3 bucket

      • Write logs to Amazon CloudWatch Logs

      • Publish metrics to Amazon CloudWatch

      You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

    • InputConfig — (map)

      Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

      • S3Uri — required — (String)

        The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

      • DataInputConfig — required — (String)

        Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

        • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

          • Examples for one input:

            • If using the console, {"input":[1,1024,1024,3]}

            • If using the CLI, {\"input\":[1,1024,1024,3]}

          • Examples for two inputs:

            • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

            • If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

        • MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

          • Examples for one input:

            • If using the console, {"data":[1,3,1024,1024]}

            • If using the CLI, {\"data\":[1,3,1024,1024]}

          • Examples for two inputs:

            • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

            • If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

        • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

          • Examples for one input in dictionary format:

            • If using the console, {"input0":[1,3,224,224]}

            • If using the CLI, {\"input0\":[1,3,224,224]}

          • Example for one input in list format: [[1,3,224,224]]

          • Examples for two inputs in dictionary format:

            • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

            • If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

          • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

        • XGBOOST: input data name and shape are not needed.

      • Framework — required — (String)

        Identifies the framework in which the model was trained. For example: TENSORFLOW.

        Possible values include:
        • "TENSORFLOW"
        • "MXNET"
        • "ONNX"
        • "PYTORCH"
        • "XGBOOST"
    • OutputConfig — (map)

      Provides information about the output location for the compiled model and the target device the model runs on.

      • S3OutputLocation — required — (String)

        Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

      • TargetDevice — required — (String)

        Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.

        Possible values include:
        • "lambda"
        • "ml_m4"
        • "ml_m5"
        • "ml_c4"
        • "ml_c5"
        • "ml_p2"
        • "ml_p3"
        • "jetson_tx1"
        • "jetson_tx2"
        • "jetson_nano"
        • "rasp3b"
        • "deeplens"
        • "rk3399"
        • "rk3288"
        • "aisage"
        • "sbe_c"
        • "qcs605"
        • "qcs603"
    • StoppingCondition — (map)

      Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

      • MaxRuntimeInSeconds — (Integer)

        The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

      • MaxWaitTimeInSeconds — (Integer)

        The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

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:

      • CompilationJobArn — (String)

        If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

        • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

Returns:

  • (AWS.Request) —

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

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

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Note: Use this API only for hosting models using Amazon SageMaker hosting services. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an AWS Region in your AWS account.

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.

Service Reference:

Examples:

Calling the createEndpoint operation

var params = {
  EndpointConfigName: 'STRING_VALUE', /* required */
  EndpointName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createEndpoint(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: {}) —
    • EndpointName — (String)

      The name of the endpoint. The name must be unique within an AWS Region in your AWS account.

    • EndpointConfigName — (String)

      The name of an endpoint configuration. For more information, see CreateEndpointConfig.

    • Tags — (Array<map>)

      An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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:

      • EndpointArn — (String)

        The Amazon Resource Name (ARN) of the endpoint.

Returns:

  • (AWS.Request) —

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

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

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.

Note: Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

Service Reference:

Examples:

Calling the createEndpointConfig operation

var params = {
  EndpointConfigName: 'STRING_VALUE', /* required */
  ProductionVariants: [ /* required */
    {
      InitialInstanceCount: 'NUMBER_VALUE', /* required */
      InstanceType: ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.c4.large | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.18xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge, /* required */
      ModelName: 'STRING_VALUE', /* required */
      VariantName: 'STRING_VALUE', /* required */
      AcceleratorType: ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge,
      InitialVariantWeight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createEndpointConfig(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: {}) —
    • EndpointConfigName — (String)

      The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

    • ProductionVariants — (Array<map>)

      An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

      • VariantName — required — (String)

        The name of the production variant.

      • ModelName — required — (String)

        The name of the model that you want to host. This is the name that you specified when creating the model.

      • InitialInstanceCount — required — (Integer)

        Number of instances to launch initially.

      • InstanceType — required — (String)

        The ML compute instance type.

        Possible values include:
        • "ml.t2.medium"
        • "ml.t2.large"
        • "ml.t2.xlarge"
        • "ml.t2.2xlarge"
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.large"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.m5d.large"
        • "ml.m5d.xlarge"
        • "ml.m5d.2xlarge"
        • "ml.m5d.4xlarge"
        • "ml.m5d.12xlarge"
        • "ml.m5d.24xlarge"
        • "ml.c4.large"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
        • "ml.c5.large"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5d.large"
        • "ml.c5d.xlarge"
        • "ml.c5d.2xlarge"
        • "ml.c5d.4xlarge"
        • "ml.c5d.9xlarge"
        • "ml.c5d.18xlarge"
        • "ml.g4dn.xlarge"
        • "ml.g4dn.2xlarge"
        • "ml.g4dn.4xlarge"
        • "ml.g4dn.8xlarge"
        • "ml.g4dn.12xlarge"
        • "ml.g4dn.16xlarge"
        • "ml.r5.large"
        • "ml.r5.xlarge"
        • "ml.r5.2xlarge"
        • "ml.r5.4xlarge"
        • "ml.r5.12xlarge"
        • "ml.r5.24xlarge"
        • "ml.r5d.large"
        • "ml.r5d.xlarge"
        • "ml.r5d.2xlarge"
        • "ml.r5d.4xlarge"
        • "ml.r5d.12xlarge"
        • "ml.r5d.24xlarge"
      • InitialVariantWeight — (Float)

        Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

      • AcceleratorType — (String)

        The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

        Possible values include:
        • "ml.eia1.medium"
        • "ml.eia1.large"
        • "ml.eia1.xlarge"
        • "ml.eia2.medium"
        • "ml.eia2.large"
        • "ml.eia2.xlarge"
    • Tags — (Array<map>)

      A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • KmsKeyId — (String)

      The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

      Note: Nitro-based instances do not support encryption with AWS KMS. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances, the call to CreateEndpointConfig fails. For a list of nitro-based instances, see Nitro-based Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For more information about storage volumes on nitro-based instances, see Amazon EBS and NVMe on Linux Instances.

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:

      • EndpointConfigArn — (String)

        The Amazon Resource Name (ARN) of the endpoint configuration.

Returns:

  • (AWS.Request) —

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

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

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

Service Reference:

Examples:

Calling the createHyperParameterTuningJob operation

var params = {
  HyperParameterTuningJobConfig: { /* required */
    ResourceLimits: { /* required */
      MaxNumberOfTrainingJobs: 'NUMBER_VALUE', /* required */
      MaxParallelTrainingJobs: 'NUMBER_VALUE' /* required */
    },
    Strategy: Bayesian | Random, /* required */
    HyperParameterTuningJobObjective: {
      MetricName: 'STRING_VALUE', /* required */
      Type: Maximize | Minimize /* required */
    },
    ParameterRanges: {
      CategoricalParameterRanges: [
        {
          Name: 'STRING_VALUE', /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ContinuousParameterRanges: [
        {
          MaxValue: 'STRING_VALUE', /* required */
          MinValue: 'STRING_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          ScalingType: Auto | Linear | Logarithmic | ReverseLogarithmic
        },
        /* more items */
      ],
      IntegerParameterRanges: [
        {
          MaxValue: 'STRING_VALUE', /* required */
          MinValue: 'STRING_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          ScalingType: Auto | Linear | Logarithmic | ReverseLogarithmic
        },
        /* more items */
      ]
    },
    TrainingJobEarlyStoppingType: Off | Auto
  },
  HyperParameterTuningJobName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TrainingJobDefinition: {
    AlgorithmSpecification: { /* required */
      TrainingInputMode: Pipe | File, /* required */
      AlgorithmName: 'STRING_VALUE',
      MetricDefinitions: [
        {
          Name: 'STRING_VALUE', /* required */
          Regex: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      TrainingImage: 'STRING_VALUE'
    },
    OutputDataConfig: { /* required */
      S3OutputPath: 'STRING_VALUE', /* required */
      KmsKeyId: 'STRING_VALUE'
    },
    ResourceConfig: { /* required */
      InstanceCount: 'NUMBER_VALUE', /* required */
      InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge, /* required */
      VolumeSizeInGB: 'NUMBER_VALUE', /* required */
      VolumeKmsKeyId: 'STRING_VALUE'
    },
    RoleArn: 'STRING_VALUE', /* required */
    StoppingCondition: { /* required */
      MaxRuntimeInSeconds: 'NUMBER_VALUE',
      MaxWaitTimeInSeconds: 'NUMBER_VALUE'
    },
    CheckpointConfig: {
      S3Uri: 'STRING_VALUE', /* required */
      LocalPath: 'STRING_VALUE'
    },
    EnableInterContainerTrafficEncryption: true || false,
    EnableManagedSpotTraining: true || false,
    EnableNetworkIsolation: true || false,
    InputDataConfig: [
      {
        ChannelName: 'STRING_VALUE', /* required */
        DataSource: { /* required */
          FileSystemDataSource: {
            DirectoryPath: 'STRING_VALUE', /* required */
            FileSystemAccessMode: rw | ro, /* required */
            FileSystemId: 'STRING_VALUE', /* required */
            FileSystemType: EFS | FSxLustre /* required */
          },
          S3DataSource: {
            S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
            S3Uri: 'STRING_VALUE', /* required */
            AttributeNames: [
              'STRING_VALUE',
              /* more items */
            ],
            S3DataDistributionType: FullyReplicated | ShardedByS3Key
          }
        },
        CompressionType: None | Gzip,
        ContentType: 'STRING_VALUE',
        InputMode: Pipe | File,
        RecordWrapperType: None | RecordIO,
        ShuffleConfig: {
          Seed: 'NUMBER_VALUE' /* required */
        }
      },
      /* more items */
    ],
    StaticHyperParameters: {
      '<ParameterKey>': 'STRING_VALUE',
      /* '<ParameterKey>': ... */
    },
    VpcConfig: {
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  WarmStartConfig: {
    ParentHyperParameterTuningJobs: [ /* required */
      {
        HyperParameterTuningJobName: 'STRING_VALUE'
      },
      /* more items */
    ],
    WarmStartType: IdenticalDataAndAlgorithm | TransferLearning /* required */
  }
};
sagemaker.createHyperParameterTuningJob(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: {}) —
    • HyperParameterTuningJobName — (String)

      The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

    • HyperParameterTuningJobConfig — (map)

      The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning

      • Strategy — required — (String)

        Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.

        Possible values include:
        • "Bayesian"
        • "Random"
      • HyperParameterTuningJobObjective — (map)

        The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

        • Type — required — (String)

          Whether to minimize or maximize the objective metric.

          Possible values include:
          • "Maximize"
          • "Minimize"
        • MetricName — required — (String)

          The name of the metric to use for the objective metric.

      • ResourceLimits — required — (map)

        The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

        • MaxNumberOfTrainingJobs — required — (Integer)

          The maximum number of training jobs that a hyperparameter tuning job can launch.

        • MaxParallelTrainingJobs — required — (Integer)

          The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

      • ParameterRanges — (map)

        The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

        • IntegerParameterRanges — (Array<map>)

          The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

          • Name — required — (String)

            The name of the hyperparameter to search.

          • MinValue — required — (String)

            The minimum value of the hyperparameter to search.

          • MaxValue — required — (String)

            The maximum value of the hyperparameter to search.

          • ScalingType — (String)

            The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

            Auto

            Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have only values greater than 0.

            Possible values include:
            • "Auto"
            • "Linear"
            • "Logarithmic"
            • "ReverseLogarithmic"
        • ContinuousParameterRanges — (Array<map>)

          The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

          • Name — required — (String)

            The name of the continuous hyperparameter to tune.

          • MinValue — required — (String)

            The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

          • MaxValue — required — (String)

            The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

          • ScalingType — (String)

            The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

            Auto

            Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have only values greater than 0.

            ReverseLogarithmic

            Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

            Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

            Possible values include:
            • "Auto"
            • "Linear"
            • "Logarithmic"
            • "ReverseLogarithmic"
        • CategoricalParameterRanges — (Array<map>)

          The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

          • Name — required — (String)

            The name of the categorical hyperparameter to tune.

          • Values — required — (Array<String>)

            A list of the categories for the hyperparameter.

      • TrainingJobEarlyStoppingType — (String)

        Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

        OFF

        Training jobs launched by the hyperparameter tuning job do not use early stopping.

        AUTO

        Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

        Possible values include:
        • "Off"
        • "Auto"
    • TrainingJobDefinition — (map)

      The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

      • StaticHyperParameters — (map<String>)

        Specifies the values of hyperparameters that do not change for the tuning job.

      • AlgorithmSpecification — required — (map)

        The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

        • TrainingImage — (String)

          The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

        • TrainingInputMode — required — (String)

          The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

          If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

          For more information about input modes, see Algorithms.

          Possible values include:
          • "Pipe"
          • "File"
        • AlgorithmName — (String)

          The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

        • MetricDefinitions — (Array<map>)

          An array of MetricDefinition objects that specify the metrics that the algorithm emits.

          • Name — required — (String)

            The name of the metric.

          • Regex — required — (String)

            A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

      • InputDataConfig — (Array<map>)

        An array of Channel objects that specify the input for the training jobs that the tuning job launches.

        • ChannelName — required — (String)

          The name of the channel.

        • DataSource — required — (map)

          The location of the channel data.

          • S3DataSource — (map)

            The S3 location of the data source that is associated with a channel.

            • S3DataType — required — (String)

              If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

              If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

              If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

              Possible values include:
              • "ManifestFile"
              • "S3Prefix"
              • "AugmentedManifestFile"
            • S3Uri — required — (String)

              Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

              • A key name prefix might look like this: s3://bucketname/exampleprefix.

              • A manifest might look like this: s3://bucketname/example.manifest

                The manifest is an S3 object which is a JSON file with the following format:

                [

                {"prefix": "s3://customer_bucket/some/prefix/"},

                "relative/path/to/custdata-1",

                "relative/path/custdata-2",

                ...

                ]

                The preceding JSON matches the following s3Uris:

                s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                s3://customer_bucket/some/prefix/relative/path/custdata-2

                ...

                The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

            • S3DataDistributionType — (String)

              If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

              If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

              Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

              In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

              Possible values include:
              • "FullyReplicated"
              • "ShardedByS3Key"
            • AttributeNames — (Array<String>)

              A list of one or more attribute names to use that are found in a specified augmented manifest file.

          • FileSystemDataSource — (map)

            The file system that is associated with a channel.

            • FileSystemId — required — (String)

              The file system id.

            • FileSystemAccessMode — required — (String)

              The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

              Possible values include:
              • "rw"
              • "ro"
            • FileSystemType — required — (String)

              The file system type.

              Possible values include:
              • "EFS"
              • "FSxLustre"
            • DirectoryPath — required — (String)

              The full path to the directory to associate with the channel.

        • ContentType — (String)

          The MIME type of the data.

        • CompressionType — (String)

          If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

          Possible values include:
          • "None"
          • "Gzip"
        • RecordWrapperType — (String)

          Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

          In File mode, leave this field unset or set it to None.

          Possible values include:
          • "None"
          • "RecordIO"
        • InputMode — (String)

          (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

          To use a model for incremental training, choose File input model.

          Possible values include:
          • "Pipe"
          • "File"
        • ShuffleConfig — (map)

          A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

          For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

          • Seed — required — (Integer)

            Determines the shuffling order in ShuffleConfig value.

      • VpcConfig — (map)

        The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

        • SecurityGroupIds — required — (Array<String>)

          The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

        • Subnets — required — (Array<String>)

          The ID of the subnets in the VPC to which you want to connect your training job or model.

          Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
      • OutputDataConfig — required — (map)

        Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

        • KmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

          • // KMS Key Alias

            "alias/ExampleAlias"

          • // Amazon Resource Name (ARN) of a KMS Key Alias

            "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

          If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

          The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

        • S3OutputPath — required — (String)

          Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

      • ResourceConfig — required — (map)

        The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

        Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

        • InstanceType — required — (String)

          The ML compute instance type.

          Possible values include:
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.p3dn.24xlarge"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
        • InstanceCount — required — (Integer)

          The number of ML compute instances to use. For distributed training, provide a value greater than 1.

        • VolumeSizeInGB — required — (Integer)

          The size of the ML storage volume that you want to provision.

          ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

          You must specify sufficient ML storage for your scenario.

          Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
        • VolumeKmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • StoppingCondition — required — (map)

        Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

        • MaxRuntimeInSeconds — (Integer)

          The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

        • MaxWaitTimeInSeconds — (Integer)

          The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

      • EnableNetworkIsolation — (Boolean)

        Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

        Note: The Semantic Segmentation built-in algorithm does not support network isolation.
      • EnableInterContainerTrafficEncryption — (Boolean)

        To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

      • EnableManagedSpotTraining — (Boolean)

        A Boolean indicating whether managed spot training is enabled (True) or not (False).

      • CheckpointConfig — (map)

        Contains information about the output location for managed spot training checkpoint data.

        • S3Uri — required — (String)

          Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

        • LocalPath — (String)

          (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

    • WarmStartConfig — (map)

      Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

      All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

      Note: All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
      • ParentHyperParameterTuningJobs — required — (Array<map>)

        An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

        Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

        • HyperParameterTuningJobName — (String)

          The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

      • WarmStartType — required — (String)

        Specifies one of the following:

        IDENTICAL_DATA_AND_ALGORITHM

        The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

        TRANSFER_LEARNING

        The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

        Possible values include:
        • "IdenticalDataAndAlgorithm"
        • "TransferLearning"
    • Tags — (Array<map>)

      An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies.

      Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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:

      • HyperParameterTuningJobArn — (String)

        The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

Returns:

  • (AWS.Request) —

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

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

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

Service Reference:

Examples:

Calling the createLabelingJob operation

var params = {
  HumanTaskConfig: { /* required */
    AnnotationConsolidationConfig: { /* required */
      AnnotationConsolidationLambdaArn: 'STRING_VALUE' /* required */
    },
    NumberOfHumanWorkersPerDataObject: 'NUMBER_VALUE', /* required */
    PreHumanTaskLambdaArn: 'STRING_VALUE', /* required */
    TaskDescription: 'STRING_VALUE', /* required */
    TaskTimeLimitInSeconds: 'NUMBER_VALUE', /* required */
    TaskTitle: 'STRING_VALUE', /* required */
    UiConfig: { /* required */
      UiTemplateS3Uri: 'STRING_VALUE' /* required */
    },
    WorkteamArn: 'STRING_VALUE', /* required */
    MaxConcurrentTaskCount: 'NUMBER_VALUE',
    PublicWorkforceTaskPrice: {
      AmountInUsd: {
        Cents: 'NUMBER_VALUE',
        Dollars: 'NUMBER_VALUE',
        TenthFractionsOfACent: 'NUMBER_VALUE'
      }
    },
    TaskAvailabilityLifetimeInSeconds: 'NUMBER_VALUE',
    TaskKeywords: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  InputConfig: { /* required */
    DataSource: { /* required */
      S3DataSource: { /* required */
        ManifestS3Uri: 'STRING_VALUE' /* required */
      }
    },
    DataAttributes: {
      ContentClassifiers: [
        FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent,
        /* more items */
      ]
    }
  },
  LabelAttributeName: 'STRING_VALUE', /* required */
  LabelingJobName: 'STRING_VALUE', /* required */
  OutputConfig: { /* required */
    S3OutputPath: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  LabelCategoryConfigS3Uri: 'STRING_VALUE',
  LabelingJobAlgorithmsConfig: {
    LabelingJobAlgorithmSpecificationArn: 'STRING_VALUE', /* required */
    InitialActiveLearningModelArn: 'STRING_VALUE',
    LabelingJobResourceConfig: {
      VolumeKmsKeyId: 'STRING_VALUE'
    }
  },
  StoppingConditions: {
    MaxHumanLabeledObjectCount: 'NUMBER_VALUE',
    MaxPercentageOfInputDatasetLabeled: 'NUMBER_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createLabelingJob(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: {}) —
    • LabelingJobName — (String)

      The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

    • LabelAttributeName — (String)

      The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

    • InputConfig — (map)

      Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

      • DataSource — required — (map)

        The location of the input data.

        • S3DataSource — required — (map)

          The Amazon S3 location of the input data objects.

          • ManifestS3Uri — required — (String)

            The Amazon S3 location of the manifest file that describes the input data objects.

      • DataAttributes — (map)

        Attributes of the data specified by the customer.

        • ContentClassifiers — (Array<String>)

          Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

    • OutputConfig — (map)

      The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

      • S3OutputPath — required — (String)

        The Amazon S3 location to write output data.

      • KmsKeyId — (String)

        The AWS Key Management Service ID of the key used to encrypt the output data, if any.

        If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

        The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

    • RoleArn — (String)

      The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

    • LabelCategoryConfigS3Uri — (String)

      The S3 URL of the file that defines the categories used to label the data objects.

      The file is a JSON structure in the following format:

      {

      "document-version": "2018-11-28"

      "labels": [

      {

      "label": "label 1"

      },

      {

      "label": "label 2"

      },

      ...

      {

      "label": "label n"

      }

      ]

      }

    • StoppingConditions — (map)

      A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

      • MaxHumanLabeledObjectCount — (Integer)

        The maximum number of objects that can be labeled by human workers.

      • MaxPercentageOfInputDatasetLabeled — (Integer)

        The maximum number of input data objects that should be labeled.

    • LabelingJobAlgorithmsConfig — (map)

      Configures the information required to perform automated data labeling.

      • LabelingJobAlgorithmSpecificationArn — required — (String)

        Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

        • Image classification

          arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

        • Text classification

          arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

        • Object detection

          arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

        • Semantic Segmentation

          arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

      • InitialActiveLearningModelArn — (String)

        At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

      • LabelingJobResourceConfig — (map)

        Provides configuration information for a labeling job.

        • VolumeKmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • HumanTaskConfig — (map)

      Configures the information required for human workers to complete a labeling task.

      • WorkteamArn — required — (String)

        The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

      • UiConfig — required — (map)

        Information about the user interface that workers use to complete the labeling task.

      • PreHumanTaskLambdaArn — required — (String)

        The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

        For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

        US East (Northern Virginia) (us-east-1):

        • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

        • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

        • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

        • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

        • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

        US East (Ohio) (us-east-2):

        • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

        • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

        • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

        • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

        • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

        US West (Oregon) (us-west-2):

        • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

        • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

        • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

        • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

        • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

        Canada (Central) (ca-central-1):

        • arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

        • arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

        • arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

        • arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

        • arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

        EU (Ireland) (eu-west-1):

        • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

        • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

        • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

        • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

        • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

        EU (London) (eu-west-2):

        • arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

        • arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

        • arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

        • arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

        • arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

        EU Frankfurt (eu-central-1):

        • arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

        • arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

        • arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

        • arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

        • arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

        Asia Pacific (Tokyo) (ap-northeast-1):

        • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

        • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

        • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

        • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

        Asia Pacific (Seoul) (ap-northeast-2):

        • arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

        • arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

        • arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

        • arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

        • arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

        Asia Pacific (Mumbai) (ap-south-1):

        • arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

        • arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

        • arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

        • arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

        • arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

        Asia Pacific (Singapore) (ap-southeast-1):

        • arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

        • arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

        • arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

        • arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

        • arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

        Asia Pacific (Sydney) (ap-southeast-2):

        • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

        • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

        • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

        • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

      • TaskKeywords — (Array<String>)

        Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

      • TaskTitle — required — (String)

        A title for the task for your human workers.

      • TaskDescription — required — (String)

        A description of the task for your human workers.

      • NumberOfHumanWorkersPerDataObject — required — (Integer)

        The number of human workers that will label an object.

      • TaskTimeLimitInSeconds — required — (Integer)

        The amount of time that a worker has to complete a task.

      • TaskAvailabilityLifetimeInSeconds — (Integer)

        The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

      • MaxConcurrentTaskCount — (Integer)

        Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

      • AnnotationConsolidationConfig — required — (map)

        Configures how labels are consolidated across human workers.

        • AnnotationConsolidationLambdaArn — required — (String)

          The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.

          For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

          • Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

            arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

            arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

            arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

            arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

            arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

            arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

            arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

            arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

            arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

            arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

            arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

            arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

          • Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

            arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

            arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

            arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

            arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

            arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

            arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

            arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

            arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

            arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

            arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

            arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

            arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

          • Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

            arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

            arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

            arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

            arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

            arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

            arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

            arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

            arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

            arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

            arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

            arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

            arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

          • Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

            arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

            arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

            arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

            arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

            arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

            arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

            arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

            arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

            arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

            arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

            arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

            arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

          • Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

            arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

            arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

            arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

            arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

            arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

            arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

            arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

          For more information, see Annotation Consolidation.

      • PublicWorkforceTaskPrice — (map)

        The price that you pay for each task performed by an Amazon Mechanical Turk worker.

        • AmountInUsd — (map)

          Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

          • Dollars — (Integer)

            The whole number of dollars in the amount.

          • Cents — (Integer)

            The fractional portion, in cents, of the amount.

          • TenthFractionsOfACent — (Integer)

            Fractions of a cent, in tenths.

    • Tags — (Array<map>)

      An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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:

      • LabelingJobArn — (String)

        The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

Returns:

  • (AWS.Request) —

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

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

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the CreateModel request, you must define a container with the PrimaryContainer parameter.

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role.

Service Reference:

Examples:

Calling the createModel operation

var params = {
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  ModelName: 'STRING_VALUE', /* required */
  Containers: [
    {
      ContainerHostname: 'STRING_VALUE',
      Environment: {
        '<EnvironmentKey>': 'STRING_VALUE',
        /* '<EnvironmentKey>': ... */
      },
      Image: 'STRING_VALUE',
      ModelDataUrl: 'STRING_VALUE',
      ModelPackageName: 'STRING_VALUE'
    },
    /* more items */
  ],
  EnableNetworkIsolation: true || false,
  PrimaryContainer: {
    ContainerHostname: 'STRING_VALUE',
    Environment: {
      '<EnvironmentKey>': 'STRING_VALUE',
      /* '<EnvironmentKey>': ... */
    },
    Image: 'STRING_VALUE',
    ModelDataUrl: 'STRING_VALUE',
    ModelPackageName: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
sagemaker.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 of the new model.

    • PrimaryContainer — (map)

      The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

      • ContainerHostname — (String)

        This parameter is ignored for models that contain only a PrimaryContainer.

        When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

      • Image — (String)

        The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

      • ModelDataUrl — (String)

        The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

        If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

        If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

      • Environment — (map<String>)

        The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

      • ModelPackageName — (String)

        The name or Amazon Resource Name (ARN) of the model package to use to create the model.

    • Containers — (Array<map>)

      Specifies the containers in the inference pipeline.

      • ContainerHostname — (String)

        This parameter is ignored for models that contain only a PrimaryContainer.

        When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

      • Image — (String)

        The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

      • ModelDataUrl — (String)

        The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

        If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

        If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

      • Environment — (map<String>)

        The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

      • ModelPackageName — (String)

        The name or Amazon Resource Name (ARN) of the model package to use to create the model.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.

      Note: To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
    • Tags — (Array<map>)

      An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • VpcConfig — (map)

      A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

      • SecurityGroupIds — required — (Array<String>)

        The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

      • Subnets — required — (Array<String>)

        The ID of the subnets in the VPC to which you want to connect your training job or model.

        Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
    • EnableNetworkIsolation — (Boolean)

      Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

      Note: The Semantic Segmentation built-in algorithm does not support network isolation.

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 ARN of the model created in Amazon SageMaker.

Returns:

  • (AWS.Request) —

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

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

Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.

Service Reference:

Examples:

Calling the createModelPackage operation

var params = {
  ModelPackageName: 'STRING_VALUE', /* required */
  CertifyForMarketplace: true || false,
  InferenceSpecification: {
    Containers: [ /* required */
      {
        Image: 'STRING_VALUE', /* required */
        ContainerHostname: 'STRING_VALUE',
        ImageDigest: 'STRING_VALUE',
        ModelDataUrl: 'STRING_VALUE',
        ProductId: 'STRING_VALUE'
      },
      /* more items */
    ],
    SupportedContentTypes: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SupportedRealtimeInferenceInstanceTypes: [ /* required */
      ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.c4.large | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.18xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge,
      /* more items */
    ],
    SupportedResponseMIMETypes: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SupportedTransformInstanceTypes: [ /* required */
      ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge,
      /* more items */
    ]
  },
  ModelPackageDescription: 'STRING_VALUE',
  SourceAlgorithmSpecification: {
    SourceAlgorithms: [ /* required */
      {
        AlgorithmName: 'STRING_VALUE', /* required */
        ModelDataUrl: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  ValidationSpecification: {
    ValidationProfiles: [ /* required */
      {
        ProfileName: 'STRING_VALUE', /* required */
        TransformJobDefinition: { /* required */
          TransformInput: { /* required */
            DataSource: { /* required */
              S3DataSource: { /* required */
                S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
                S3Uri: 'STRING_VALUE' /* required */
              }
            },
            CompressionType: None | Gzip,
            ContentType: 'STRING_VALUE',
            SplitType: None | Line | RecordIO | TFRecord
          },
          TransformOutput: { /* required */
            S3OutputPath: 'STRING_VALUE', /* required */
            Accept: 'STRING_VALUE',
            AssembleWith: None | Line,
            KmsKeyId: 'STRING_VALUE'
          },
          TransformResources: { /* required */
            InstanceCount: 'NUMBER_VALUE', /* required */
            InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge, /* required */
            VolumeKmsKeyId: 'STRING_VALUE'
          },
          BatchStrategy: MultiRecord | SingleRecord,
          Environment: {
            '<TransformEnvironmentKey>': 'STRING_VALUE',
            /* '<TransformEnvironmentKey>': ... */
          },
          MaxConcurrentTransforms: 'NUMBER_VALUE',
          MaxPayloadInMB: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    ValidationRole: 'STRING_VALUE' /* required */
  }
};
sagemaker.createModelPackage(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: {}) —
    • ModelPackageName — (String)

      The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    • ModelPackageDescription — (String)

      A description of the model package.

    • InferenceSpecification — (map)

      Specifies details about inference jobs that can be run with models based on this model package, including the following:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

      • Containers — required — (Array<map>)

        The Amazon ECR registry path of the Docker image that contains the inference code.

        • ContainerHostname — (String)

          The DNS host name for the Docker container.

        • Image — required — (String)

          The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

          If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

        • ImageDigest — (String)

          An MD5 hash of the training algorithm that identifies the Docker image used for training.

        • ModelDataUrl — (String)

          The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

        • ProductId — (String)

          The AWS Marketplace product ID of the model package.

      • SupportedTransformInstanceTypes — required — (Array<String>)

        A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

      • SupportedRealtimeInferenceInstanceTypes — required — (Array<String>)

        A list of the instance types that are used to generate inferences in real-time.

      • SupportedContentTypes — required — (Array<String>)

        The supported MIME types for the input data.

      • SupportedResponseMIMETypes — required — (Array<String>)

        The supported MIME types for the output data.

    • ValidationSpecification — (map)

      Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

      • ValidationRole — required — (String)

        The IAM roles to be used for the validation of the model package.

      • ValidationProfiles — required — (Array<map>)

        An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.

        • ProfileName — required — (String)

          The name of the profile for the model package.

        • TransformJobDefinition — required — (map)

          The TransformJobDefinition object that describes the transform job used for the validation of the model package.

          • MaxConcurrentTransforms — (Integer)

            The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

          • MaxPayloadInMB — (Integer)

            The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

          • BatchStrategy — (String)

            A string that determines the number of records included in a single mini-batch.

            SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

            Possible values include:
            • "MultiRecord"
            • "SingleRecord"
          • Environment — (map<String>)

            The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

          • TransformInput — required — (map)

            A description of the input source and the way the transform job consumes it.

            • DataSource — required — (map)

              Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

              • S3DataSource — required — (map)

                The S3 location of the data source that is associated with a channel.

                • S3DataType — required — (String)

                  If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

                  If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

                  The following values are compatible: ManifestFile, S3Prefix

                  The following value is not compatible: AugmentedManifestFile

                  Possible values include:
                  • "ManifestFile"
                  • "S3Prefix"
                  • "AugmentedManifestFile"
                • S3Uri — required — (String)

                  Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                  • A key name prefix might look like this: s3://bucketname/exampleprefix.

                  • A manifest might look like this: s3://bucketname/example.manifest

                    The manifest is an S3 object which is a JSON file with the following format:

                    [

                    {"prefix": "s3://customer_bucket/some/prefix/"},

                    "relative/path/to/custdata-1",

                    "relative/path/custdata-2",

                    ...

                    ]

                    The preceding JSON matches the following S3Uris:

                    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                    s3://customer_bucket/some/prefix/relative/path/custdata-1

                    ...

                    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

            • ContentType — (String)

              The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

            • CompressionType — (String)

              If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

              Possible values include:
              • "None"
              • "Gzip"
            • SplitType — (String)

              The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

              When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

              Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
              Possible values include:
              • "None"
              • "Line"
              • "RecordIO"
              • "TFRecord"
          • TransformOutput — required — (map)

            Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

            • S3OutputPath — required — (String)

              The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

              For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

            • Accept — (String)

              The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

            • AssembleWith — (String)

              Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

              Possible values include:
              • "None"
              • "Line"
            • KmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

              • // KMS Key Alias

                "alias/ExampleAlias"

              • // Amazon Resource Name (ARN) of a KMS Key Alias

                "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

              If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

              The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

          • TransformResources — required — (map)

            Identifies the ML compute instances for the transform job.

            • InstanceType — required — (String)

              The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

              Possible values include:
              • "ml.m4.xlarge"
              • "ml.m4.2xlarge"
              • "ml.m4.4xlarge"
              • "ml.m4.10xlarge"
              • "ml.m4.16xlarge"
              • "ml.c4.xlarge"
              • "ml.c4.2xlarge"
              • "ml.c4.4xlarge"
              • "ml.c4.8xlarge"
              • "ml.p2.xlarge"
              • "ml.p2.8xlarge"
              • "ml.p2.16xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.18xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.24xlarge"
            • InstanceCount — required — (Integer)

              The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

            • VolumeKmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • SourceAlgorithmSpecification — (map)

      Details about the algorithm that was used to create the model package.

      • SourceAlgorithms — required — (Array<map>)

        A list of the algorithms that were used to create a model package.

        • ModelDataUrl — (String)

          The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

        • AlgorithmName — required — (String)

          The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

    • CertifyForMarketplace — (Boolean)

      Whether to certify the model package for listing on AWS Marketplace.

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:

      • ModelPackageArn — (String)

        The Amazon Resource Name (ARN) of the new model package.

Returns:

  • (AWS.Request) —

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

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

Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, Amazon SageMaker does the following:

  1. Creates a network interface in the Amazon SageMaker VPC.

  2. (Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

Service Reference:

Examples:

Calling the createNotebookInstance operation

var params = {
  InstanceType: ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5d.xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.18xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge, /* required */
  NotebookInstanceName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  AcceleratorTypes: [
    ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge,
    /* more items */
  ],
  AdditionalCodeRepositories: [
    'STRING_VALUE',
    /* more items */
  ],
  DefaultCodeRepository: 'STRING_VALUE',
  DirectInternetAccess: Enabled | Disabled,
  KmsKeyId: 'STRING_VALUE',
  LifecycleConfigName: 'STRING_VALUE',
  RootAccess: Enabled | Disabled,
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VolumeSizeInGB: 'NUMBER_VALUE'
};
sagemaker.createNotebookInstance(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: {}) —
    • NotebookInstanceName — (String)

      The name of the new notebook instance.

    • InstanceType — (String)

      The type of ML compute instance to launch for the notebook instance.

      Possible values include:
      • "ml.t2.medium"
      • "ml.t2.large"
      • "ml.t2.xlarge"
      • "ml.t2.2xlarge"
      • "ml.t3.medium"
      • "ml.t3.large"
      • "ml.t3.xlarge"
      • "ml.t3.2xlarge"
      • "ml.m4.xlarge"
      • "ml.m4.2xlarge"
      • "ml.m4.4xlarge"
      • "ml.m4.10xlarge"
      • "ml.m4.16xlarge"
      • "ml.m5.xlarge"
      • "ml.m5.2xlarge"
      • "ml.m5.4xlarge"
      • "ml.m5.12xlarge"
      • "ml.m5.24xlarge"
      • "ml.c4.xlarge"
      • "ml.c4.2xlarge"
      • "ml.c4.4xlarge"
      • "ml.c4.8xlarge"
      • "ml.c5.xlarge"
      • "ml.c5.2xlarge"
      • "ml.c5.4xlarge"
      • "ml.c5.9xlarge"
      • "ml.c5.18xlarge"
      • "ml.c5d.xlarge"
      • "ml.c5d.2xlarge"
      • "ml.c5d.4xlarge"
      • "ml.c5d.9xlarge"
      • "ml.c5d.18xlarge"
      • "ml.p2.xlarge"
      • "ml.p2.8xlarge"
      • "ml.p2.16xlarge"
      • "ml.p3.2xlarge"
      • "ml.p3.8xlarge"
      • "ml.p3.16xlarge"
    • SubnetId — (String)

      The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

    • SecurityGroupIds — (Array<String>)

      The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    • RoleArn — (String)

      When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissionsto to assume this role. For more information, see Amazon SageMaker Roles.

      Note: To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
    • KmsKeyId — (String)

      The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.

    • Tags — (Array<map>)

      A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • LifecycleConfigName — (String)

      The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    • DirectInternetAccess — (String)

      Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.

      For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

      Possible values include:
      • "Enabled"
      • "Disabled"
    • VolumeSizeInGB — (Integer)

      The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

    • AcceleratorTypes — (Array<String>)

      A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

    • DefaultCodeRepository — (String)

      A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    • AdditionalCodeRepositories — (Array<String>)

      An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    • RootAccess — (String)

      Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      Note: Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
      Possible values include:
      • "Enabled"
      • "Disabled"

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:

      • NotebookInstanceArn — (String)

        The Amazon Resource Name (ARN) of the notebook instance.

Returns:

  • (AWS.Request) —

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

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

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Service Reference:

Examples:

Calling the createNotebookInstanceLifecycleConfig operation

var params = {
  NotebookInstanceLifecycleConfigName: 'STRING_VALUE', /* required */
  OnCreate: [
    {
      Content: 'STRING_VALUE'
    },
    /* more items */
  ],
  OnStart: [
    {
      Content: 'STRING_VALUE'
    },
    /* more items */
  ]
};
sagemaker.createNotebookInstanceLifecycleConfig(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: {}) —
    • NotebookInstanceLifecycleConfigName — (String)

      The name of the lifecycle configuration.

    • OnCreate — (Array<map>)

      A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

      • Content — (String)

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

    • OnStart — (Array<map>)

      A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

      • Content — (String)

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

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:

      • NotebookInstanceLifecycleConfigArn — (String)

        The Amazon Resource Name (ARN) of the lifecycle configuration.

Returns:

  • (AWS.Request) —

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

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

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

Note: The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.

Service Reference:

Examples:

Calling the createPresignedNotebookInstanceUrl operation

var params = {
  NotebookInstanceName: 'STRING_VALUE', /* required */
  SessionExpirationDurationInSeconds: 'NUMBER_VALUE'
};
sagemaker.createPresignedNotebookInstanceUrl(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: {}) —
    • NotebookInstanceName — (String)

      The name of the notebook instance.

    • SessionExpirationDurationInSeconds — (Integer)

      The duration of the session, in seconds. The default is 12 hours.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • AuthorizedUrl — (String)

        A JSON object that contains the URL string.

Returns:

  • (AWS.Request) —

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

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

Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

  • InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to to wait for a managed spot training job to complete.

For more information about Amazon SageMaker, see How It Works.

Service Reference:

Examples:

Calling the createTrainingJob operation

var params = {
  AlgorithmSpecification: { /* required */
    TrainingInputMode: Pipe | File, /* required */
    AlgorithmName: 'STRING_VALUE',
    MetricDefinitions: [
      {
        Name: 'STRING_VALUE', /* required */
        Regex: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    TrainingImage: 'STRING_VALUE'
  },
  OutputDataConfig: { /* required */
    S3OutputPath: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ResourceConfig: { /* required */
    InstanceCount: 'NUMBER_VALUE', /* required */
    InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge, /* required */
    VolumeSizeInGB: 'NUMBER_VALUE', /* required */
    VolumeKmsKeyId: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  StoppingCondition: { /* required */
    MaxRuntimeInSeconds: 'NUMBER_VALUE',
    MaxWaitTimeInSeconds: 'NUMBER_VALUE'
  },
  TrainingJobName: 'STRING_VALUE', /* required */
  CheckpointConfig: {
    S3Uri: 'STRING_VALUE', /* required */
    LocalPath: 'STRING_VALUE'
  },
  EnableInterContainerTrafficEncryption: true || false,
  EnableManagedSpotTraining: true || false,
  EnableNetworkIsolation: true || false,
  HyperParameters: {
    '<ParameterKey>': 'STRING_VALUE',
    /* '<ParameterKey>': ... */
  },
  InputDataConfig: [
    {
      ChannelName: 'STRING_VALUE', /* required */
      DataSource: { /* required */
        FileSystemDataSource: {
          DirectoryPath: 'STRING_VALUE', /* required */
          FileSystemAccessMode: rw | ro, /* required */
          FileSystemId: 'STRING_VALUE', /* required */
          FileSystemType: EFS | FSxLustre /* required */
        },
        S3DataSource: {
          S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
          S3Uri: 'STRING_VALUE', /* required */
          AttributeNames: [
            'STRING_VALUE',
            /* more items */
          ],
          S3DataDistributionType: FullyReplicated | ShardedByS3Key
        }
      },
      CompressionType: None | Gzip,
      ContentType: 'STRING_VALUE',
      InputMode: Pipe | File,
      RecordWrapperType: None | RecordIO,
      ShuffleConfig: {
        Seed: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcConfig: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
sagemaker.createTrainingJob(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: {}) —
    • TrainingJobName — (String)

      The name of the training job. The name must be unique within an AWS Region in an AWS account.

    • HyperParameters — (map<String>)

      Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

      You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

    • AlgorithmSpecification — (map)

      The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

      • TrainingImage — (String)

        The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

      • AlgorithmName — (String)

        The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

      • TrainingInputMode — required — (String)

        The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

        In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

        For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.

        Possible values include:
        • "Pipe"
        • "File"
      • MetricDefinitions — (Array<map>)

        A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

        • Name — required — (String)

          The name of the metric.

        • Regex — required — (String)

          A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

      During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.

      Note: To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
    • InputDataConfig — (Array<map>)

      An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

      Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

      Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.

      • ChannelName — required — (String)

        The name of the channel.

      • DataSource — required — (map)

        The location of the channel data.

        • S3DataSource — (map)

          The S3 location of the data source that is associated with a channel.

          • S3DataType — required — (String)

            If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

            If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

            If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

            Possible values include:
            • "ManifestFile"
            • "S3Prefix"
            • "AugmentedManifestFile"
          • S3Uri — required — (String)

            Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

            • A key name prefix might look like this: s3://bucketname/exampleprefix.

            • A manifest might look like this: s3://bucketname/example.manifest

              The manifest is an S3 object which is a JSON file with the following format:

              [

              {"prefix": "s3://customer_bucket/some/prefix/"},

              "relative/path/to/custdata-1",

              "relative/path/custdata-2",

              ...

              ]

              The preceding JSON matches the following s3Uris:

              s3://customer_bucket/some/prefix/relative/path/to/custdata-1

              s3://customer_bucket/some/prefix/relative/path/custdata-2

              ...

              The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

          • S3DataDistributionType — (String)

            If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

            If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

            Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

            In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

            Possible values include:
            • "FullyReplicated"
            • "ShardedByS3Key"
          • AttributeNames — (Array<String>)

            A list of one or more attribute names to use that are found in a specified augmented manifest file.

        • FileSystemDataSource — (map)

          The file system that is associated with a channel.

          • FileSystemId — required — (String)

            The file system id.

          • FileSystemAccessMode — required — (String)

            The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

            Possible values include:
            • "rw"
            • "ro"
          • FileSystemType — required — (String)

            The file system type.

            Possible values include:
            • "EFS"
            • "FSxLustre"
          • DirectoryPath — required — (String)

            The full path to the directory to associate with the channel.

      • ContentType — (String)

        The MIME type of the data.

      • CompressionType — (String)

        If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

        Possible values include:
        • "None"
        • "Gzip"
      • RecordWrapperType — (String)

        Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

        In File mode, leave this field unset or set it to None.

        Possible values include:
        • "None"
        • "RecordIO"
      • InputMode — (String)

        (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

        To use a model for incremental training, choose File input model.

        Possible values include:
        • "Pipe"
        • "File"
      • ShuffleConfig — (map)

        A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

        For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

        • Seed — required — (Integer)

          Determines the shuffling order in ShuffleConfig value.

    • OutputDataConfig — (map)

      Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

      • KmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

        • // KMS Key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • // Amazon Resource Name (ARN) of a KMS Key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • // KMS Key Alias

          "alias/ExampleAlias"

        • // Amazon Resource Name (ARN) of a KMS Key Alias

          "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

        The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

      • S3OutputPath — required — (String)

        Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

    • ResourceConfig — (map)

      The resources, including the ML compute instances and ML storage volumes, to use for model training.

      ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

      • InstanceType — required — (String)

        The ML compute instance type.

        Possible values include:
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.large"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
        • "ml.p3dn.24xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
      • InstanceCount — required — (Integer)

        The number of ML compute instances to use. For distributed training, provide a value greater than 1.

      • VolumeSizeInGB — required — (Integer)

        The size of the ML storage volume that you want to provision.

        ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

        You must specify sufficient ML storage for your scenario.

        Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
      • VolumeKmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

        • // KMS Key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • // Amazon Resource Name (ARN) of a KMS Key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • VpcConfig — (map)

      A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

      • SecurityGroupIds — required — (Array<String>)

        The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

      • Subnets — required — (Array<String>)

        The ID of the subnets in the VPC to which you want to connect your training job or model.

        Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
    • StoppingCondition — (map)

      Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

      To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

      • MaxRuntimeInSeconds — (Integer)

        The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

      • MaxWaitTimeInSeconds — (Integer)

        The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

    • Tags — (Array<map>)

      An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • EnableNetworkIsolation — (Boolean)

      Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

      Note: The Semantic Segmentation built-in algorithm does not support network isolation.
    • EnableInterContainerTrafficEncryption — (Boolean)

      To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

    • EnableManagedSpotTraining — (Boolean)

      To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

      The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

    • CheckpointConfig — (map)

      Contains information about the output location for managed spot training checkpoint data.

      • S3Uri — required — (String)

        Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

      • LocalPath — (String)

        (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

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:

      • TrainingJobArn — (String)

        The Amazon Resource Name (ARN) of the training job.

Returns:

  • (AWS.Request) —

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

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

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works Amazon SageMaker, see How It Works.

Service Reference:

Examples:

Calling the createTransformJob operation

var params = {
  ModelName: 'STRING_VALUE', /* required */
  TransformInput: { /* required */
    DataSource: { /* required */
      S3DataSource: { /* required */
        S3DataType: ManifestFile | S3Prefix | AugmentedManifestFile, /* required */
        S3Uri: 'STRING_VALUE' /* required */
      }
    },
    CompressionType: None | Gzip,
    ContentType: 'STRING_VALUE',
    SplitType: None | Line | RecordIO | TFRecord
  },
  TransformJobName: 'STRING_VALUE', /* required */
  TransformOutput: { /* required */
    S3OutputPath: 'STRING_VALUE', /* required */
    Accept: 'STRING_VALUE',
    AssembleWith: None | Line,
    KmsKeyId: 'STRING_VALUE'
  },
  TransformResources: { /* required */
    InstanceCount: 'NUMBER_VALUE', /* required */
    InstanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge, /* required */
    VolumeKmsKeyId: 'STRING_VALUE'
  },
  BatchStrategy: MultiRecord | SingleRecord,
  DataProcessing: {
    InputFilter: 'STRING_VALUE',
    JoinSource: Input | None,
    OutputFilter: 'STRING_VALUE'
  },
  Environment: {
    '<TransformEnvironmentKey>': 'STRING_VALUE',
    /* '<TransformEnvironmentKey>': ... */
  },
  MaxConcurrentTransforms: 'NUMBER_VALUE',
  MaxPayloadInMB: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createTransformJob(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: {}) —
    • TransformJobName — (String)

      The name of the transform job. The name must be unique within an AWS Region in an AWS account.

    • ModelName — (String)

      The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

    • MaxConcurrentTransforms — (Integer)

      The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the optimal settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

    • MaxPayloadInMB — (Integer)

      The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

      For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

    • BatchStrategy — (String)

      Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

      To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

      To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

      To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

      Possible values include:
      • "MultiRecord"
      • "SingleRecord"
    • Environment — (map<String>)

      The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

    • TransformInput — (map)

      Describes the input source and the way the transform job consumes it.

      • DataSource — required — (map)

        Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

        • S3DataSource — required — (map)

          The S3 location of the data source that is associated with a channel.

          • S3DataType — required — (String)

            If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

            If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

            The following values are compatible: ManifestFile, S3Prefix

            The following value is not compatible: AugmentedManifestFile

            Possible values include:
            • "ManifestFile"
            • "S3Prefix"
            • "AugmentedManifestFile"
          • S3Uri — required — (String)

            Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

            • A key name prefix might look like this: s3://bucketname/exampleprefix.

            • A manifest might look like this: s3://bucketname/example.manifest

              The manifest is an S3 object which is a JSON file with the following format:

              [

              {"prefix": "s3://customer_bucket/some/prefix/"},

              "relative/path/to/custdata-1",

              "relative/path/custdata-2",

              ...

              ]

              The preceding JSON matches the following S3Uris:

              s3://customer_bucket/some/prefix/relative/path/to/custdata-1

              s3://customer_bucket/some/prefix/relative/path/custdata-1

              ...

              The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

      • ContentType — (String)

        The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

      • CompressionType — (String)

        If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

        Possible values include:
        • "None"
        • "Gzip"
      • SplitType — (String)

        The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

        When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

        Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
        Possible values include:
        • "None"
        • "Line"
        • "RecordIO"
        • "TFRecord"
    • TransformOutput — (map)

      Describes the results of the transform job.

      • S3OutputPath — required — (String)

        The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

        For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

      • Accept — (String)

        The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

      • AssembleWith — (String)

        Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

        Possible values include:
        • "None"
        • "Line"
      • KmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

        • // KMS Key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • // Amazon Resource Name (ARN) of a KMS Key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • // KMS Key Alias

          "alias/ExampleAlias"

        • // Amazon Resource Name (ARN) of a KMS Key Alias

          "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

        The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

    • TransformResources — (map)

      Describes the resources, including ML instance types and ML instance count, to use for the transform job.

      • InstanceType — required — (String)

        The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

        Possible values include:
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.m5.large"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
      • InstanceCount — required — (Integer)

        The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

      • VolumeKmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

        • // KMS Key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • // Amazon Resource Name (ARN) of a KMS Key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • DataProcessing — (map)

      The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

      • InputFilter — (String)

        A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

        Examples: "$", "$[1:]", "$.features"

      • OutputFilter — (String)

        A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

        Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"

      • JoinSource — (String)

        Specifies the source of the data to join with the transformed data. The valid values are None and Input The default value is None which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input.

        For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

        For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.

        Possible values include:
        • "Input"
        • "None"
    • Tags — (Array<map>)

      (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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:

      • TransformJobArn — (String)

        The Amazon Resource Name (ARN) of the transform job.

Returns:

  • (AWS.Request) —

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

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

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

Service Reference:

Examples:

Calling the createWorkteam operation

var params = {
  Description: 'STRING_VALUE', /* required */
  MemberDefinitions: [ /* required */
    {
      CognitoMemberDefinition: {
        ClientId: 'STRING_VALUE', /* required */
        UserGroup: 'STRING_VALUE', /* required */
        UserPool: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  WorkteamName: 'STRING_VALUE', /* required */
  NotificationConfiguration: {
    NotificationTopicArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createWorkteam(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: {}) —
    • WorkteamName — (String)

      The name of the work team. Use this name to identify the work team.

    • MemberDefinitions — (Array<map>)

      A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools.

      All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.

      • CognitoMemberDefinition — (map)

        The Amazon Cognito user group that is part of the work team.

        • UserPool — required — (String)

          An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

        • UserGroup — required — (String)

          An identifier for a user group.

        • ClientId — required — (String)

          An identifier for an application client. You must create the app client ID using Amazon Cognito.

    • Description — (String)

      A description of the work team.

    • NotificationConfiguration — (map)

      Configures notification of workers regarding available or expiring work items.

      • NotificationTopicArn — (String)

        The ARN for the SNS topic to which notifications should be published.

    • Tags — (Array<map>)

      An array of key-value pairs.

      For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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:

      • WorkteamArn — (String)

        The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

Returns:

  • (AWS.Request) —

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

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

Removes the specified algorithm from your account.

Service Reference:

Examples:

Calling the deleteAlgorithm operation

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

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

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

Deletes the specified Git repository from your account.

Service Reference:

Examples:

Calling the deleteCodeRepository operation

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

      The name of the Git repository 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.

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

Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

Service Reference:

Examples:

Calling the deleteEndpoint operation

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

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

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

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

Service Reference:

Examples:

Calling the deleteEndpointConfig operation

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

      The name of the endpoint configuration 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.

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

Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

Service Reference:

Examples:

Calling the deleteModel operation

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
sagemaker.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 model 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.

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

Deletes a model package.

A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

Service Reference:

Examples:

Calling the deleteModelPackage operation

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

      The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

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.

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

Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

Service Reference:

Examples:

Calling the deleteNotebookInstance operation

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

      The name of the Amazon SageMaker notebook instance 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.

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

Deletes a notebook instance lifecycle configuration.

Service Reference:

Examples:

Calling the deleteNotebookInstanceLifecycleConfig operation

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

      The name of the lifecycle configuration 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.

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

Deletes the specified tags from an Amazon SageMaker resource.

To list a resource's tags, use the ListTags API.

Note: When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

Service Reference:

Examples:

Calling the deleteTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
sagemaker.deleteTags(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 whose tags you want to delete.

    • TagKeys — (Array<String>)

      An array or one or more tag keys 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.

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

Deletes an existing work team. This operation can't be undone.

Service Reference:

Examples:

Calling the deleteWorkteam operation

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

      The name of the work team 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. The data object has the following properties:

      • Success — (Boolean)

        Returns true if the work team was successfully deleted; otherwise, returns false.

Returns:

  • (AWS.Request) —

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

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

Returns a description of the specified algorithm that is in your account.

Service Reference:

Examples:

Calling the describeAlgorithm operation

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

      The name of the algorithm 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:

      • AlgorithmName — (String)

        The name of the algorithm being described.

      • AlgorithmArn — (String)

        The Amazon Resource Name (ARN) of the algorithm.

      • AlgorithmDescription — (String)

        A brief summary about the algorithm.

      • CreationTime — (Date)

        A timestamp specifying when the algorithm was created.

      • TrainingSpecification — (map)

        Details about training jobs run by this algorithm.

        • TrainingImage — required — (String)

          The Amazon ECR registry path of the Docker image that contains the training algorithm.

        • TrainingImageDigest — (String)

          An MD5 hash of the training algorithm that identifies the Docker image used for training.

        • SupportedHyperParameters — (Array<map>)

          A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

          • Name — required — (String)

            The name of this hyperparameter. The name must be unique.

          • Description — (String)

            A brief description of the hyperparameter.

          • Type — required — (String)

            The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

            Possible values include:
            • "Integer"
            • "Continuous"
            • "Categorical"
            • "FreeText"
          • Range — (map)

            The allowed range for this hyperparameter.

            • IntegerParameterRangeSpecification — (map)

              A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

              • MinValue — required — (String)

                The minimum integer value allowed.

              • MaxValue — required — (String)

                The maximum integer value allowed.

            • ContinuousParameterRangeSpecification — (map)

              A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

              • MinValue — required — (String)

                The minimum floating-point value allowed.

              • MaxValue — required — (String)

                The maximum floating-point value allowed.

            • CategoricalParameterRangeSpecification — (map)

              A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

              • Values — required — (Array<String>)

                The allowed categories for the hyperparameter.

          • IsTunable — (Boolean)

            Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

          • IsRequired — (Boolean)

            Indicates whether this hyperparameter is required.

          • DefaultValue — (String)

            The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

        • SupportedTrainingInstanceTypes — required — (Array<String>)

          A list of the instance types that this algorithm can use for training.

        • SupportsDistributedTraining — (Boolean)

          Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.

        • MetricDefinitions — (Array<map>)

          A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

          • Name — required — (String)

            The name of the metric.

          • Regex — required — (String)

            A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

        • TrainingChannels — required — (Array<map>)

          A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

          • Name — required — (String)

            The name of the channel.

          • Description — (String)

            A brief description of the channel.

          • IsRequired — (Boolean)

            Indicates whether the channel is required by the algorithm.

          • SupportedContentTypes — required — (Array<String>)

            The supported MIME types for the data.

          • SupportedCompressionTypes — (Array<String>)

            The allowed compression types, if data compression is used.

          • SupportedInputModes — required — (Array<String>)

            The allowed input mode, either FILE or PIPE.

            In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

            In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

        • SupportedTuningJobObjectiveMetrics — (Array<map>)

          A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

          • Type — required — (String)

            Whether to minimize or maximize the objective metric.

            Possible values include:
            • "Maximize"
            • "Minimize"
          • MetricName — required — (String)

            The name of the metric to use for the objective metric.

      • InferenceSpecification — (map)

        Details about inference jobs that the algorithm runs.

        • Containers — required — (Array<map>)

          The Amazon ECR registry path of the Docker image that contains the inference code.

          • ContainerHostname — (String)

            The DNS host name for the Docker container.

          • Image — required — (String)

            The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

            If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

          • ImageDigest — (String)

            An MD5 hash of the training algorithm that identifies the Docker image used for training.

          • ModelDataUrl — (String)

            The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

          • ProductId — (String)

            The AWS Marketplace product ID of the model package.

        • SupportedTransformInstanceTypes — required — (Array<String>)

          A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

        • SupportedRealtimeInferenceInstanceTypes — required — (Array<String>)

          A list of the instance types that are used to generate inferences in real-time.

        • SupportedContentTypes — required — (Array<String>)

          The supported MIME types for the input data.

        • SupportedResponseMIMETypes — required — (Array<String>)

          The supported MIME types for the output data.

      • ValidationSpecification — (map)

        Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

        • ValidationRole — required — (String)

          The IAM roles that Amazon SageMaker uses to run the training jobs.

        • ValidationProfiles — required — (Array<map>)

          An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

          • ProfileName — required — (String)

            The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

          • TrainingJobDefinition — required — (map)

            The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.

            • TrainingInputMode — required — (String)

              The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

              If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

              Possible values include:
              • "Pipe"
              • "File"
            • HyperParameters — (map<String>)

              The hyperparameters used for the training job.

            • InputDataConfig — required — (Array<map>)

              An array of Channel objects, each of which specifies an input source.

              • ChannelName — required — (String)

                The name of the channel.

              • DataSource — required — (map)

                The location of the channel data.

                • S3DataSource — (map)

                  The S3 location of the data source that is associated with a channel.

                  • S3DataType — required — (String)

                    If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

                    If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

                    If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

                    Possible values include:
                    • "ManifestFile"
                    • "S3Prefix"
                    • "AugmentedManifestFile"
                  • S3Uri — required — (String)

                    Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                    • A key name prefix might look like this: s3://bucketname/exampleprefix.

                    • A manifest might look like this: s3://bucketname/example.manifest

                      The manifest is an S3 object which is a JSON file with the following format:

                      [

                      {"prefix": "s3://customer_bucket/some/prefix/"},

                      "relative/path/to/custdata-1",

                      "relative/path/custdata-2",

                      ...

                      ]

                      The preceding JSON matches the following s3Uris:

                      s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                      s3://customer_bucket/some/prefix/relative/path/custdata-2

                      ...

                      The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

                  • S3DataDistributionType — (String)

                    If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

                    If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

                    Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

                    In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

                    Possible values include:
                    • "FullyReplicated"
                    • "ShardedByS3Key"
                  • AttributeNames — (Array<String>)

                    A list of one or more attribute names to use that are found in a specified augmented manifest file.

                • FileSystemDataSource — (map)

                  The file system that is associated with a channel.

                  • FileSystemId — required — (String)

                    The file system id.

                  • FileSystemAccessMode — required — (String)

                    The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

                    Possible values include:
                    • "rw"
                    • "ro"
                  • FileSystemType — required — (String)

                    The file system type.

                    Possible values include:
                    • "EFS"
                    • "FSxLustre"
                  • DirectoryPath — required — (String)

                    The full path to the directory to associate with the channel.

              • ContentType — (String)

                The MIME type of the data.

              • CompressionType — (String)

                If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

                Possible values include:
                • "None"
                • "Gzip"
              • RecordWrapperType — (String)

                Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

                In File mode, leave this field unset or set it to None.

                Possible values include:
                • "None"
                • "RecordIO"
              • InputMode — (String)

                (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

                To use a model for incremental training, choose File input model.

                Possible values include:
                • "Pipe"
                • "File"
              • ShuffleConfig — (map)

                A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

                For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

                • Seed — required — (Integer)

                  Determines the shuffling order in ShuffleConfig value.

            • OutputDataConfig — required — (map)

              the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

              • KmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

                • // KMS Key Alias

                  "alias/ExampleAlias"

                • // Amazon Resource Name (ARN) of a KMS Key Alias

                  "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

                If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

                The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

              • S3OutputPath — required — (String)

                Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

            • ResourceConfig — required — (map)

              The resources, including the ML compute instances and ML storage volumes, to use for model training.

              • InstanceType — required — (String)

                The ML compute instance type.

                Possible values include:
                • "ml.m4.xlarge"
                • "ml.m4.2xlarge"
                • "ml.m4.4xlarge"
                • "ml.m4.10xlarge"
                • "ml.m4.16xlarge"
                • "ml.m5.large"
                • "ml.m5.xlarge"
                • "ml.m5.2xlarge"
                • "ml.m5.4xlarge"
                • "ml.m5.12xlarge"
                • "ml.m5.24xlarge"
                • "ml.c4.xlarge"
                • "ml.c4.2xlarge"
                • "ml.c4.4xlarge"
                • "ml.c4.8xlarge"
                • "ml.p2.xlarge"
                • "ml.p2.8xlarge"
                • "ml.p2.16xlarge"
                • "ml.p3.2xlarge"
                • "ml.p3.8xlarge"
                • "ml.p3.16xlarge"
                • "ml.p3dn.24xlarge"
                • "ml.c5.xlarge"
                • "ml.c5.2xlarge"
                • "ml.c5.4xlarge"
                • "ml.c5.9xlarge"
                • "ml.c5.18xlarge"
              • InstanceCount — required — (Integer)

                The number of ML compute instances to use. For distributed training, provide a value greater than 1.

              • VolumeSizeInGB — required — (Integer)

                The size of the ML storage volume that you want to provision.

                ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

                You must specify sufficient ML storage for your scenario.

                Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
              • VolumeKmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

            • StoppingCondition — required — (map)

              Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

              To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

              • MaxRuntimeInSeconds — (Integer)

                The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

              • MaxWaitTimeInSeconds — (Integer)

                The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

          • TransformJobDefinition — (map)

            The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.

            • MaxConcurrentTransforms — (Integer)

              The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

            • MaxPayloadInMB — (Integer)

              The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

            • BatchStrategy — (String)

              A string that determines the number of records included in a single mini-batch.

              SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

              Possible values include:
              • "MultiRecord"
              • "SingleRecord"
            • Environment — (map<String>)

              The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

            • TransformInput — required — (map)

              A description of the input source and the way the transform job consumes it.

              • DataSource — required — (map)

                Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

                • S3DataSource — required — (map)

                  The S3 location of the data source that is associated with a channel.

                  • S3DataType — required — (String)

                    If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

                    If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

                    The following values are compatible: ManifestFile, S3Prefix

                    The following value is not compatible: AugmentedManifestFile

                    Possible values include:
                    • "ManifestFile"
                    • "S3Prefix"
                    • "AugmentedManifestFile"
                  • S3Uri — required — (String)

                    Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                    • A key name prefix might look like this: s3://bucketname/exampleprefix.

                    • A manifest might look like this: s3://bucketname/example.manifest

                      The manifest is an S3 object which is a JSON file with the following format:

                      [

                      {"prefix": "s3://customer_bucket/some/prefix/"},

                      "relative/path/to/custdata-1",

                      "relative/path/custdata-2",

                      ...

                      ]

                      The preceding JSON matches the following S3Uris:

                      s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                      s3://customer_bucket/some/prefix/relative/path/custdata-1

                      ...

                      The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

              • ContentType — (String)

                The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

              • CompressionType — (String)

                If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

                Possible values include:
                • "None"
                • "Gzip"
              • SplitType — (String)

                The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

                When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

                Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
                Possible values include:
                • "None"
                • "Line"
                • "RecordIO"
                • "TFRecord"
            • TransformOutput — required — (map)

              Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

              • S3OutputPath — required — (String)

                The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

                For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

              • Accept — (String)

                The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

              • AssembleWith — (String)

                Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

                Possible values include:
                • "None"
                • "Line"
              • KmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

                • // KMS Key Alias

                  "alias/ExampleAlias"

                • // Amazon Resource Name (ARN) of a KMS Key Alias

                  "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

                If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

                The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

            • TransformResources — required — (map)

              Identifies the ML compute instances for the transform job.

              • InstanceType — required — (String)

                The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

                Possible values include:
                • "ml.m4.xlarge"
                • "ml.m4.2xlarge"
                • "ml.m4.4xlarge"
                • "ml.m4.10xlarge"
                • "ml.m4.16xlarge"
                • "ml.c4.xlarge"
                • "ml.c4.2xlarge"
                • "ml.c4.4xlarge"
                • "ml.c4.8xlarge"
                • "ml.p2.xlarge"
                • "ml.p2.8xlarge"
                • "ml.p2.16xlarge"
                • "ml.p3.2xlarge"
                • "ml.p3.8xlarge"
                • "ml.p3.16xlarge"
                • "ml.c5.xlarge"
                • "ml.c5.2xlarge"
                • "ml.c5.4xlarge"
                • "ml.c5.9xlarge"
                • "ml.c5.18xlarge"
                • "ml.m5.large"
                • "ml.m5.xlarge"
                • "ml.m5.2xlarge"
                • "ml.m5.4xlarge"
                • "ml.m5.12xlarge"
                • "ml.m5.24xlarge"
              • InstanceCount — required — (Integer)

                The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

              • VolumeKmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • AlgorithmStatus — (String)

        The current status of the algorithm.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • AlgorithmStatusDetails — (map)

        Details about the current status of the algorithm.

        • ValidationStatuses — (Array<map>)

          The status of algorithm validation.

          • Name — required — (String)

            The name of the algorithm for which the overall status is being reported.

          • Status — required — (String)

            The current status.

            Possible values include:
            • "NotStarted"
            • "InProgress"
            • "Completed"
            • "Failed"
          • FailureReason — (String)

            if the overall status is Failed, the reason for the failure.

        • ImageScanStatuses — (Array<map>)

          The status of the scan of the algorithm's Docker image container.

          • Name — required — (String)

            The name of the algorithm for which the overall status is being reported.

          • Status — required — (String)

            The current status.

            Possible values include:
            • "NotStarted"
            • "InProgress"
            • "Completed"
            • "Failed"
          • FailureReason — (String)

            if the overall status is Failed, the reason for the failure.

      • ProductId — (String)

        The product identifier of the algorithm.

      • CertifyForMarketplace — (Boolean)

        Whether the algorithm is certified to be listed in AWS Marketplace.

Returns:

  • (AWS.Request) —

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

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

Gets details about the specified Git repository.

Service Reference:

Examples:

Calling the describeCodeRepository operation

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

      The name of the Git repository 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:

      • CodeRepositoryName — (String)

        The name of the Git repository.

      • CodeRepositoryArn — (String)

        The Amazon Resource Name (ARN) of the Git repository.

      • CreationTime — (Date)

        The date and time that the repository was created.

      • LastModifiedTime — (Date)

        The date and time that the repository was last changed.

      • GitConfig — (map)

        Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository.

        • RepositoryUrl — required — (String)

          The URL where the Git repository is located.

        • Branch — (String)

          The default branch for the Git repository.

        • SecretArn — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

          {"username": UserName, "password": Password}

Returns:

  • (AWS.Request) —

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

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

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Service Reference:

Examples:

Calling the describeCompilationJob operation

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

      The name of the model compilation job that you want information about.

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:

      • CompilationJobName — (String)

        The name of the model compilation job.

      • CompilationJobArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

      • CompilationJobStatus — (String)

        The status of the model compilation job.

        Possible values include:
        • "INPROGRESS"
        • "COMPLETED"
        • "FAILED"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • CompilationStartTime — (Date)

        The time when the model compilation job started the CompilationJob instances.

        You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

      • CompilationEndTime — (Date)

        The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

      • StoppingCondition — (map)

        Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

        • MaxRuntimeInSeconds — (Integer)

          The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

        • MaxWaitTimeInSeconds — (Integer)

          The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

      • CreationTime — (Date)

        The time that the model compilation job was created.

      • LastModifiedTime — (Date)

        The time that the status of the model compilation job was last modified.

      • FailureReason — (String)

        If a model compilation job failed, the reason it failed.

      • ModelArtifacts — (map)

        Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

        • S3ModelArtifacts — required — (String)

          The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the model compilation job.

      • InputConfig — (map)

        Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

        • S3Uri — required — (String)

          The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

        • DataInputConfig — required — (String)

          Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

          • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

            • Examples for one input:

              • If using the console, {"input":[1,1024,1024,3]}

              • If using the CLI, {\"input\":[1,1024,1024,3]}

            • Examples for two inputs:

              • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

              • If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

          • MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

            • Examples for one input:

              • If using the console, {"data":[1,3,1024,1024]}

              • If using the CLI, {\"data\":[1,3,1024,1024]}

            • Examples for two inputs:

              • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

              • If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

          • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

            • Examples for one input in dictionary format:

              • If using the console, {"input0":[1,3,224,224]}

              • If using the CLI, {\"input0\":[1,3,224,224]}

            • Example for one input in list format: [[1,3,224,224]]

            • Examples for two inputs in dictionary format:

              • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

              • If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

            • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

          • XGBOOST: input data name and shape are not needed.

        • Framework — required — (String)

          Identifies the framework in which the model was trained. For example: TENSORFLOW.

          Possible values include:
          • "TENSORFLOW"
          • "MXNET"
          • "ONNX"
          • "PYTORCH"
          • "XGBOOST"
      • OutputConfig — (map)

        Information about the output location for the compiled model and the target device that the model runs on.

        • S3OutputLocation — required — (String)

          Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

        • TargetDevice — required — (String)

          Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.

          Possible values include:
          • "lambda"
          • "ml_m4"
          • "ml_m5"
          • "ml_c4"
          • "ml_c5"
          • "ml_p2"
          • "ml_p3"
          • "jetson_tx1"
          • "jetson_tx2"
          • "jetson_nano"
          • "rasp3b"
          • "deeplens"
          • "rk3399"
          • "rk3288"
          • "aisage"
          • "sbe_c"
          • "qcs605"
          • "qcs603"

Returns:

  • (AWS.Request) —

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

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

Returns the description of an endpoint.

Service Reference:

Examples:

Calling the describeEndpoint operation

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

      The name of the endpoint.

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:

      • EndpointName — (String)

        Name of the endpoint.

      • EndpointArn — (String)

        The Amazon Resource Name (ARN) of the endpoint.

      • EndpointConfigName — (String)

        The name of the endpoint configuration associated with this endpoint.

      • ProductionVariants — (Array<map>)

        An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

        • VariantName — required — (String)

          The name of the variant.

        • DeployedImages — (Array<map>)

          An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

          • SpecifiedImage — (String)

            The image path you specified when you created the model.

          • ResolvedImage — (String)

            The specific digest path of the image hosted in this ProductionVariant.

          • ResolutionTime — (Date)

            The date and time when the image path for the model resolved to the ResolvedImage

        • CurrentWeight — (Float)

          The weight associated with the variant.

        • DesiredWeight — (Float)

          The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

        • CurrentInstanceCount — (Integer)

          The number of instances associated with the variant.

        • DesiredInstanceCount — (Integer)

          The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

      • EndpointStatus — (String)

        The status of the endpoint.

        • OutOfService: Endpoint is not available to take incoming requests.

        • Creating: CreateEndpoint is executing.

        • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

        • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

        • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

        • InService: Endpoint is available to process incoming requests.

        • Deleting: DeleteEndpoint is executing.

        • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

        Possible values include:
        • "OutOfService"
        • "Creating"
        • "Updating"
        • "SystemUpdating"
        • "RollingBack"
        • "InService"
        • "Deleting"
        • "Failed"
      • FailureReason — (String)

        If the status of the endpoint is Failed, the reason why it failed.

      • CreationTime — (Date)

        A timestamp that shows when the endpoint was created.

      • LastModifiedTime — (Date)

        A timestamp that shows when the endpoint was last modified.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Service Reference:

Examples:

Calling the describeEndpointConfig operation

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

      The name of the endpoint configuration.

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:

      • EndpointConfigName — (String)

        Name of the Amazon SageMaker endpoint configuration.

      • EndpointConfigArn — (String)

        The Amazon Resource Name (ARN) of the endpoint configuration.

      • ProductionVariants — (Array<map>)

        An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

        • VariantName — required — (String)

          The name of the production variant.

        • ModelName — required — (String)

          The name of the model that you want to host. This is the name that you specified when creating the model.

        • InitialInstanceCount — required — (Integer)

          Number of instances to launch initially.

        • InstanceType — required — (String)

          The ML compute instance type.

          Possible values include:
          • "ml.t2.medium"
          • "ml.t2.large"
          • "ml.t2.xlarge"
          • "ml.t2.2xlarge"
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
          • "ml.m5d.large"
          • "ml.m5d.xlarge"
          • "ml.m5d.2xlarge"
          • "ml.m5d.4xlarge"
          • "ml.m5d.12xlarge"
          • "ml.m5d.24xlarge"
          • "ml.c4.large"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.c5.large"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
          • "ml.c5d.large"
          • "ml.c5d.xlarge"
          • "ml.c5d.2xlarge"
          • "ml.c5d.4xlarge"
          • "ml.c5d.9xlarge"
          • "ml.c5d.18xlarge"
          • "ml.g4dn.xlarge"
          • "ml.g4dn.2xlarge"
          • "ml.g4dn.4xlarge"
          • "ml.g4dn.8xlarge"
          • "ml.g4dn.12xlarge"
          • "ml.g4dn.16xlarge"
          • "ml.r5.large"
          • "ml.r5.xlarge"
          • "ml.r5.2xlarge"
          • "ml.r5.4xlarge"
          • "ml.r5.12xlarge"
          • "ml.r5.24xlarge"
          • "ml.r5d.large"
          • "ml.r5d.xlarge"
          • "ml.r5d.2xlarge"
          • "ml.r5d.4xlarge"
          • "ml.r5d.12xlarge"
          • "ml.r5d.24xlarge"
        • InitialVariantWeight — (Float)

          Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

        • AcceleratorType — (String)

          The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

          Possible values include:
          • "ml.eia1.medium"
          • "ml.eia1.large"
          • "ml.eia1.xlarge"
          • "ml.eia2.medium"
          • "ml.eia2.large"
          • "ml.eia2.xlarge"
      • KmsKeyId — (String)

        AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      • CreationTime — (Date)

        A timestamp that shows when the endpoint configuration was created.

Returns:

  • (AWS.Request) —

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

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

Gets a description of a hyperparameter tuning job.

Service Reference:

Examples:

Calling the describeHyperParameterTuningJob operation

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

      The name of the tuning job 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:

      • HyperParameterTuningJobName — (String)

        The name of the tuning job.

      • HyperParameterTuningJobArn — (String)

        The Amazon Resource Name (ARN) of the tuning job.

      • HyperParameterTuningJobConfig — (map)

        The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

        • Strategy — required — (String)

          Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.

          Possible values include:
          • "Bayesian"
          • "Random"
        • HyperParameterTuningJobObjective — (map)

          The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

          • Type — required — (String)

            Whether to minimize or maximize the objective metric.

            Possible values include:
            • "Maximize"
            • "Minimize"
          • MetricName — required — (String)

            The name of the metric to use for the objective metric.

        • ResourceLimits — required — (map)

          The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

          • MaxNumberOfTrainingJobs — required — (Integer)

            The maximum number of training jobs that a hyperparameter tuning job can launch.

          • MaxParallelTrainingJobs — required — (Integer)

            The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

        • ParameterRanges — (map)

          The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

          • IntegerParameterRanges — (Array<map>)

            The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

            • Name — required — (String)

              The name of the hyperparameter to search.

            • MinValue — required — (String)

              The minimum value of the hyperparameter to search.

            • MaxValue — required — (String)

              The maximum value of the hyperparameter to search.

            • ScalingType — (String)

              The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

              Auto

              Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

              Linear

              Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

              Logarithmic

              Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale.

              Logarithmic scaling works only for ranges that have only values greater than 0.

              Possible values include:
              • "Auto"
              • "Linear"
              • "Logarithmic"
              • "ReverseLogarithmic"
          • ContinuousParameterRanges — (Array<map>)

            The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

            • Name — required — (String)

              The name of the continuous hyperparameter to tune.

            • MinValue — required — (String)

              The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

            • MaxValue — required — (String)

              The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

            • ScalingType — (String)

              The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

              Auto

              Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

              Linear

              Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

              Logarithmic

              Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

              Logarithmic scaling works only for ranges that have only values greater than 0.

              ReverseLogarithmic

              Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

              Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

              Possible values include:
              • "Auto"
              • "Linear"
              • "Logarithmic"
              • "ReverseLogarithmic"
          • CategoricalParameterRanges — (Array<map>)

            The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

            • Name — required — (String)

              The name of the categorical hyperparameter to tune.

            • Values — required — (Array<String>)

              A list of the categories for the hyperparameter.

        • TrainingJobEarlyStoppingType — (String)

          Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

          OFF

          Training jobs launched by the hyperparameter tuning job do not use early stopping.

          AUTO

          Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

          Possible values include:
          • "Off"
          • "Auto"
      • TrainingJobDefinition — (map)

        The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

        • StaticHyperParameters — (map<String>)

          Specifies the values of hyperparameters that do not change for the tuning job.

        • AlgorithmSpecification — required — (map)

          The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

          • TrainingImage — (String)

            The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

          • TrainingInputMode — required — (String)

            The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

            If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

            For more information about input modes, see Algorithms.

            Possible values include:
            • "Pipe"
            • "File"
          • AlgorithmName — (String)

            The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

          • MetricDefinitions — (Array<map>)

            An array of MetricDefinition objects that specify the metrics that the algorithm emits.

            • Name — required — (String)

              The name of the metric.

            • Regex — required — (String)

              A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

        • RoleArn — required — (String)

          The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

        • InputDataConfig — (Array<map>)

          An array of Channel objects that specify the input for the training jobs that the tuning job launches.

          • ChannelName — required — (String)

            The name of the channel.

          • DataSource — required — (map)

            The location of the channel data.

            • S3DataSource — (map)

              The S3 location of the data source that is associated with a channel.

              • S3DataType — required — (String)

                If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

                If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

                If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

                Possible values include:
                • "ManifestFile"
                • "S3Prefix"
                • "AugmentedManifestFile"
              • S3Uri — required — (String)

                Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                • A key name prefix might look like this: s3://bucketname/exampleprefix.

                • A manifest might look like this: s3://bucketname/example.manifest

                  The manifest is an S3 object which is a JSON file with the following format:

                  [

                  {"prefix": "s3://customer_bucket/some/prefix/"},

                  "relative/path/to/custdata-1",

                  "relative/path/custdata-2",

                  ...

                  ]

                  The preceding JSON matches the following s3Uris:

                  s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                  s3://customer_bucket/some/prefix/relative/path/custdata-2

                  ...

                  The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

              • S3DataDistributionType — (String)

                If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

                If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

                Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

                In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

                Possible values include:
                • "FullyReplicated"
                • "ShardedByS3Key"
              • AttributeNames — (Array<String>)

                A list of one or more attribute names to use that are found in a specified augmented manifest file.

            • FileSystemDataSource — (map)

              The file system that is associated with a channel.

              • FileSystemId — required — (String)

                The file system id.

              • FileSystemAccessMode — required — (String)

                The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

                Possible values include:
                • "rw"
                • "ro"
              • FileSystemType — required — (String)

                The file system type.

                Possible values include:
                • "EFS"
                • "FSxLustre"
              • DirectoryPath — required — (String)

                The full path to the directory to associate with the channel.

          • ContentType — (String)

            The MIME type of the data.

          • CompressionType — (String)

            If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

            Possible values include:
            • "None"
            • "Gzip"
          • RecordWrapperType — (String)

            Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

            In File mode, leave this field unset or set it to None.

            Possible values include:
            • "None"
            • "RecordIO"
          • InputMode — (String)

            (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

            To use a model for incremental training, choose File input model.

            Possible values include:
            • "Pipe"
            • "File"
          • ShuffleConfig — (map)

            A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

            For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

            • Seed — required — (Integer)

              Determines the shuffling order in ShuffleConfig value.

        • VpcConfig — (map)

          The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

          • SecurityGroupIds — required — (Array<String>)

            The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

          • Subnets — required — (Array<String>)

            The ID of the subnets in the VPC to which you want to connect your training job or model.

            Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
        • OutputDataConfig — required — (map)

          Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

          • KmsKeyId — (String)

            The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

            • // KMS Key ID

              "1234abcd-12ab-34cd-56ef-1234567890ab"

            • // Amazon Resource Name (ARN) of a KMS Key

              "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

            • // KMS Key Alias

              "alias/ExampleAlias"

            • // Amazon Resource Name (ARN) of a KMS Key Alias

              "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

            If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

            The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

          • S3OutputPath — required — (String)

            Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

        • ResourceConfig — required — (map)

          The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

          Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

          • InstanceType — required — (String)

            The ML compute instance type.

            Possible values include:
            • "ml.m4.xlarge"
            • "ml.m4.2xlarge"
            • "ml.m4.4xlarge"
            • "ml.m4.10xlarge"
            • "ml.m4.16xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.24xlarge"
            • "ml.c4.xlarge"
            • "ml.c4.2xlarge"
            • "ml.c4.4xlarge"
            • "ml.c4.8xlarge"
            • "ml.p2.xlarge"
            • "ml.p2.8xlarge"
            • "ml.p2.16xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.p3dn.24xlarge"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.18xlarge"
          • InstanceCount — required — (Integer)

            The number of ML compute instances to use. For distributed training, provide a value greater than 1.

          • VolumeSizeInGB — required — (Integer)

            The size of the ML storage volume that you want to provision.

            ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

            You must specify sufficient ML storage for your scenario.

            Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
          • VolumeKmsKeyId — (String)

            The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

            • // KMS Key ID

              "1234abcd-12ab-34cd-56ef-1234567890ab"

            • // Amazon Resource Name (ARN) of a KMS Key

              "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • StoppingCondition — required — (map)

          Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

          • MaxRuntimeInSeconds — (Integer)

            The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

          • MaxWaitTimeInSeconds — (Integer)

            The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

        • EnableNetworkIsolation — (Boolean)

          Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

          Note: The Semantic Segmentation built-in algorithm does not support network isolation.
        • EnableInterContainerTrafficEncryption — (Boolean)

          To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

        • EnableManagedSpotTraining — (Boolean)

          A Boolean indicating whether managed spot training is enabled (True) or not (False).

        • CheckpointConfig — (map)

          Contains information about the output location for managed spot training checkpoint data.

          • S3Uri — required — (String)

            Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

          • LocalPath — (String)

            (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

      • HyperParameterTuningJobStatus — (String)

        The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

        Possible values include:
        • "Completed"
        • "InProgress"
        • "Failed"
        • "Stopped"
        • "Stopping"
      • CreationTime — (Date)

        The date and time that the tuning job started.

      • HyperParameterTuningEndTime — (Date)

        The date and time that the tuning job ended.

      • LastModifiedTime — (Date)

        The date and time that the status of the tuning job was modified.

      • TrainingJobStatusCounters — (map)

        The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

        • Completed — (Integer)

          The number of completed training jobs launched by the hyperparameter tuning job.

        • InProgress — (Integer)

          The number of in-progress training jobs launched by a hyperparameter tuning job.

        • RetryableError — (Integer)

          The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

        • NonRetryableError — (Integer)

          The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

        • Stopped — (Integer)

          The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

      • ObjectiveStatusCounters — (map)

        The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

        • Succeeded — (Integer)

          The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

        • Pending — (Integer)

          The number of training jobs that are in progress and pending evaluation of their final objective metric.

        • Failed — (Integer)

          The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

      • BestTrainingJob — (map)

        A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

        • TrainingJobName — required — (String)

          The name of the training job.

        • TrainingJobArn — required — (String)

          The Amazon Resource Name (ARN) of the training job.

        • TuningJobName — (String)

          The HyperParameter tuning job that launched the training job.

        • CreationTime — required — (Date)

          The date and time that the training job was created.

        • TrainingStartTime — (Date)

          The date and time that the training job started.

        • TrainingEndTime — (Date)

          Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

        • TrainingJobStatus — required — (String)

          The status of the training job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • TunedHyperParameters — required — (map<String>)

          A list of the hyperparameters for which you specified ranges to search.

        • FailureReason — (String)

          The reason that the training job failed.

        • FinalHyperParameterTuningJobObjectiveMetric — (map)

          The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

          • Type — (String)

            Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

            Possible values include:
            • "Maximize"
            • "Minimize"
          • MetricName — required — (String)

            The name of the objective metric.

          • Value — required — (Float)

            The value of the objective metric.

        • ObjectiveStatus — (String)

          The status of the objective metric for the training job:

          • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

          • Pending: The training job is in progress and evaluation of its final objective metric is pending.

          • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

          Possible values include:
          • "Succeeded"
          • "Pending"
          • "Failed"
      • OverallBestTrainingJob — (map)

        If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

        • TrainingJobName — required — (String)

          The name of the training job.

        • TrainingJobArn — required — (String)

          The Amazon Resource Name (ARN) of the training job.

        • TuningJobName — (String)

          The HyperParameter tuning job that launched the training job.

        • CreationTime — required — (Date)

          The date and time that the training job was created.

        • TrainingStartTime — (Date)

          The date and time that the training job started.

        • TrainingEndTime — (Date)

          Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

        • TrainingJobStatus — required — (String)

          The status of the training job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • TunedHyperParameters — required — (map<String>)

          A list of the hyperparameters for which you specified ranges to search.

        • FailureReason — (String)

          The reason that the training job failed.

        • FinalHyperParameterTuningJobObjectiveMetric — (map)

          The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

          • Type — (String)

            Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

            Possible values include:
            • "Maximize"
            • "Minimize"
          • MetricName — required — (String)

            The name of the objective metric.

          • Value — required — (Float)

            The value of the objective metric.

        • ObjectiveStatus — (String)

          The status of the objective metric for the training job:

          • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

          • Pending: The training job is in progress and evaluation of its final objective metric is pending.

          • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

          Possible values include:
          • "Succeeded"
          • "Pending"
          • "Failed"
      • WarmStartConfig — (map)

        The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

        • ParentHyperParameterTuningJobs — required — (Array<map>)

          An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

          Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

          • HyperParameterTuningJobName — (String)

            The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

        • WarmStartType — required — (String)

          Specifies one of the following:

          IDENTICAL_DATA_AND_ALGORITHM

          The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

          TRANSFER_LEARNING

          The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

          Possible values include:
          • "IdenticalDataAndAlgorithm"
          • "TransferLearning"
      • FailureReason — (String)

        If the tuning job failed, the reason it failed.

Returns:

  • (AWS.Request) —

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

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

Gets information about a labeling job.

Service Reference:

Examples:

Calling the describeLabelingJob operation

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

      The name of the labeling job to return information for.

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:

      • LabelingJobStatus — (String)

        The processing status of the labeling job.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Stopping"
        • "Stopped"
      • LabelCounters — (map)

        Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

        • TotalLabeled — (Integer)

          The total number of objects labeled.

        • HumanLabeled — (Integer)

          The total number of objects labeled by a human worker.

        • MachineLabeled — (Integer)

          The total number of objects labeled by automated data labeling.

        • FailedNonRetryableError — (Integer)

          The total number of objects that could not be labeled due to an error.

        • Unlabeled — (Integer)

          The total number of objects not yet labeled.

      • FailureReason — (String)

        If the job failed, the reason that it failed.

      • CreationTime — (Date)

        The date and time that the labeling job was created.

      • LastModifiedTime — (Date)

        The date and time that the labeling job was last updated.

      • JobReferenceCode — (String)

        A unique identifier for work done as part of a labeling job.

      • LabelingJobName — (String)

        The name assigned to the labeling job when it was created.

      • LabelingJobArn — (String)

        The Amazon Resource Name (ARN) of the labeling job.

      • LabelAttributeName — (String)

        The attribute used as the label in the output manifest file.

      • InputConfig — (map)

        Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

        • DataSource — required — (map)

          The location of the input data.

          • S3DataSource — required — (map)

            The Amazon S3 location of the input data objects.

            • ManifestS3Uri — required — (String)

              The Amazon S3 location of the manifest file that describes the input data objects.

        • DataAttributes — (map)

          Attributes of the data specified by the customer.

          • ContentClassifiers — (Array<String>)

            Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

      • OutputConfig — (map)

        The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

        • S3OutputPath — required — (String)

          The Amazon S3 location to write output data.

        • KmsKeyId — (String)

          The AWS Key Management Service ID of the key used to encrypt the output data, if any.

          If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

          The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

      • LabelCategoryConfigS3Uri — (String)

        The S3 location of the JSON file that defines the categories used to label data objects.

        The file is a JSON structure in the following format:

        {

        "document-version": "2018-11-28"

        "labels": [

        {

        "label": "label 1"

        },

        {

        "label": "label 2"

        },

        ...

        {

        "label": "label n"

        }

        ]

        }

      • StoppingConditions — (map)

        A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

        • MaxHumanLabeledObjectCount — (Integer)

          The maximum number of objects that can be labeled by human workers.

        • MaxPercentageOfInputDatasetLabeled — (Integer)

          The maximum number of input data objects that should be labeled.

      • LabelingJobAlgorithmsConfig — (map)

        Configuration information for automated data labeling.

        • LabelingJobAlgorithmSpecificationArn — required — (String)

          Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

          • Image classification

            arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

          • Text classification

            arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

          • Object detection

            arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

          • Semantic Segmentation

            arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

        • InitialActiveLearningModelArn — (String)

          At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

        • LabelingJobResourceConfig — (map)

          Provides configuration information for a labeling job.

          • VolumeKmsKeyId — (String)

            The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

            • // KMS Key ID

              "1234abcd-12ab-34cd-56ef-1234567890ab"

            • // Amazon Resource Name (ARN) of a KMS Key

              "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • HumanTaskConfig — (map)

        Configuration information required for human workers to complete a labeling task.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

        • UiConfig — required — (map)

          Information about the user interface that workers use to complete the labeling task.

        • PreHumanTaskLambdaArn — required — (String)

          The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

          For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

          US East (Northern Virginia) (us-east-1):

          • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

          • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

          • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

          • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

          • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

          US East (Ohio) (us-east-2):

          • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

          • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

          • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

          • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

          • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

          US West (Oregon) (us-west-2):

          • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

          • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

          • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

          • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

          • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

          Canada (Central) (ca-central-1):

          • arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

          • arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

          • arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

          • arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

          • arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

          EU (Ireland) (eu-west-1):

          • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

          • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

          • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

          • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

          • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

          EU (London) (eu-west-2):

          • arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

          • arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

          • arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

          • arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

          • arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

          EU Frankfurt (eu-central-1):

          • arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

          • arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

          • arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

          • arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

          • arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

          Asia Pacific (Tokyo) (ap-northeast-1):

          • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

          • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

          • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

          • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

          Asia Pacific (Seoul) (ap-northeast-2):

          • arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

          • arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

          • arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

          • arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

          • arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

          Asia Pacific (Mumbai) (ap-south-1):

          • arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

          • arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

          • arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

          • arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

          • arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

          Asia Pacific (Singapore) (ap-southeast-1):

          • arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

          • arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

          • arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

          • arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

          • arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

          Asia Pacific (Sydney) (ap-southeast-2):

          • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

          • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

          • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

          • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

        • TaskKeywords — (Array<String>)

          Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

        • TaskTitle — required — (String)

          A title for the task for your human workers.

        • TaskDescription — required — (String)

          A description of the task for your human workers.

        • NumberOfHumanWorkersPerDataObject — required — (Integer)

          The number of human workers that will label an object.

        • TaskTimeLimitInSeconds — required — (Integer)

          The amount of time that a worker has to complete a task.

        • TaskAvailabilityLifetimeInSeconds — (Integer)

          The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

        • MaxConcurrentTaskCount — (Integer)

          Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

        • AnnotationConsolidationConfig — required — (map)

          Configures how labels are consolidated across human workers.

          • AnnotationConsolidationLambdaArn — required — (String)

            The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.

            For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

            • Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

              arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

              arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

              arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

              arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

              arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

              arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

              arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

              arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

              arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

              arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

              arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

              arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

            • Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

              arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

              arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

              arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

              arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

              arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

              arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

              arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

              arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

              arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

              arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

              arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

              arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

            • Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

              arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

              arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

              arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

              arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

              arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

              arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

              arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

              arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

              arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

              arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

              arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

              arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

            • Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

              arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

              arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

              arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

              arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

              arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

              arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

              arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

              arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

              arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

              arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

              arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

              arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

            • Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

              arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

              arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

              arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

              arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

              arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

              arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

              arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

            For more information, see Annotation Consolidation.

        • PublicWorkforceTaskPrice — (map)

          The price that you pay for each task performed by an Amazon Mechanical Turk worker.

          • AmountInUsd — (map)

            Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

            • Dollars — (Integer)

              The whole number of dollars in the amount.

            • Cents — (Integer)

              The fractional portion, in cents, of the amount.

            • TenthFractionsOfACent — (Integer)

              Fractions of a cent, in tenths.

      • Tags — (Array<map>)

        An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

      • LabelingJobOutput — (map)

        The location of the output produced by the labeling job.

        • OutputDatasetS3Uri — required — (String)

          The Amazon S3 bucket location of the manifest file for labeled data.

        • FinalActiveLearningModelArn — (String)

          The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.

Returns:

  • (AWS.Request) —

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

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

Describes a model that you created using the CreateModel API.

Service Reference:

Examples:

Calling the describeModel operation

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
sagemaker.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 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)

        Name of the Amazon SageMaker model.

      • PrimaryContainer — (map)

        The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

        • ContainerHostname — (String)

          This parameter is ignored for models that contain only a PrimaryContainer.

          When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

        • Image — (String)

          The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

        • ModelDataUrl — (String)

          The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

          If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

          If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

        • Environment — (map<String>)

          The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

        • ModelPackageName — (String)

          The name or Amazon Resource Name (ARN) of the model package to use to create the model.

      • Containers — (Array<map>)

        The containers in the inference pipeline.

        • ContainerHostname — (String)

          This parameter is ignored for models that contain only a PrimaryContainer.

          When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

        • Image — (String)

          The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

        • ModelDataUrl — (String)

          The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

          If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

          If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

        • Environment — (map<String>)

          The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

        • ModelPackageName — (String)

          The name or Amazon Resource Name (ARN) of the model package to use to create the model.

      • ExecutionRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

      • VpcConfig — (map)

        A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

        • SecurityGroupIds — required — (Array<String>)

          The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

        • Subnets — required — (Array<String>)

          The ID of the subnets in the VPC to which you want to connect your training job or model.

          Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
      • CreationTime — (Date)

        A timestamp that shows when the model was created.

      • ModelArn — (String)

        The Amazon Resource Name (ARN) of the model.

      • EnableNetworkIsolation — (Boolean)

        If True, no inbound or outbound network calls can be made to or from the model container.

        Note: The Semantic Segmentation built-in algorithm does not support network isolation.

Returns:

  • (AWS.Request) —

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

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

Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.

Service Reference:

Examples:

Calling the describeModelPackage operation

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

      The name of the model package 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:

      • ModelPackageName — (String)

        The name of the model package being described.

      • ModelPackageArn — (String)

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

      • ModelPackageDescription — (String)

        A brief summary of the model package.

      • CreationTime — (Date)

        A timestamp specifying when the model package was created.

      • InferenceSpecification — (map)

        Details about inference jobs that can be run with models based on this model package.

        • Containers — required — (Array<map>)

          The Amazon ECR registry path of the Docker image that contains the inference code.

          • ContainerHostname — (String)

            The DNS host name for the Docker container.

          • Image — required — (String)

            The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

            If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

          • ImageDigest — (String)

            An MD5 hash of the training algorithm that identifies the Docker image used for training.

          • ModelDataUrl — (String)

            The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

          • ProductId — (String)

            The AWS Marketplace product ID of the model package.

        • SupportedTransformInstanceTypes — required — (Array<String>)

          A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

        • SupportedRealtimeInferenceInstanceTypes — required — (Array<String>)

          A list of the instance types that are used to generate inferences in real-time.

        • SupportedContentTypes — required — (Array<String>)

          The supported MIME types for the input data.

        • SupportedResponseMIMETypes — required — (Array<String>)

          The supported MIME types for the output data.

      • SourceAlgorithmSpecification — (map)

        Details about the algorithm that was used to create the model package.

        • SourceAlgorithms — required — (Array<map>)

          A list of the algorithms that were used to create a model package.

          • ModelDataUrl — (String)

            The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

          • AlgorithmName — required — (String)

            The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

      • ValidationSpecification — (map)

        Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

        • ValidationRole — required — (String)

          The IAM roles to be used for the validation of the model package.

        • ValidationProfiles — required — (Array<map>)

          An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.

          • ProfileName — required — (String)

            The name of the profile for the model package.

          • TransformJobDefinition — required — (map)

            The TransformJobDefinition object that describes the transform job used for the validation of the model package.

            • MaxConcurrentTransforms — (Integer)

              The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

            • MaxPayloadInMB — (Integer)

              The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

            • BatchStrategy — (String)

              A string that determines the number of records included in a single mini-batch.

              SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

              Possible values include:
              • "MultiRecord"
              • "SingleRecord"
            • Environment — (map<String>)

              The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

            • TransformInput — required — (map)

              A description of the input source and the way the transform job consumes it.

              • DataSource — required — (map)

                Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

                • S3DataSource — required — (map)

                  The S3 location of the data source that is associated with a channel.

                  • S3DataType — required — (String)

                    If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

                    If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

                    The following values are compatible: ManifestFile, S3Prefix

                    The following value is not compatible: AugmentedManifestFile

                    Possible values include:
                    • "ManifestFile"
                    • "S3Prefix"
                    • "AugmentedManifestFile"
                  • S3Uri — required — (String)

                    Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                    • A key name prefix might look like this: s3://bucketname/exampleprefix.

                    • A manifest might look like this: s3://bucketname/example.manifest

                      The manifest is an S3 object which is a JSON file with the following format:

                      [

                      {"prefix": "s3://customer_bucket/some/prefix/"},

                      "relative/path/to/custdata-1",

                      "relative/path/custdata-2",

                      ...

                      ]

                      The preceding JSON matches the following S3Uris:

                      s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                      s3://customer_bucket/some/prefix/relative/path/custdata-1

                      ...

                      The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

              • ContentType — (String)

                The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

              • CompressionType — (String)

                If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

                Possible values include:
                • "None"
                • "Gzip"
              • SplitType — (String)

                The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

                When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

                Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
                Possible values include:
                • "None"
                • "Line"
                • "RecordIO"
                • "TFRecord"
            • TransformOutput — required — (map)

              Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

              • S3OutputPath — required — (String)

                The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

                For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

              • Accept — (String)

                The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

              • AssembleWith — (String)

                Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

                Possible values include:
                • "None"
                • "Line"
              • KmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

                • // KMS Key Alias

                  "alias/ExampleAlias"

                • // Amazon Resource Name (ARN) of a KMS Key Alias

                  "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

                If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

                The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

            • TransformResources — required — (map)

              Identifies the ML compute instances for the transform job.

              • InstanceType — required — (String)

                The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

                Possible values include:
                • "ml.m4.xlarge"
                • "ml.m4.2xlarge"
                • "ml.m4.4xlarge"
                • "ml.m4.10xlarge"
                • "ml.m4.16xlarge"
                • "ml.c4.xlarge"
                • "ml.c4.2xlarge"
                • "ml.c4.4xlarge"
                • "ml.c4.8xlarge"
                • "ml.p2.xlarge"
                • "ml.p2.8xlarge"
                • "ml.p2.16xlarge"
                • "ml.p3.2xlarge"
                • "ml.p3.8xlarge"
                • "ml.p3.16xlarge"
                • "ml.c5.xlarge"
                • "ml.c5.2xlarge"
                • "ml.c5.4xlarge"
                • "ml.c5.9xlarge"
                • "ml.c5.18xlarge"
                • "ml.m5.large"
                • "ml.m5.xlarge"
                • "ml.m5.2xlarge"
                • "ml.m5.4xlarge"
                • "ml.m5.12xlarge"
                • "ml.m5.24xlarge"
              • InstanceCount — required — (Integer)

                The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

              • VolumeKmsKeyId — (String)

                The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

                • // KMS Key ID

                  "1234abcd-12ab-34cd-56ef-1234567890ab"

                • // Amazon Resource Name (ARN) of a KMS Key

                  "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • ModelPackageStatus — (String)

        The current status of the model package.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • ModelPackageStatusDetails — (map)

        Details about the current status of the model package.

        • ValidationStatuses — required — (Array<map>)

          The validation status of the model package.

          • Name — required — (String)

            The name of the model package for which the overall status is being reported.

          • Status — required — (String)

            The current status.

            Possible values include:
            • "NotStarted"
            • "InProgress"
            • "Completed"
            • "Failed"
          • FailureReason — (String)

            if the overall status is Failed, the reason for the failure.

        • ImageScanStatuses — (Array<map>)

          The status of the scan of the Docker image container for the model package.

          • Name — required — (String)

            The name of the model package for which the overall status is being reported.

          • Status — required — (String)

            The current status.

            Possible values include:
            • "NotStarted"
            • "InProgress"
            • "Completed"
            • "Failed"
          • FailureReason — (String)

            if the overall status is Failed, the reason for the failure.

      • CertifyForMarketplace — (Boolean)

        Whether the model package is certified for listing on AWS Marketplace.

Returns:

  • (AWS.Request) —

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

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

Returns information about a notebook instance.

Service Reference:

Examples:

Calling the describeNotebookInstance operation

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

      The name of the notebook instance that you want information about.

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:

      • NotebookInstanceArn — (String)

        The Amazon Resource Name (ARN) of the notebook instance.

      • NotebookInstanceName — (String)

        The name of the Amazon SageMaker notebook instance.

      • NotebookInstanceStatus — (String)

        The status of the notebook instance.

        Possible values include:
        • "Pending"
        • "InService"
        • "Stopping"
        • "Stopped"
        • "Failed"
        • "Deleting"
        • "Updating"
      • FailureReason — (String)

        If status is Failed, the reason it failed.

      • Url — (String)

        The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      • InstanceType — (String)

        The type of ML compute instance running on the notebook instance.

        Possible values include:
        • "ml.t2.medium"
        • "ml.t2.large"
        • "ml.t2.xlarge"
        • "ml.t2.2xlarge"
        • "ml.t3.medium"
        • "ml.t3.large"
        • "ml.t3.xlarge"
        • "ml.t3.2xlarge"
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5d.xlarge"
        • "ml.c5d.2xlarge"
        • "ml.c5d.4xlarge"
        • "ml.c5d.9xlarge"
        • "ml.c5d.18xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
      • SubnetId — (String)

        The ID of the VPC subnet.

      • SecurityGroups — (Array<String>)

        The IDs of the VPC security groups.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the instance.

      • KmsKeyId — (String)

        The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      • NetworkInterfaceId — (String)

        The network interface IDs that Amazon SageMaker created at the time of creating the instance.

      • LastModifiedTime — (Date)

        A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

      • CreationTime — (Date)

        A timestamp. Use this parameter to return the time when the notebook instance was created

      • NotebookInstanceLifecycleConfigName — (String)

        Returns the name of a notebook instance lifecycle configuration.

        For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

      • DirectInternetAccess — (String)

        Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

        For more information, see Notebook Instances Are Internet-Enabled by Default.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • VolumeSizeInGB — (Integer)

        The size, in GB, of the ML storage volume attached to the notebook instance.

      • AcceleratorTypes — (Array<String>)

        A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      • DefaultCodeRepository — (String)

        The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • AdditionalCodeRepositories — (Array<String>)

        An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • RootAccess — (String)

        Whether root access is enabled or disabled for users of the notebook instance.

        Note: Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Service Reference:

Examples:

Calling the describeNotebookInstanceLifecycleConfig operation

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

      The name of the lifecycle configuration 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:

      • NotebookInstanceLifecycleConfigArn — (String)

        The Amazon Resource Name (ARN) of the lifecycle configuration.

      • NotebookInstanceLifecycleConfigName — (String)

        The name of the lifecycle configuration.

      • OnCreate — (Array<map>)

        The shell script that runs only once, when you create a notebook instance.

        • Content — (String)

          A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

      • OnStart — (Array<map>)

        The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

        • Content — (String)

          A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

      • LastModifiedTime — (Date)

        A timestamp that tells when the lifecycle configuration was last modified.

      • CreationTime — (Date)

        A timestamp that tells when the lifecycle configuration was created.

Returns:

  • (AWS.Request) —

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

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

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.

Service Reference:

Examples:

Calling the describeSubscribedWorkteam operation

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

      The Amazon Resource Name (ARN) of the subscribed work team 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:

      • SubscribedWorkteam — (map)

        A Workteam instance that contains information about the work team.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) of the vendor that you have subscribed.

        • MarketplaceTitle — (String)

          The title of the service provided by the vendor in the Amazon Marketplace.

        • SellerName — (String)

          The name of the vendor in the Amazon Marketplace.

        • MarketplaceDescription — (String)

          The description of the vendor from the Amazon Marketplace.

        • ListingId — (String)

Returns:

  • (AWS.Request) —

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

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

Returns information about a training job.

Service Reference:

Examples:

Calling the describeTrainingJob operation

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

      The name of the training 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:

      • TrainingJobName — (String)

        Name of the model training job.

      • TrainingJobArn — (String)

        The Amazon Resource Name (ARN) of the training job.

      • TuningJobArn — (String)

        The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

      • LabelingJobArn — (String)

        The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

      • ModelArtifacts — (map)

        Information about the Amazon S3 location that is configured for storing model artifacts.

        • S3ModelArtifacts — required — (String)

          The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

      • TrainingJobStatus — (String)

        The status of the training job.

        Amazon SageMaker provides the following training job statuses:

        • InProgress - The training is in progress.

        • Completed - The training job has completed.

        • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

        • Stopping - The training job is stopping.

        • Stopped - The training job has stopped.

        For more detailed information, see SecondaryStatus.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Stopping"
        • "Stopped"
      • SecondaryStatus — (String)

        Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

        Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

        InProgress

        • Starting - Starting the training job.

        • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

        • Training - Training is in progress.

        • Interrupted - The job stopped because the managed spot training instances were interrupted.

        • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

        Completed

        • Completed - The training job has completed.

        Failed

        • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

        Stopped

        • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

        • MaxWaitTmeExceeded - The job stopped because it exceeded the maximum allowed wait time.

        • Stopped - The training job has stopped.

        Stopping

        • Stopping - Stopping the training job.

        Valid values for SecondaryStatus are subject to change.

        We no longer support the following secondary statuses:

        • LaunchingMLInstances

        • PreparingTrainingStack

        • DownloadingTrainingImage

        Possible values include:
        • "Starting"
        • "LaunchingMLInstances"
        • "PreparingTrainingStack"
        • "Downloading"
        • "DownloadingTrainingImage"
        • "Training"
        • "Uploading"
        • "Stopping"
        • "Stopped"
        • "MaxRuntimeExceeded"
        • "Completed"
        • "Failed"
        • "Interrupted"
        • "MaxWaitTimeExceeded"
      • FailureReason — (String)

        If the training job failed, the reason it failed.

      • HyperParameters — (map<String>)

        Algorithm-specific parameters.

      • AlgorithmSpecification — (map)

        Information about the algorithm used for training, and algorithm metadata.

        • TrainingImage — (String)

          The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

        • AlgorithmName — (String)

          The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

        • TrainingInputMode — required — (String)

          The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

          In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

          For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.

          Possible values include:
          • "Pipe"
          • "File"
        • MetricDefinitions — (Array<map>)

          A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

          • Name — required — (String)

            The name of the metric.

          • Regex — required — (String)

            A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

      • RoleArn — (String)

        The AWS Identity and Access Management (IAM) role configured for the training job.

      • InputDataConfig — (Array<map>)

        An array of Channel objects that describes each data input channel.

        • ChannelName — required — (String)

          The name of the channel.

        • DataSource — required — (map)

          The location of the channel data.

          • S3DataSource — (map)

            The S3 location of the data source that is associated with a channel.

            • S3DataType — required — (String)

              If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

              If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

              If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

              Possible values include:
              • "ManifestFile"
              • "S3Prefix"
              • "AugmentedManifestFile"
            • S3Uri — required — (String)

              Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

              • A key name prefix might look like this: s3://bucketname/exampleprefix.

              • A manifest might look like this: s3://bucketname/example.manifest

                The manifest is an S3 object which is a JSON file with the following format:

                [

                {"prefix": "s3://customer_bucket/some/prefix/"},

                "relative/path/to/custdata-1",

                "relative/path/custdata-2",

                ...

                ]

                The preceding JSON matches the following s3Uris:

                s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                s3://customer_bucket/some/prefix/relative/path/custdata-2

                ...

                The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

            • S3DataDistributionType — (String)

              If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

              If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

              Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

              In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

              Possible values include:
              • "FullyReplicated"
              • "ShardedByS3Key"
            • AttributeNames — (Array<String>)

              A list of one or more attribute names to use that are found in a specified augmented manifest file.

          • FileSystemDataSource — (map)

            The file system that is associated with a channel.

            • FileSystemId — required — (String)

              The file system id.

            • FileSystemAccessMode — required — (String)

              The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

              Possible values include:
              • "rw"
              • "ro"
            • FileSystemType — required — (String)

              The file system type.

              Possible values include:
              • "EFS"
              • "FSxLustre"
            • DirectoryPath — required — (String)

              The full path to the directory to associate with the channel.

        • ContentType — (String)

          The MIME type of the data.

        • CompressionType — (String)

          If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

          Possible values include:
          • "None"
          • "Gzip"
        • RecordWrapperType — (String)

          Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

          In File mode, leave this field unset or set it to None.

          Possible values include:
          • "None"
          • "RecordIO"
        • InputMode — (String)

          (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

          To use a model for incremental training, choose File input model.

          Possible values include:
          • "Pipe"
          • "File"
        • ShuffleConfig — (map)

          A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

          For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

          • Seed — required — (Integer)

            Determines the shuffling order in ShuffleConfig value.

      • OutputDataConfig — (map)

        The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

        • KmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

          • // KMS Key Alias

            "alias/ExampleAlias"

          • // Amazon Resource Name (ARN) of a KMS Key Alias

            "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

          If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

          The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

        • S3OutputPath — required — (String)

          Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

      • ResourceConfig — (map)

        Resources, including ML compute instances and ML storage volumes, that are configured for model training.

        • InstanceType — required — (String)

          The ML compute instance type.

          Possible values include:
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.p3dn.24xlarge"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
        • InstanceCount — required — (Integer)

          The number of ML compute instances to use. For distributed training, provide a value greater than 1.

        • VolumeSizeInGB — required — (Integer)

          The size of the ML storage volume that you want to provision.

          ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

          You must specify sufficient ML storage for your scenario.

          Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
        • VolumeKmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • VpcConfig — (map)

        A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

        • SecurityGroupIds — required — (Array<String>)

          The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

        • Subnets — required — (Array<String>)

          The ID of the subnets in the VPC to which you want to connect your training job or model.

          Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
      • StoppingCondition — (map)

        Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

        To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

        • MaxRuntimeInSeconds — (Integer)

          The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

        • MaxWaitTimeInSeconds — (Integer)

          The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

      • CreationTime — (Date)

        A timestamp that indicates when the training job was created.

      • TrainingStartTime — (Date)

        Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

      • TrainingEndTime — (Date)

        Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

      • LastModifiedTime — (Date)

        A timestamp that indicates when the status of the training job was last modified.

      • SecondaryStatusTransitions — (Array<map>)

        A history of all of the secondary statuses that the training job has transitioned through.

        • Status — required — (String)

          Contains a secondary status information from a training job.

          Status might be one of the following secondary statuses:

          InProgress

          • Starting - Starting the training job.

          • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

          • Training - Training is in progress.

          • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

          Completed

          • Completed - The training job has completed.

          Failed

          • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

          Stopped

          • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

          • Stopped - The training job has stopped.

          Stopping

          • Stopping - Stopping the training job.

          We no longer support the following secondary statuses:

          • LaunchingMLInstances

          • PreparingTrainingStack

          • DownloadingTrainingImage

          Possible values include:
          • "Starting"
          • "LaunchingMLInstances"
          • "PreparingTrainingStack"
          • "Downloading"
          • "DownloadingTrainingImage"
          • "Training"
          • "Uploading"
          • "Stopping"
          • "Stopped"
          • "MaxRuntimeExceeded"
          • "Completed"
          • "Failed"
          • "Interrupted"
          • "MaxWaitTimeExceeded"
        • StartTime — required — (Date)

          A timestamp that shows when the training job transitioned to the current secondary status state.

        • EndTime — (Date)

          A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

        • StatusMessage — (String)

          A detailed description of the progress within a secondary status.

          Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

          Starting

          • Starting the training job.

          • Launching requested ML instances.

          • Insufficient capacity error from EC2 while launching instances, retrying!

          • Launched instance was unhealthy, replacing it!

          • Preparing the instances for training.

          Training

          • Downloading the training image.

          • Training image download completed. Training in progress.

          Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

          To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

          • TrainingJobStatus - InProgress

          • SecondaryStatus - Training

          • StatusMessage - Downloading the training image

      • FinalMetricDataList — (Array<map>)

        A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

        • MetricName — (String)

          The name of the metric.

        • Value — (Float)

          The value of the metric.

        • Timestamp — (Date)

          The date and time that the algorithm emitted the metric.

      • EnableNetworkIsolation — (Boolean)

        If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

        Note: The Semantic Segmentation built-in algorithm does not support network isolation.
      • EnableInterContainerTrafficEncryption — (Boolean)

        To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

      • EnableManagedSpotTraining — (Boolean)

        A Boolean indicating whether managed spot training is enabled (True) or not (False).

      • CheckpointConfig — (map)

        Contains information about the output location for managed spot training checkpoint data.

        • S3Uri — required — (String)

          Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

        • LocalPath — (String)

          (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

      • TrainingTimeInSeconds — (Integer)

        The training time in seconds.

      • BillableTimeInSeconds — (Integer)

        The billable time in seconds.

        You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns information about a transform job.

Service Reference:

Examples:

Calling the describeTransformJob operation

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

      The name of the transform job that you want to view details of.

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:

      • TransformJobName — (String)

        The name of the transform job.

      • TransformJobArn — (String)

        The Amazon Resource Name (ARN) of the transform job.

      • TransformJobStatus — (String)

        The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Stopping"
        • "Stopped"
      • FailureReason — (String)

        If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

      • ModelName — (String)

        The name of the model used in the transform job.

      • MaxConcurrentTransforms — (Integer)

        The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

      • MaxPayloadInMB — (Integer)

        The maximum payload size, in MB, used in the transform job.

      • BatchStrategy — (String)

        Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

        To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

        Possible values include:
        • "MultiRecord"
        • "SingleRecord"
      • Environment — (map<String>)

        The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

      • TransformInput — (map)

        Describes the dataset to be transformed and the Amazon S3 location where it is stored.

        • DataSource — required — (map)

          Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

          • S3DataSource — required — (map)

            The S3 location of the data source that is associated with a channel.

            • S3DataType — required — (String)

              If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

              If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

              The following values are compatible: ManifestFile, S3Prefix

              The following value is not compatible: AugmentedManifestFile

              Possible values include:
              • "ManifestFile"
              • "S3Prefix"
              • "AugmentedManifestFile"
            • S3Uri — required — (String)

              Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

              • A key name prefix might look like this: s3://bucketname/exampleprefix.

              • A manifest might look like this: s3://bucketname/example.manifest

                The manifest is an S3 object which is a JSON file with the following format:

                [

                {"prefix": "s3://customer_bucket/some/prefix/"},

                "relative/path/to/custdata-1",

                "relative/path/custdata-2",

                ...

                ]

                The preceding JSON matches the following S3Uris:

                s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                s3://customer_bucket/some/prefix/relative/path/custdata-1

                ...

                The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

        • ContentType — (String)

          The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

        • CompressionType — (String)

          If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

          Possible values include:
          • "None"
          • "Gzip"
        • SplitType — (String)

          The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

          When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

          Note: Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
          Possible values include:
          • "None"
          • "Line"
          • "RecordIO"
          • "TFRecord"
      • TransformOutput — (map)

        Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

        • S3OutputPath — required — (String)

          The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

          For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

        • Accept — (String)

          The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

        • AssembleWith — (String)

          Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

          Possible values include:
          • "None"
          • "Line"
        • KmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

          • // KMS Key Alias

            "alias/ExampleAlias"

          • // Amazon Resource Name (ARN) of a KMS Key Alias

            "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

          If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

          The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

      • TransformResources — (map)

        Describes the resources, including ML instance types and ML instance count, to use for the transform job.

        • InstanceType — required — (String)

          The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

          Possible values include:
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
        • InstanceCount — required — (Integer)

          The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

        • VolumeKmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • CreationTime — (Date)

        A timestamp that shows when the transform Job was created.

      • TransformStartTime — (Date)

        Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

      • TransformEndTime — (Date)

        Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

      • LabelingJobArn — (String)

        The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

      • DataProcessing — (map)

        The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

        • InputFilter — (String)

          A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

          Examples: "$", "$[1:]", "$.features"

        • OutputFilter — (String)

          A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

          Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"

        • JoinSource — (String)

          Specifies the source of the data to join with the transformed data. The valid values are None and Input The default value is None which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input.

          For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

          For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.

          Possible values include:
          • "Input"
          • "None"

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the describeWorkteam operation

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

      The name of the work team to return a description of.

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:

      • Workteam — (map)

        A Workteam instance that contains information about the work team.

        • WorkteamName — required — (String)

          The name of the work team.

        • MemberDefinitions — required — (Array<map>)

          The Amazon Cognito user groups that make up the work team.

          • CognitoMemberDefinition — (map)

            The Amazon Cognito user group that is part of the work team.

            • UserPool — required — (String)

              An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

            • UserGroup — required — (String)

              An identifier for a user group.

            • ClientId — required — (String)

              An identifier for an application client. You must create the app client ID using Amazon Cognito.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) that identifies the work team.

        • ProductListingIds — (Array<String>)

          The Amazon Marketplace identifier for a vendor's work team.

        • Description — required — (String)

          A description of the work team.

        • SubDomain — (String)

          The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

        • CreateDate — (Date)

          The date and time that the work team was created (timestamp).

        • LastUpdatedDate — (Date)

          The date and time that the work team was last updated (timestamp).

        • NotificationConfiguration — (map)

          Configures SNS notifications of available or expiring work items for work teams.

          • NotificationTopicArn — (String)

            The ARN for the SNS topic to which notifications should be published.

Returns:

  • (AWS.Request) —

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

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

An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

Service Reference:

Examples:

Calling the getSearchSuggestions operation

var params = {
  Resource: TrainingJob, /* required */
  SuggestionQuery: {
    PropertyNameQuery: {
      PropertyNameHint: 'STRING_VALUE' /* required */
    }
  }
};
sagemaker.getSearchSuggestions(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: {}) —
    • Resource — (String)

      The name of the Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob.

      Possible values include:
      • "TrainingJob"
    • SuggestionQuery — (map)

      Limits the property names that are included in the response.

      • PropertyNameQuery — (map)

        A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response.

        • PropertyNameHint — required — (String)

          Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint.

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:

      • PropertyNameSuggestions — (Array<map>)

        A list of property names for a Resource that match a SuggestionQuery.

        • PropertyName — (String)

          A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.

Returns:

  • (AWS.Request) —

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

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

Lists the machine learning algorithms that have been created.

Service Reference:

Examples:

Calling the listAlgorithms operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime,
  SortOrder: Ascending | Descending
};
sagemaker.listAlgorithms(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: {}) —
    • CreationTimeAfter — (Date)

      A filter that returns only algorithms created after the specified time (timestamp).

    • CreationTimeBefore — (Date)

      A filter that returns only algorithms created before the specified time (timestamp).

    • MaxResults — (Integer)

      The maximum number of algorithms to return in the response.

    • NameContains — (String)

      A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

    • NextToken — (String)

      If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

    • SortBy — (String)

      The parameter by which to sort the results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
    • SortOrder — (String)

      The sort order for the results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • AlgorithmSummaryList — (Array<map>)

        >An array of AlgorithmSummary objects, each of which lists an algorithm.

        • AlgorithmName — required — (String)

          The name of the algorithm that is described by the summary.

        • AlgorithmArn — required — (String)

          The Amazon Resource Name (ARN) of the algorithm.

        • AlgorithmDescription — (String)

          A brief description of the algorithm.

        • CreationTime — required — (Date)

          A timestamp that shows when the algorithm was created.

        • AlgorithmStatus — required — (String)

          The overall status of the algorithm.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Deleting"
      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of the Git repositories in your account.

Service Reference:

Examples:

Calling the listCodeRepositories operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | LastModifiedTime,
  SortOrder: Ascending | Descending
};
sagemaker.listCodeRepositories(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: {}) —
    • CreationTimeAfter — (Date)

      A filter that returns only Git repositories that were created after the specified time.

    • CreationTimeBefore — (Date)

      A filter that returns only Git repositories that were created before the specified time.

    • LastModifiedTimeAfter — (Date)

      A filter that returns only Git repositories that were last modified after the specified time.

    • LastModifiedTimeBefore — (Date)

      A filter that returns only Git repositories that were last modified before the specified time.

    • MaxResults — (Integer)

      The maximum number of Git repositories to return in the response.

    • NameContains — (String)

      A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

    • NextToken — (String)

      If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

    • SortBy — (String)

      The field to sort results by. The default is Name.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "LastModifiedTime"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • CodeRepositorySummaryList — (Array<map>)

        Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

        • Name

        • Amazon Resource Name (ARN)

        • Creation time

        • Last modified time

        • Configuration information, including the URL location of the repository and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

        • CodeRepositoryName — required — (String)

          The name of the Git repository.

        • CodeRepositoryArn — required — (String)

          The Amazon Resource Name (ARN) of the Git repository.

        • CreationTime — required — (Date)

          The date and time that the Git repository was created.

        • LastModifiedTime — required — (Date)

          The date and time that the Git repository was last modified.

        • GitConfig — (map)

          Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

          • RepositoryUrl — required — (String)

            The URL where the Git repository is located.

          • Branch — (String)

            The default branch for the Git repository.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

            {"username": UserName, "password": Password}

      • NextToken — (String)

        If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

Returns:

  • (AWS.Request) —

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

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

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

Service Reference:

Examples:

Calling the listCompilationJobs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED
};
sagemaker.listCompilationJobs(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 result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of model compilation jobs to return in the response.

    • CreationTimeAfter — (Date)

      A filter that returns the model compilation jobs that were created after a specified time.

    • CreationTimeBefore — (Date)

      A filter that returns the model compilation jobs that were created before a specified time.

    • LastModifiedTimeAfter — (Date)

      A filter that returns the model compilation jobs that were modified after a specified time.

    • LastModifiedTimeBefore — (Date)

      A filter that returns the model compilation jobs that were modified before a specified time.

    • NameContains — (String)

      A filter that returns the model compilation jobs whose name contains a specified string.

    • StatusEquals — (String)

      A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

      Possible values include:
      • "INPROGRESS"
      • "COMPLETED"
      • "FAILED"
      • "STARTING"
      • "STOPPING"
      • "STOPPED"
    • SortBy — (String)

      The field by which to sort results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • CompilationJobSummaries — (Array<map>)

        An array of CompilationJobSummary objects, each describing a model compilation job.

        • CompilationJobName — required — (String)

          The name of the model compilation job that you want a summary for.

        • CompilationJobArn — required — (String)

          The Amazon Resource Name (ARN) of the model compilation job.

        • CreationTime — required — (Date)

          The time when the model compilation job was created.

        • CompilationStartTime — (Date)

          The time when the model compilation job started.

        • CompilationEndTime — (Date)

          The time when the model compilation job completed.

        • CompilationTargetDevice — required — (String)

          The type of device that the model will run on after compilation has completed.

          Possible values include:
          • "lambda"
          • "ml_m4"
          • "ml_m5"
          • "ml_c4"
          • "ml_c5"
          • "ml_p2"
          • "ml_p3"
          • "jetson_tx1"
          • "jetson_tx2"
          • "jetson_nano"
          • "rasp3b"
          • "deeplens"
          • "rk3399"
          • "rk3288"
          • "aisage"
          • "sbe_c"
          • "qcs605"
          • "qcs603"
        • LastModifiedTime — (Date)

          The time when the model compilation job was last modified.

        • CompilationJobStatus — required — (String)

          The status of the model compilation job.

          Possible values include:
          • "INPROGRESS"
          • "COMPLETED"
          • "FAILED"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

Returns:

  • (AWS.Request) —

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

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

Lists endpoint configurations.

Service Reference:

Examples:

Calling the listEndpointConfigs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime,
  SortOrder: Ascending | Descending
};
sagemaker.listEndpointConfigs(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: {}) —
    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
    • SortOrder — (String)

      The sort order for results. The default is Descending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NextToken — (String)

      If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of training jobs to return in the response.

    • NameContains — (String)

      A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

    • CreationTimeBefore — (Date)

      A filter that returns only endpoint configurations created before the specified time (timestamp).

    • CreationTimeAfter — (Date)

      A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

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:

      • EndpointConfigs — (Array<map>)

        An array of endpoint configurations.

        • EndpointConfigName — required — (String)

          The name of the endpoint configuration.

        • EndpointConfigArn — required — (String)

          The Amazon Resource Name (ARN) of the endpoint configuration.

        • CreationTime — required — (Date)

          A timestamp that shows when the endpoint configuration was created.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

Returns:

  • (AWS.Request) —

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

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

Lists endpoints.

Service Reference:

Examples:

Calling the listEndpoints operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed
};
sagemaker.listEndpoints(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: {}) —
    • SortBy — (String)

      Sorts the list of results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results. The default is Descending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NextToken — (String)

      If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of endpoints to return in the response.

    • NameContains — (String)

      A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

    • CreationTimeBefore — (Date)

      A filter that returns only endpoints that were created before the specified time (timestamp).

    • CreationTimeAfter — (Date)

      A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

    • LastModifiedTimeBefore — (Date)

      A filter that returns only endpoints that were modified before the specified timestamp.

    • LastModifiedTimeAfter — (Date)

      A filter that returns only endpoints that were modified after the specified timestamp.

    • StatusEquals — (String)

      A filter that returns only endpoints with the specified status.

      Possible values include:
      • "OutOfService"
      • "Creating"
      • "Updating"
      • "SystemUpdating"
      • "RollingBack"
      • "InService"
      • "Deleting"
      • "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:

      • Endpoints — (Array<map>)

        An array or endpoint objects.

        • EndpointName — required — (String)

          The name of the endpoint.

        • EndpointArn — required — (String)

          The Amazon Resource Name (ARN) of the endpoint.

        • CreationTime — required — (Date)

          A timestamp that shows when the endpoint was created.

        • LastModifiedTime — required — (Date)

          A timestamp that shows when the endpoint was last modified.

        • EndpointStatus — required — (String)

          The status of the endpoint.

          • OutOfService: Endpoint is not available to take incoming requests.

          • Creating: CreateEndpoint is executing.

          • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

          • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

          • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

          • InService: Endpoint is available to process incoming requests.

          • Deleting: DeleteEndpoint is executing.

          • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

          To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

          Possible values include:
          • "OutOfService"
          • "Creating"
          • "Updating"
          • "SystemUpdating"
          • "RollingBack"
          • "InService"
          • "Deleting"
          • "Failed"
      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

Service Reference:

Examples:

Calling the listHyperParameterTuningJobs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | Status | CreationTime,
  SortOrder: Ascending | Descending,
  StatusEquals: Completed | InProgress | Failed | Stopped | Stopping
};
sagemaker.listHyperParameterTuningJobs(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 result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of tuning jobs to return. The default value is 10.

    • SortBy — (String)

      The field to sort results by. The default is Name.

      Possible values include:
      • "Name"
      • "Status"
      • "CreationTime"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NameContains — (String)

      A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

    • CreationTimeAfter — (Date)

      A filter that returns only tuning jobs that were created after the specified time.

    • CreationTimeBefore — (Date)

      A filter that returns only tuning jobs that were created before the specified time.

    • LastModifiedTimeAfter — (Date)

      A filter that returns only tuning jobs that were modified after the specified time.

    • LastModifiedTimeBefore — (Date)

      A filter that returns only tuning jobs that were modified before the specified time.

    • StatusEquals — (String)

      A filter that returns only tuning jobs with the specified status.

      Possible values include:
      • "Completed"
      • "InProgress"
      • "Failed"
      • "Stopped"
      • "Stopping"

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:

      • HyperParameterTuningJobSummaries — (Array<map>)

        A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

        • HyperParameterTuningJobName — required — (String)

          The name of the tuning job.

        • HyperParameterTuningJobArn — required — (String)

          The Amazon Resource Name (ARN) of the tuning job.

        • HyperParameterTuningJobStatus — required — (String)

          The status of the tuning job.

          Possible values include:
          • "Completed"
          • "InProgress"
          • "Failed"
          • "Stopped"
          • "Stopping"
        • Strategy — required — (String)

          Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.

          Possible values include:
          • "Bayesian"
          • "Random"
        • CreationTime — required — (Date)

          The date and time that the tuning job was created.

        • HyperParameterTuningEndTime — (Date)

          The date and time that the tuning job ended.

        • LastModifiedTime — (Date)

          The date and time that the tuning job was modified.

        • TrainingJobStatusCounters — required — (map)

          The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

          • Completed — (Integer)

            The number of completed training jobs launched by the hyperparameter tuning job.

          • InProgress — (Integer)

            The number of in-progress training jobs launched by a hyperparameter tuning job.

          • RetryableError — (Integer)

            The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

          • NonRetryableError — (Integer)

            The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

          • Stopped — (Integer)

            The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

        • ObjectiveStatusCounters — required — (map)

          The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

          • Succeeded — (Integer)

            The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

          • Pending — (Integer)

            The number of training jobs that are in progress and pending evaluation of their final objective metric.

          • Failed — (Integer)

            The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

        • ResourceLimits — (map)

          The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

          • MaxNumberOfTrainingJobs — required — (Integer)

            The maximum number of training jobs that a hyperparameter tuning job can launch.

          • MaxParallelTrainingJobs — required — (Integer)

            The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

      • NextToken — (String)

        If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of labeling jobs.

Service Reference:

Examples:

Calling the listLabelingJobs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: InProgress | Completed | Failed | Stopping | Stopped
};
sagemaker.listLabelingJobs(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: {}) —
    • CreationTimeAfter — (Date)

      A filter that returns only labeling jobs created after the specified time (timestamp).

    • CreationTimeBefore — (Date)

      A filter that returns only labeling jobs created before the specified time (timestamp).

    • LastModifiedTimeAfter — (Date)

      A filter that returns only labeling jobs modified after the specified time (timestamp).

    • LastModifiedTimeBefore — (Date)

      A filter that returns only labeling jobs modified before the specified time (timestamp).

    • MaxResults — (Integer)

      The maximum number of labeling jobs to return in each page of the response.

    • NextToken — (String)

      If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    • NameContains — (String)

      A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • StatusEquals — (String)

      A filter that retrieves only labeling jobs with a specific status.

      Possible values include:
      • "InProgress"
      • "Completed"
      • "Failed"
      • "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:

      • LabelingJobSummaryList — (Array<map>)

        An array of LabelingJobSummary objects, each describing a labeling job.

        • LabelingJobName — required — (String)

          The name of the labeling job.

        • LabelingJobArn — required — (String)

          The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

        • CreationTime — required — (Date)

          The date and time that the job was created (timestamp).

        • LastModifiedTime — required — (Date)

          The date and time that the job was last modified (timestamp).

        • LabelingJobStatus — required — (String)

          The current status of the labeling job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • LabelCounters — required — (map)

          Counts showing the progress of the labeling job.

          • TotalLabeled — (Integer)

            The total number of objects labeled.

          • HumanLabeled — (Integer)

            The total number of objects labeled by a human worker.

          • MachineLabeled — (Integer)

            The total number of objects labeled by automated data labeling.

          • FailedNonRetryableError — (Integer)

            The total number of objects that could not be labeled due to an error.

          • Unlabeled — (Integer)

            The total number of objects not yet labeled.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) of the work team assigned to the job.

        • PreHumanTaskLambdaArn — required — (String)

          The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

        • AnnotationConsolidationLambdaArn — (String)

          The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

        • FailureReason — (String)

          If the LabelingJobStatus field is Failed, this field contains a description of the error.

        • LabelingJobOutput — (map)

          The location of the output produced by the labeling job.

          • OutputDatasetS3Uri — required — (String)

            The Amazon S3 bucket location of the manifest file for labeled data.

          • FinalActiveLearningModelArn — (String)

            The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.

        • InputConfig — (map)

          Input configuration for the labeling job.

          • DataSource — required — (map)

            The location of the input data.

            • S3DataSource — required — (map)

              The Amazon S3 location of the input data objects.

              • ManifestS3Uri — required — (String)

                The Amazon S3 location of the manifest file that describes the input data objects.

          • DataAttributes — (map)

            Attributes of the data specified by the customer.

            • ContentClassifiers — (Array<String>)

              Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of labeling jobs assigned to a specified work team.

Service Reference:

Examples:

Calling the listLabelingJobsForWorkteam operation

var params = {
  WorkteamArn: 'STRING_VALUE', /* required */
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  JobReferenceCodeContains: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: CreationTime,
  SortOrder: Ascending | Descending
};
sagemaker.listLabelingJobsForWorkteam(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: {}) —
    • WorkteamArn — (String)

      The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

    • MaxResults — (Integer)

      The maximum number of labeling jobs to return in each page of the response.

    • NextToken — (String)

      If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    • CreationTimeAfter — (Date)

      A filter that returns only labeling jobs created after the specified time (timestamp).

    • CreationTimeBefore — (Date)

      A filter that returns only labeling jobs created before the specified time (timestamp).

    • JobReferenceCodeContains — (String)

      A filter the limits jobs to only the ones whose job reference code contains the specified string.

    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "CreationTime"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • LabelingJobSummaryList — (Array<map>)

        An array of LabelingJobSummary objects, each describing a labeling job.

        • LabelingJobName — (String)

          The name of the labeling job that the work team is assigned to.

        • JobReferenceCode — required — (String)

          A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

        • WorkRequesterAccountId — required — (String)

        • CreationTime — required — (Date)

          The date and time that the labeling job was created.

        • LabelCounters — (map)

          Provides information about the progress of a labeling job.

          • HumanLabeled — (Integer)

            The total number of data objects labeled by a human worker.

          • PendingHuman — (Integer)

            The total number of data objects that need to be labeled by a human worker.

          • Total — (Integer)

            The total number of tasks in the labeling job.

        • NumberOfHumanWorkersPerDataObject — (Integer)

          The configured number of workers per data object.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Lists the model packages that have been created.

Service Reference:

Examples:

Calling the listModelPackages operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime,
  SortOrder: Ascending | Descending
};
sagemaker.listModelPackages(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: {}) —
    • CreationTimeAfter — (Date)

      A filter that returns only model packages created after the specified time (timestamp).

    • CreationTimeBefore — (Date)

      A filter that returns only model packages created before the specified time (timestamp).

    • MaxResults — (Integer)

      The maximum number of model packages to return in the response.

    • NameContains — (String)

      A string in the model package name. This filter returns only model packages whose name contains the specified string.

    • NextToken — (String)

      If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

    • SortBy — (String)

      The parameter by which to sort the results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
    • SortOrder — (String)

      The sort order for the results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • ModelPackageSummaryList — (Array<map>)

        An array of ModelPackageSummary objects, each of which lists a model package.

        • ModelPackageName — required — (String)

          The name of the model package.

        • ModelPackageArn — required — (String)

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

        • ModelPackageDescription — (String)

          A brief description of the model package.

        • CreationTime — required — (Date)

          A timestamp that shows when the model package was created.

        • ModelPackageStatus — required — (String)

          The overall status of the model package.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Deleting"
      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Lists models created with the CreateModel API.

Service Reference:

Examples:

Calling the listModels operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime,
  SortOrder: Ascending | Descending
};
sagemaker.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: {}) —
    • SortBy — (String)

      Sorts the list of results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
    • SortOrder — (String)

      The sort order for results. The default is Descending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NextToken — (String)

      If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of models to return in the response.

    • NameContains — (String)

      A string in the training job name. This filter returns only models in the training job whose name contains the specified string.

    • CreationTimeBefore — (Date)

      A filter that returns only models created before the specified time (timestamp).

    • CreationTimeAfter — (Date)

      A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

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>)

        An array of ModelSummary objects, each of which lists a model.

        • ModelName — required — (String)

          The name of the model that you want a summary for.

        • ModelArn — required — (String)

          The Amazon Resource Name (ARN) of the model.

        • CreationTime — required — (Date)

          A timestamp that indicates when the model was created.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

Service Reference:

Examples:

Calling the listNotebookInstanceLifecycleConfigs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | LastModifiedTime,
  SortOrder: Ascending | Descending
};
sagemaker.listNotebookInstanceLifecycleConfigs(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 result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of lifecycle configurations to return in the response.

    • SortBy — (String)

      Sorts the list of results. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "LastModifiedTime"
    • SortOrder — (String)

      The sort order for results.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NameContains — (String)

      A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

    • CreationTimeBefore — (Date)

      A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

    • CreationTimeAfter — (Date)

      A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

    • LastModifiedTimeBefore — (Date)

      A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

    • LastModifiedTimeAfter — (Date)

      A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

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 response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

      • NotebookInstanceLifecycleConfigs — (Array<map>)

        An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

        • NotebookInstanceLifecycleConfigName — required — (String)

          The name of the lifecycle configuration.

        • NotebookInstanceLifecycleConfigArn — required — (String)

          The Amazon Resource Name (ARN) of the lifecycle configuration.

        • CreationTime — (Date)

          A timestamp that tells when the lifecycle configuration was created.

        • LastModifiedTime — (Date)

          A timestamp that tells when the lifecycle configuration was last modified.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.

Service Reference:

Examples:

Calling the listNotebookInstances operation

var params = {
  AdditionalCodeRepositoryEquals: 'STRING_VALUE',
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  DefaultCodeRepositoryContains: 'STRING_VALUE',
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  NotebookInstanceLifecycleConfigNameContains: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: Pending | InService | Stopping | Stopped | Failed | Deleting | Updating
};
sagemaker.listNotebookInstances(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 call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

      Note: You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
    • MaxResults — (Integer)

      The maximum number of notebook instances to return.

    • SortBy — (String)

      The field to sort results by. The default is Name.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NameContains — (String)

      A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

    • CreationTimeBefore — (Date)

      A filter that returns only notebook instances that were created before the specified time (timestamp).

    • CreationTimeAfter — (Date)

      A filter that returns only notebook instances that were created after the specified time (timestamp).

    • LastModifiedTimeBefore — (Date)

      A filter that returns only notebook instances that were modified before the specified time (timestamp).

    • LastModifiedTimeAfter — (Date)

      A filter that returns only notebook instances that were modified after the specified time (timestamp).

    • StatusEquals — (String)

      A filter that returns only notebook instances with the specified status.

      Possible values include:
      • "Pending"
      • "InService"
      • "Stopping"
      • "Stopped"
      • "Failed"
      • "Deleting"
      • "Updating"
    • NotebookInstanceLifecycleConfigNameContains — (String)

      A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

    • DefaultCodeRepositoryContains — (String)

      A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

    • AdditionalCodeRepositoryEquals — (String)

      A filter that returns only notebook instances with associated with the specified git repository.

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 response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

      • NotebookInstances — (Array<map>)

        An array of NotebookInstanceSummary objects, one for each notebook instance.

        • NotebookInstanceName — required — (String)

          The name of the notebook instance that you want a summary for.

        • NotebookInstanceArn — required — (String)

          The Amazon Resource Name (ARN) of the notebook instance.

        • NotebookInstanceStatus — (String)

          The status of the notebook instance.

          Possible values include:
          • "Pending"
          • "InService"
          • "Stopping"
          • "Stopped"
          • "Failed"
          • "Deleting"
          • "Updating"
        • Url — (String)

          The URL that you use to connect to the Jupyter instance running in your notebook instance.

        • InstanceType — (String)

          The type of ML compute instance that the notebook instance is running on.

          Possible values include:
          • "ml.t2.medium"
          • "ml.t2.large"
          • "ml.t2.xlarge"
          • "ml.t2.2xlarge"
          • "ml.t3.medium"
          • "ml.t3.large"
          • "ml.t3.xlarge"
          • "ml.t3.2xlarge"
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
          • "ml.c5d.xlarge"
          • "ml.c5d.2xlarge"
          • "ml.c5d.4xlarge"
          • "ml.c5d.9xlarge"
          • "ml.c5d.18xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
        • CreationTime — (Date)

          A timestamp that shows when the notebook instance was created.

        • LastModifiedTime — (Date)

          A timestamp that shows when the notebook instance was last modified.

        • NotebookInstanceLifecycleConfigName — (String)

          The name of a notebook instance lifecycle configuration associated with this notebook instance.

          For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

        • DefaultCodeRepository — (String)

          The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

        • AdditionalCodeRepositories — (Array<String>)

          An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

Returns:

  • (AWS.Request) —

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

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

Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Service Reference:

Examples:

Calling the listSubscribedWorkteams operation

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

      A string in the work team name. This filter returns only work teams whose name contains the specified string.

    • NextToken — (String)

      If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of work teams to return in each page of the response.

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:

      • SubscribedWorkteams — (Array<map>)

        An array of Workteam objects, each describing a work team.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) of the vendor that you have subscribed.

        • MarketplaceTitle — (String)

          The title of the service provided by the vendor in the Amazon Marketplace.

        • SellerName — (String)

          The name of the vendor in the Amazon Marketplace.

        • MarketplaceDescription — (String)

          The description of the vendor from the Amazon Marketplace.

        • ListingId — (String)

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Returns the tags for the specified Amazon SageMaker resource.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
sagemaker.listTags(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 whose tags you want to retrieve.

    • NextToken — (String)

      If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

    • MaxResults — (Integer)

      Maximum number of tags to return.

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>)

        An array of Tag objects, each with a tag key and a value.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

      • NextToken — (String)

        If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

Returns:

  • (AWS.Request) —

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

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

Lists training jobs.

Service Reference:

Examples:

Calling the listTrainingJobs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: InProgress | Completed | Failed | Stopping | Stopped
};
sagemaker.listTrainingJobs(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 result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of training jobs to return in the response.

    • CreationTimeAfter — (Date)

      A filter that returns only training jobs created after the specified time (timestamp).

    • CreationTimeBefore — (Date)

      A filter that returns only training jobs created before the specified time (timestamp).

    • LastModifiedTimeAfter — (Date)

      A filter that returns only training jobs modified after the specified time (timestamp).

    • LastModifiedTimeBefore — (Date)

      A filter that returns only training jobs modified before the specified time (timestamp).

    • NameContains — (String)

      A string in the training job name. This filter returns only training jobs whose name contains the specified string.

    • StatusEquals — (String)

      A filter that retrieves only training jobs with a specific status.

      Possible values include:
      • "InProgress"
      • "Completed"
      • "Failed"
      • "Stopping"
      • "Stopped"
    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • TrainingJobSummaries — (Array<map>)

        An array of TrainingJobSummary objects, each listing a training job.

        • TrainingJobName — required — (String)

          The name of the training job that you want a summary for.

        • TrainingJobArn — required — (String)

          The Amazon Resource Name (ARN) of the training job.

        • CreationTime — required — (Date)

          A timestamp that shows when the training job was created.

        • TrainingEndTime — (Date)

          A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

        • LastModifiedTime — (Date)

          Timestamp when the training job was last modified.

        • TrainingJobStatus — required — (String)

          The status of the training job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

Service Reference:

Examples:

Calling the listTrainingJobsForHyperParameterTuningJob operation

var params = {
  HyperParameterTuningJobName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status | FinalObjectiveMetricValue,
  SortOrder: Ascending | Descending,
  StatusEquals: InProgress | Completed | Failed | Stopping | Stopped
};
sagemaker.listTrainingJobsForHyperParameterTuningJob(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: {}) —
    • HyperParameterTuningJobName — (String)

      The name of the tuning job whose training jobs you want to list.

    • NextToken — (String)

      If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of training jobs to return. The default value is 10.

    • StatusEquals — (String)

      A filter that returns only training jobs with the specified status.

      Possible values include:
      • "InProgress"
      • "Completed"
      • "Failed"
      • "Stopping"
      • "Stopped"
    • SortBy — (String)

      The field to sort results by. The default is Name.

      If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
      • "FinalObjectiveMetricValue"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"

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:

      • TrainingJobSummaries — (Array<map>)

        A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

        • TrainingJobName — required — (String)

          The name of the training job.

        • TrainingJobArn — required — (String)

          The Amazon Resource Name (ARN) of the training job.

        • TuningJobName — (String)

          The HyperParameter tuning job that launched the training job.

        • CreationTime — required — (Date)

          The date and time that the training job was created.

        • TrainingStartTime — (Date)

          The date and time that the training job started.

        • TrainingEndTime — (Date)

          Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

        • TrainingJobStatus — required — (String)

          The status of the training job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • TunedHyperParameters — required — (map<String>)

          A list of the hyperparameters for which you specified ranges to search.

        • FailureReason — (String)

          The reason that the training job failed.

        • FinalHyperParameterTuningJobObjectiveMetric — (map)

          The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

          • Type — (String)

            Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

            Possible values include:
            • "Maximize"
            • "Minimize"
          • MetricName — required — (String)

            The name of the objective metric.

          • Value — required — (Float)

            The value of the objective metric.

        • ObjectiveStatus — (String)

          The status of the objective metric for the training job:

          • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

          • Pending: The training job is in progress and evaluation of its final objective metric is pending.

          • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

          Possible values include:
          • "Succeeded"
          • "Pending"
          • "Failed"
      • NextToken — (String)

        If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Returns:

  • (AWS.Request) —

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

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

Lists transform jobs.

Service Reference:

Examples:

Calling the listTransformJobs operation

var params = {
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModifiedTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreationTime | Status,
  SortOrder: Ascending | Descending,
  StatusEquals: InProgress | Completed | Failed | Stopping | Stopped
};
sagemaker.listTransformJobs(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: {}) —
    • CreationTimeAfter — (Date)

      A filter that returns only transform jobs created after the specified time.

    • CreationTimeBefore — (Date)

      A filter that returns only transform jobs created before the specified time.

    • LastModifiedTimeAfter — (Date)

      A filter that returns only transform jobs modified after the specified time.

    • LastModifiedTimeBefore — (Date)

      A filter that returns only transform jobs modified before the specified time.

    • NameContains — (String)

      A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

    • StatusEquals — (String)

      A filter that retrieves only transform jobs with a specific status.

      Possible values include:
      • "InProgress"
      • "Completed"
      • "Failed"
      • "Stopping"
      • "Stopped"
    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreationTime"
      • "Status"
    • SortOrder — (String)

      The sort order for results. The default is Descending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NextToken — (String)

      If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of transform jobs to return in the response. The default value is 10.

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:

      • TransformJobSummaries — (Array<map>)

        An array of TransformJobSummary objects.

        • TransformJobName — required — (String)

          The name of the transform job.

        • TransformJobArn — required — (String)

          The Amazon Resource Name (ARN) of the transform job.

        • CreationTime — required — (Date)

          A timestamp that shows when the transform Job was created.

        • TransformEndTime — (Date)

          Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

        • LastModifiedTime — (Date)

          Indicates when the transform job was last modified.

        • TransformJobStatus — required — (String)

          The status of the transform job.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • FailureReason — (String)

          If the transform job failed, the reason it failed.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

Returns:

  • (AWS.Request) —

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

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

Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Service Reference:

Examples:

Calling the listWorkteams operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: Name | CreateDate,
  SortOrder: Ascending | Descending
};
sagemaker.listWorkteams(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: {}) —
    • SortBy — (String)

      The field to sort results by. The default is CreationTime.

      Possible values include:
      • "Name"
      • "CreateDate"
    • SortOrder — (String)

      The sort order for results. The default is Ascending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NameContains — (String)

      A string in the work team's name. This filter returns only work teams whose name contains the specified string.

    • NextToken — (String)

      If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    • MaxResults — (Integer)

      The maximum number of work teams to return in each page of the response.

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:

      • Workteams — (Array<map>)

        An array of Workteam objects, each describing a work team.

        • WorkteamName — required — (String)

          The name of the work team.

        • MemberDefinitions — required — (Array<map>)

          The Amazon Cognito user groups that make up the work team.

          • CognitoMemberDefinition — (map)

            The Amazon Cognito user group that is part of the work team.

            • UserPool — required — (String)

              An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

            • UserGroup — required — (String)

              An identifier for a user group.

            • ClientId — required — (String)

              An identifier for an application client. You must create the app client ID using Amazon Cognito.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) that identifies the work team.

        • ProductListingIds — (Array<String>)

          The Amazon Marketplace identifier for a vendor's work team.

        • Description — required — (String)

          A description of the work team.

        • SubDomain — (String)

          The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

        • CreateDate — (Date)

          The date and time that the work team was created (timestamp).

        • LastUpdatedDate — (Date)

          The date and time that the work team was last updated (timestamp).

        • NotificationConfiguration — (map)

          Configures SNS notifications of available or expiring work items for work teams.

          • NotificationTopicArn — (String)

            The ARN for the SNS topic to which notifications should be published.

      • NextToken — (String)

        If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

Returns:

  • (AWS.Request) —

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

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

Renders the UI template so that you can preview the worker's experience.

Service Reference:

Examples:

Calling the renderUiTemplate operation

var params = {
  RoleArn: 'STRING_VALUE', /* required */
  Task: { /* required */
    Input: 'STRING_VALUE' /* required */
  },
  UiTemplate: { /* required */
    Content: 'STRING_VALUE' /* required */
  }
};
sagemaker.renderUiTemplate(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: {}) —
    • UiTemplate — (map)

      A Template object containing the worker UI template to render.

      • Content — required — (String)

        The content of the Liquid template for the worker user interface.

    • Task — (map)

      A RenderableTask object containing a representative task to render.

      • Input — required — (String)

        A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

    • RoleArn — (String)

      The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

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:

      • RenderedContent — (String)

        A Liquid template that renders the HTML for the worker UI.

      • Errors — (Array<map>)

        A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

        • Code — required — (String)

          A unique identifier for a specific class of errors.

        • Message — required — (String)

          A human-readable message describing the error.

Returns:

  • (AWS.Request) —

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

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

Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numerical, text, Booleans, and timestamps.

Service Reference:

Examples:

Calling the search operation

var params = {
  Resource: TrainingJob, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchExpression: { /* SearchExpression */
    Filters: [
      {
        Name: 'STRING_VALUE', /* required */
        Operator: Equals | NotEquals | GreaterThan | GreaterThanOrEqualTo | LessThan | LessThanOrEqualTo | Contains,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NestedFilters: [
      {
        Filters: [ /* required */
          {
            Name: 'STRING_VALUE', /* required */
            Operator: Equals | NotEquals | GreaterThan | GreaterThanOrEqualTo | LessThan | LessThanOrEqualTo | Contains,
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        NestedPropertyName: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Operator: And | Or,
    SubExpressions: [
      /* recursive SearchExpression */,
      /* more items */
    ]
  },
  SortBy: 'STRING_VALUE',
  SortOrder: Ascending | Descending
};
sagemaker.search(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: {}) —
    • Resource — (String)

      The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

      Possible values include:
      • "TrainingJob"
    • SearchExpression — (map)

      A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

      • Filters — (Array<map>)

        A list of filter objects.

        • Name — required — (String)

          A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

        • Operator — (String)

          A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

          Equals

          The specified resource in Name equals the specified Value.

          NotEquals

          The specified resource in Name does not equal the specified Value.

          GreaterThan

          The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

          GreaterThanOrEqualTo

          The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

          LessThan

          The specified resource in Name is less than the specified Value. Not supported for text-based properties.

          LessThanOrEqualTo

          The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

          Contains

          Only supported for text-based properties. The word-list of the property contains the specified Value.

          If you have specified a filter Value, the default is Equals.

          Possible values include:
          • "Equals"
          • "NotEquals"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "LessThan"
          • "LessThanOrEqualTo"
          • "Contains"
        • Value — (String)

          A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

      • NestedFilters — (Array<map>)

        A list of nested filter objects.

        • NestedPropertyName — required — (String)

          The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .

        • Filters — required — (Array<map>)

          A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

          • Name — required — (String)

            A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

          • Operator — (String)

            A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

            Equals

            The specified resource in Name equals the specified Value.

            NotEquals

            The specified resource in Name does not equal the specified Value.

            GreaterThan

            The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

            GreaterThanOrEqualTo

            The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

            LessThan

            The specified resource in Name is less than the specified Value. Not supported for text-based properties.

            LessThanOrEqualTo

            The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

            Contains

            Only supported for text-based properties. The word-list of the property contains the specified Value.

            If you have specified a filter Value, the default is Equals.

            Possible values include:
            • "Equals"
            • "NotEquals"
            • "GreaterThan"
            • "GreaterThanOrEqualTo"
            • "LessThan"
            • "LessThanOrEqualTo"
            • "Contains"
          • Value — (String)

            A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

      • SubExpressions — (Array<map>)

        A list of search expression objects.

        • Filters — (Array<map>)

          A list of filter objects.

          • Name — required — (String)

            A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

          • Operator — (String)

            A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

            Equals

            The specified resource in Name equals the specified Value.

            NotEquals

            The specified resource in Name does not equal the specified Value.

            GreaterThan

            The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

            GreaterThanOrEqualTo

            The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

            LessThan

            The specified resource in Name is less than the specified Value. Not supported for text-based properties.

            LessThanOrEqualTo

            The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

            Contains

            Only supported for text-based properties. The word-list of the property contains the specified Value.

            If you have specified a filter Value, the default is Equals.

            Possible values include:
            • "Equals"
            • "NotEquals"
            • "GreaterThan"
            • "GreaterThanOrEqualTo"
            • "LessThan"
            • "LessThanOrEqualTo"
            • "Contains"
          • Value — (String)

            A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

        • NestedFilters — (Array<map>)

          A list of nested filter objects.

          • NestedPropertyName — required — (String)

            The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .

          • Filters — required — (Array<map>)

            A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

            • Name — required — (String)

              A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

            • Operator — (String)

              A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

              Equals

              The specified resource in Name equals the specified Value.

              NotEquals

              The specified resource in Name does not equal the specified Value.

              GreaterThan

              The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

              GreaterThanOrEqualTo

              The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

              LessThan

              The specified resource in Name is less than the specified Value. Not supported for text-based properties.

              LessThanOrEqualTo

              The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

              Contains

              Only supported for text-based properties. The word-list of the property contains the specified Value.

              If you have specified a filter Value, the default is Equals.

              Possible values include:
              • "Equals"
              • "NotEquals"
              • "GreaterThan"
              • "GreaterThanOrEqualTo"
              • "LessThan"
              • "LessThanOrEqualTo"
              • "Contains"
            • Value — (String)

              A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

        • Operator — (String)

          A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

          Possible values include:
          • "And"
          • "Or"
      • Operator — (String)

        A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

        Possible values include:
        • "And"
        • "Or"
    • SortBy — (String)

      The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

    • SortOrder — (String)

      How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

      Possible values include:
      • "Ascending"
      • "Descending"
    • NextToken — (String)

      If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

    • MaxResults — (Integer)

      The maximum number of results to return in a SearchResponse.

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:

      • Results — (Array<map>)

        A list of SearchResult objects.

        • TrainingJob — (map)

          A TrainingJob object that is returned as part of a Search request.

          • TrainingJobName — (String)

            The name of the training job.

          • TrainingJobArn — (String)

            The Amazon Resource Name (ARN) of the training job.

          • TuningJobArn — (String)

            The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

          • LabelingJobArn — (String)

            The Amazon Resource Name (ARN) of the labeling job.

          • ModelArtifacts — (map)

            Information about the Amazon S3 location that is configured for storing model artifacts.

            • S3ModelArtifacts — required — (String)

              The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

          • TrainingJobStatus — (String)

            The status of the training job.

            Training job statuses are:

            • InProgress - The training is in progress.

            • Completed - The training job has completed.

            • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

            • Stopping - The training job is stopping.

            • Stopped - The training job has stopped.

            For more detailed information, see SecondaryStatus.

            Possible values include:
            • "InProgress"
            • "Completed"
            • "Failed"
            • "Stopping"
            • "Stopped"
          • SecondaryStatus — (String)

            Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

            Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

            InProgress

            • Starting - Starting the training job.

            • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

            • Training - Training is in progress.

            • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

            Completed

            • Completed - The training job has completed.

            Failed

            • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

            Stopped

            • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

            • Stopped - The training job has stopped.

            Stopping

            • Stopping - Stopping the training job.

            Valid values for SecondaryStatus are subject to change.

            We no longer support the following secondary statuses:

            • LaunchingMLInstances

            • PreparingTrainingStack

            • DownloadingTrainingImage

            Possible values include:
            • "Starting"
            • "LaunchingMLInstances"
            • "PreparingTrainingStack"
            • "Downloading"
            • "DownloadingTrainingImage"
            • "Training"
            • "Uploading"
            • "Stopping"
            • "Stopped"
            • "MaxRuntimeExceeded"
            • "Completed"
            • "Failed"
            • "Interrupted"
            • "MaxWaitTimeExceeded"
          • FailureReason — (String)

            If the training job failed, the reason it failed.

          • HyperParameters — (map<String>)

            Algorithm-specific parameters.

          • AlgorithmSpecification — (map)

            Information about the algorithm used for training, and algorithm metadata.

            • TrainingImage — (String)

              The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

            • AlgorithmName — (String)

              The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

            • TrainingInputMode — required — (String)

              The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

              In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

              For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.

              Possible values include:
              • "Pipe"
              • "File"
            • MetricDefinitions — (Array<map>)

              A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

              • Name — required — (String)

                The name of the metric.

              • Regex — required — (String)

                A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

          • RoleArn — (String)

            The AWS Identity and Access Management (IAM) role configured for the training job.

          • InputDataConfig — (Array<map>)

            An array of Channel objects that describes each data input channel.

            • ChannelName — required — (String)

              The name of the channel.

            • DataSource — required — (map)

              The location of the channel data.

              • S3DataSource — (map)

                The S3 location of the data source that is associated with a channel.

                • S3DataType — required — (String)

                  If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

                  If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

                  If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

                  Possible values include:
                  • "ManifestFile"
                  • "S3Prefix"
                  • "AugmentedManifestFile"
                • S3Uri — required — (String)

                  Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

                  • A key name prefix might look like this: s3://bucketname/exampleprefix.

                  • A manifest might look like this: s3://bucketname/example.manifest

                    The manifest is an S3 object which is a JSON file with the following format:

                    [

                    {"prefix": "s3://customer_bucket/some/prefix/"},

                    "relative/path/to/custdata-1",

                    "relative/path/custdata-2",

                    ...

                    ]

                    The preceding JSON matches the following s3Uris:

                    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

                    s3://customer_bucket/some/prefix/relative/path/custdata-2

                    ...

                    The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

                • S3DataDistributionType — (String)

                  If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

                  If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

                  Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

                  In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

                  Possible values include:
                  • "FullyReplicated"
                  • "ShardedByS3Key"
                • AttributeNames — (Array<String>)

                  A list of one or more attribute names to use that are found in a specified augmented manifest file.

              • FileSystemDataSource — (map)

                The file system that is associated with a channel.

                • FileSystemId — required — (String)

                  The file system id.

                • FileSystemAccessMode — required — (String)

                  The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

                  Possible values include:
                  • "rw"
                  • "ro"
                • FileSystemType — required — (String)

                  The file system type.

                  Possible values include:
                  • "EFS"
                  • "FSxLustre"
                • DirectoryPath — required — (String)

                  The full path to the directory to associate with the channel.

            • ContentType — (String)

              The MIME type of the data.

            • CompressionType — (String)

              If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

              Possible values include:
              • "None"
              • "Gzip"
            • RecordWrapperType — (String)

              Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

              In File mode, leave this field unset or set it to None.

              Possible values include:
              • "None"
              • "RecordIO"
            • InputMode — (String)

              (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

              To use a model for incremental training, choose File input model.

              Possible values include:
              • "Pipe"
              • "File"
            • ShuffleConfig — (map)

              A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

              For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

              • Seed — required — (Integer)

                Determines the shuffling order in ShuffleConfig value.

          • OutputDataConfig — (map)

            The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

            • KmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

              • // KMS Key Alias

                "alias/ExampleAlias"

              • // Amazon Resource Name (ARN) of a KMS Key Alias

                "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

              If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

              The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

            • S3OutputPath — required — (String)

              Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

          • ResourceConfig — (map)

            Resources, including ML compute instances and ML storage volumes, that are configured for model training.

            • InstanceType — required — (String)

              The ML compute instance type.

              Possible values include:
              • "ml.m4.xlarge"
              • "ml.m4.2xlarge"
              • "ml.m4.4xlarge"
              • "ml.m4.10xlarge"
              • "ml.m4.16xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.24xlarge"
              • "ml.c4.xlarge"
              • "ml.c4.2xlarge"
              • "ml.c4.4xlarge"
              • "ml.c4.8xlarge"
              • "ml.p2.xlarge"
              • "ml.p2.8xlarge"
              • "ml.p2.16xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.p3dn.24xlarge"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.18xlarge"
            • InstanceCount — required — (Integer)

              The number of ML compute instances to use. For distributed training, provide a value greater than 1.

            • VolumeSizeInGB — required — (Integer)

              The size of the ML storage volume that you want to provision.

              ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

              You must specify sufficient ML storage for your scenario.

              Note: Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
            • VolumeKmsKeyId — (String)

              The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

              • // KMS Key ID

                "1234abcd-12ab-34cd-56ef-1234567890ab"

              • // Amazon Resource Name (ARN) of a KMS Key

                "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

          • VpcConfig — (map)

            A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

            • SecurityGroupIds — required — (Array<String>)

              The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

            • Subnets — required — (Array<String>)

              The ID of the subnets in the VPC to which you want to connect your training job or model.

              Note: Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
          • StoppingCondition — (map)

            Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

            To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

            • MaxRuntimeInSeconds — (Integer)

              The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

            • MaxWaitTimeInSeconds — (Integer)

              The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

          • CreationTime — (Date)

            A timestamp that indicates when the training job was created.

          • TrainingStartTime — (Date)

            Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

          • TrainingEndTime — (Date)

            Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

          • LastModifiedTime — (Date)

            A timestamp that indicates when the status of the training job was last modified.

          • SecondaryStatusTransitions — (Array<map>)

            A history of all of the secondary statuses that the training job has transitioned through.

            • Status — required — (String)

              Contains a secondary status information from a training job.

              Status might be one of the following secondary statuses:

              InProgress

              • Starting - Starting the training job.

              • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

              • Training - Training is in progress.

              • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

              Completed

              • Completed - The training job has completed.

              Failed

              • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

              Stopped

              • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

              • Stopped - The training job has stopped.

              Stopping

              • Stopping - Stopping the training job.

              We no longer support the following secondary statuses:

              • LaunchingMLInstances

              • PreparingTrainingStack

              • DownloadingTrainingImage

              Possible values include:
              • "Starting"
              • "LaunchingMLInstances"
              • "PreparingTrainingStack"
              • "Downloading"
              • "DownloadingTrainingImage"
              • "Training"
              • "Uploading"
              • "Stopping"
              • "Stopped"
              • "MaxRuntimeExceeded"
              • "Completed"
              • "Failed"
              • "Interrupted"
              • "MaxWaitTimeExceeded"
            • StartTime — required — (Date)

              A timestamp that shows when the training job transitioned to the current secondary status state.

            • EndTime — (Date)

              A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

            • StatusMessage — (String)

              A detailed description of the progress within a secondary status.

              Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

              Starting

              • Starting the training job.

              • Launching requested ML instances.

              • Insufficient capacity error from EC2 while launching instances, retrying!

              • Launched instance was unhealthy, replacing it!

              • Preparing the instances for training.

              Training

              • Downloading the training image.

              • Training image download completed. Training in progress.

              Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

              To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

              • TrainingJobStatus - InProgress

              • SecondaryStatus - Training

              • StatusMessage - Downloading the training image

          • FinalMetricDataList — (Array<map>)

            A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

            • MetricName — (String)

              The name of the metric.

            • Value — (Float)

              The value of the metric.

            • Timestamp — (Date)

              The date and time that the algorithm emitted the metric.

          • EnableNetworkIsolation — (Boolean)

            If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

          • EnableInterContainerTrafficEncryption — (Boolean)

            To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

          • Tags — (Array<map>)

            An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

            • Key — required — (String)

              The tag key.

            • Value — required — (String)

              The tag value.

      • NextToken — (String)

        If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

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

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

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

Service Reference:

Examples:

Calling the startNotebookInstance operation

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

      The name of the notebook instance 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.

Returns:

  • (AWS.Request) —

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

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

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

Service Reference:

Examples:

Calling the stopCompilationJob operation

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

      The name of the model compilation job 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.

Returns:

  • (AWS.Request) —

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

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

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

Service Reference:

Examples:

Calling the stopHyperParameterTuningJob operation

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

      The name of the tuning job 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.

Returns:

  • (AWS.Request) —

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

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

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

Service Reference:

Examples:

Calling the stopLabelingJob operation

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

      The name of the labeling job 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.

Returns:

  • (AWS.Request) —

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

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

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

Service Reference:

Examples:

Calling the stopNotebookInstance operation

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

      The name of the notebook instance to terminate.

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.

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

Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.

Service Reference:

Examples:

Calling the stopTrainingJob operation

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

      The name of the training job 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.

Returns:

  • (AWS.Request) —

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

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

Stops a transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

Service Reference:

Examples:

Calling the stopTransformJob operation

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

      The name of the transform job 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.

Returns:

  • (AWS.Request) —

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

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

Updates the specified Git repository with the specified values.

Service Reference:

Examples:

Calling the updateCodeRepository operation

var params = {
  CodeRepositoryName: 'STRING_VALUE', /* required */
  GitConfig: {
    SecretArn: 'STRING_VALUE'
  }
};
sagemaker.updateCodeRepository(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: {}) —
    • CodeRepositoryName — (String)

      The name of the Git repository to update.

    • GitConfig — (map)

      The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

      {"username": UserName, "password": Password}

      • SecretArn — (String)

        The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

        {"username": UserName, "password": Password}

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:

      • CodeRepositoryArn — (String)

        The ARN of the Git repository.

Returns:

  • (AWS.Request) —

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

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

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

Note: You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

Service Reference:

Examples:

Calling the updateEndpoint operation

var params = {
  EndpointConfigName: 'STRING_VALUE', /* required */
  EndpointName: 'STRING_VALUE' /* required */
};
sagemaker.updateEndpoint(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: {}) —
    • EndpointName — (String)

      The name of the endpoint whose configuration you want to update.

    • EndpointConfigName — (String)

      The name of the new endpoint configuration.

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:

      • EndpointArn — (String)

        The Amazon Resource Name (ARN) of the endpoint.

Returns:

  • (AWS.Request) —

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

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

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

Service Reference:

Examples:

Calling the updateEndpointWeightsAndCapacities operation

var params = {
  DesiredWeightsAndCapacities: [ /* required */
    {
      VariantName: 'STRING_VALUE', /* required */
      DesiredInstanceCount: 'NUMBER_VALUE',
      DesiredWeight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  EndpointName: 'STRING_VALUE' /* required */
};
sagemaker.updateEndpointWeightsAndCapacities(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: {}) —
    • EndpointName — (String)

      The name of an existing Amazon SageMaker endpoint.

    • DesiredWeightsAndCapacities — (Array<map>)

      An object that provides new capacity and weight values for a variant.

      • VariantName — required — (String)

        The name of the variant to update.

      • DesiredWeight — (Float)

        The variant's weight.

      • DesiredInstanceCount — (Integer)

        The variant's capacity.

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:

      • EndpointArn — (String)

        The Amazon Resource Name (ARN) of the updated endpoint.

Returns:

  • (AWS.Request) —

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

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

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

Service Reference:

Examples:

Calling the updateNotebookInstance operation

var params = {
  NotebookInstanceName: 'STRING_VALUE', /* required */
  AcceleratorTypes: [
    ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge,
    /* more items */
  ],
  AdditionalCodeRepositories: [
    'STRING_VALUE',
    /* more items */
  ],
  DefaultCodeRepository: 'STRING_VALUE',
  DisassociateAcceleratorTypes: true || false,
  DisassociateAdditionalCodeRepositories: true || false,
  DisassociateDefaultCodeRepository: true || false,
  DisassociateLifecycleConfig: true || false,
  InstanceType: ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5d.xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.18xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge,
  LifecycleConfigName: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  RootAccess: Enabled | Disabled,
  VolumeSizeInGB: 'NUMBER_VALUE'
};
sagemaker.updateNotebookInstance(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: {}) —
    • NotebookInstanceName — (String)

      The name of the notebook instance to update.

    • InstanceType — (String)

      The Amazon ML compute instance type.

      Possible values include:
      • "ml.t2.medium"
      • "ml.t2.large"
      • "ml.t2.xlarge"
      • "ml.t2.2xlarge"
      • "ml.t3.medium"
      • "ml.t3.large"
      • "ml.t3.xlarge"
      • "ml.t3.2xlarge"
      • "ml.m4.xlarge"
      • "ml.m4.2xlarge"
      • "ml.m4.4xlarge"
      • "ml.m4.10xlarge"
      • "ml.m4.16xlarge"
      • "ml.m5.xlarge"
      • "ml.m5.2xlarge"
      • "ml.m5.4xlarge"
      • "ml.m5.12xlarge"
      • "ml.m5.24xlarge"
      • "ml.c4.xlarge"
      • "ml.c4.2xlarge"
      • "ml.c4.4xlarge"
      • "ml.c4.8xlarge"
      • "ml.c5.xlarge"
      • "ml.c5.2xlarge"
      • "ml.c5.4xlarge"
      • "ml.c5.9xlarge"
      • "ml.c5.18xlarge"
      • "ml.c5d.xlarge"
      • "ml.c5d.2xlarge"
      • "ml.c5d.4xlarge"
      • "ml.c5d.9xlarge"
      • "ml.c5d.18xlarge"
      • "ml.p2.xlarge"
      • "ml.p2.8xlarge"
      • "ml.p2.16xlarge"
      • "ml.p3.2xlarge"
      • "ml.p3.8xlarge"
      • "ml.p3.16xlarge"
    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.

      Note: To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
    • LifecycleConfigName — (String)

      The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    • DisassociateLifecycleConfig — (Boolean)

      Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

    • VolumeSizeInGB — (Integer)

      The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

    • DefaultCodeRepository — (String)

      The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    • AdditionalCodeRepositories — (Array<String>)

      An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    • AcceleratorTypes — (Array<String>)

      A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

    • DisassociateAcceleratorTypes — (Boolean)

      A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

    • DisassociateDefaultCodeRepository — (Boolean)

      The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

    • DisassociateAdditionalCodeRepositories — (Boolean)

      A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

    • RootAccess — (String)

      Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      Note: If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.
      Possible values include:
      • "Enabled"
      • "Disabled"

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.

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

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Service Reference:

Examples:

Calling the updateNotebookInstanceLifecycleConfig operation

var params = {
  NotebookInstanceLifecycleConfigName: 'STRING_VALUE', /* required */
  OnCreate: [
    {
      Content: 'STRING_VALUE'
    },
    /* more items */
  ],
  OnStart: [
    {
      Content: 'STRING_VALUE'
    },
    /* more items */
  ]
};
sagemaker.updateNotebookInstanceLifecycleConfig(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: {}) —
    • NotebookInstanceLifecycleConfigName — (String)

      The name of the lifecycle configuration.

    • OnCreate — (Array<map>)

      The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

      • Content — (String)

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

    • OnStart — (Array<map>)

      The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

      • Content — (String)

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

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.

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

Updates an existing work team with new member definitions or description.

Service Reference:

Examples:

Calling the updateWorkteam operation

var params = {
  WorkteamName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  MemberDefinitions: [
    {
      CognitoMemberDefinition: {
        ClientId: 'STRING_VALUE', /* required */
        UserGroup: 'STRING_VALUE', /* required */
        UserPool: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  NotificationConfiguration: {
    NotificationTopicArn: 'STRING_VALUE'
  }
};
sagemaker.updateWorkteam(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: {}) —
    • WorkteamName — (String)

      The name of the work team to update.

    • MemberDefinitions — (Array<map>)

      A list of MemberDefinition objects that contain the updated work team members.

      • CognitoMemberDefinition — (map)

        The Amazon Cognito user group that is part of the work team.

        • UserPool — required — (String)

          An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

        • UserGroup — required — (String)

          An identifier for a user group.

        • ClientId — required — (String)

          An identifier for an application client. You must create the app client ID using Amazon Cognito.

    • Description — (String)

      An updated description for the work team.

    • NotificationConfiguration — (map)

      Configures SNS topic notifications for available or expiring work items

      • NotificationTopicArn — (String)

        The ARN for the SNS topic to which notifications should be published.

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:

      • Workteam — (map)

        A Workteam object that describes the updated work team.

        • WorkteamName — required — (String)

          The name of the work team.

        • MemberDefinitions — required — (Array<map>)

          The Amazon Cognito user groups that make up the work team.

          • CognitoMemberDefinition — (map)

            The Amazon Cognito user group that is part of the work team.

            • UserPool — required — (String)

              An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

            • UserGroup — required — (String)

              An identifier for a user group.

            • ClientId — required — (String)

              An identifier for an application client. You must create the app client ID using Amazon Cognito.

        • WorkteamArn — required — (String)

          The Amazon Resource Name (ARN) that identifies the work team.

        • ProductListingIds — (Array<String>)

          The Amazon Marketplace identifier for a vendor's work team.

        • Description — required — (String)

          A description of the work team.

        • SubDomain — (String)

          The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

        • CreateDate — (Date)

          The date and time that the work team was created (timestamp).

        • LastUpdatedDate — (Date)

          The date and time that the work team was last updated (timestamp).

        • NotificationConfiguration — (map)

          Configures SNS notifications of available or expiring work items for work teams.

          • NotificationTopicArn — (String)

            The ARN for the SNS topic to which notifications should be published.

Returns:

  • (AWS.Request) —

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

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

Waits for a given SageMaker resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the notebookInstanceInService state

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

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

Waiter Resource Details

sagemaker.waitFor('notebookInstanceInService', params = {}, [callback]) ⇒ AWS.Request

Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstance() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the notebookInstanceInService state

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

Parameters:

  • params (Object) —
    • NotebookInstanceName — (String)

      The name of the notebook instance that you want information about.

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:

      • NotebookInstanceArn — (String)

        The Amazon Resource Name (ARN) of the notebook instance.

      • NotebookInstanceName — (String)

        The name of the Amazon SageMaker notebook instance.

      • NotebookInstanceStatus — (String)

        The status of the notebook instance.

        Possible values include:
        • "Pending"
        • "InService"
        • "Stopping"
        • "Stopped"
        • "Failed"
        • "Deleting"
        • "Updating"
      • FailureReason — (String)

        If status is Failed, the reason it failed.

      • Url — (String)

        The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      • InstanceType — (String)

        The type of ML compute instance running on the notebook instance.

        Possible values include:
        • "ml.t2.medium"
        • "ml.t2.large"
        • "ml.t2.xlarge"
        • "ml.t2.2xlarge"
        • "ml.t3.medium"
        • "ml.t3.large"
        • "ml.t3.xlarge"
        • "ml.t3.2xlarge"
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5d.xlarge"
        • "ml.c5d.2xlarge"
        • "ml.c5d.4xlarge"
        • "ml.c5d.9xlarge"
        • "ml.c5d.18xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
      • SubnetId — (String)

        The ID of the VPC subnet.

      • SecurityGroups — (Array<String>)

        The IDs of the VPC security groups.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the instance.

      • KmsKeyId — (String)

        The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      • NetworkInterfaceId — (String)

        The network interface IDs that Amazon SageMaker created at the time of creating the instance.

      • LastModifiedTime — (Date)

        A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

      • CreationTime — (Date)

        A timestamp. Use this parameter to return the time when the notebook instance was created

      • NotebookInstanceLifecycleConfigName — (String)

        Returns the name of a notebook instance lifecycle configuration.

        For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

      • DirectInternetAccess — (String)

        Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

        For more information, see Notebook Instances Are Internet-Enabled by Default.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • VolumeSizeInGB — (Integer)

        The size, in GB, of the ML storage volume attached to the notebook instance.

      • AcceleratorTypes — (Array<String>)

        A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      • DefaultCodeRepository — (String)

        The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • AdditionalCodeRepositories — (Array<String>)

        An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • RootAccess — (String)

        Whether root access is enabled or disabled for users of the notebook instance.

        Note: Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request) —

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

See Also:

sagemaker.waitFor('notebookInstanceStopped', params = {}, [callback]) ⇒ AWS.Request

Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstance() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the notebookInstanceStopped state

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

Parameters:

  • params (Object) —
    • NotebookInstanceName — (String)

      The name of the notebook instance that you want information about.

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:

      • NotebookInstanceArn — (String)

        The Amazon Resource Name (ARN) of the notebook instance.

      • NotebookInstanceName — (String)

        The name of the Amazon SageMaker notebook instance.

      • NotebookInstanceStatus — (String)

        The status of the notebook instance.

        Possible values include:
        • "Pending"
        • "InService"
        • "Stopping"
        • "Stopped"
        • "Failed"
        • "Deleting"
        • "Updating"
      • FailureReason — (String)

        If status is Failed, the reason it failed.

      • Url — (String)

        The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      • InstanceType — (String)

        The type of ML compute instance running on the notebook instance.

        Possible values include:
        • "ml.t2.medium"
        • "ml.t2.large"
        • "ml.t2.xlarge"
        • "ml.t2.2xlarge"
        • "ml.t3.medium"
        • "ml.t3.large"
        • "ml.t3.xlarge"
        • "ml.t3.2xlarge"
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5d.xlarge"
        • "ml.c5d.2xlarge"
        • "ml.c5d.4xlarge"
        • "ml.c5d.9xlarge"
        • "ml.c5d.18xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
      • SubnetId — (String)

        The ID of the VPC subnet.

      • SecurityGroups — (Array<String>)

        The IDs of the VPC security groups.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the instance.

      • KmsKeyId — (String)

        The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      • NetworkInterfaceId — (String)

        The network interface IDs that Amazon SageMaker created at the time of creating the instance.

      • LastModifiedTime — (Date)

        A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

      • CreationTime — (Date)

        A timestamp. Use this parameter to return the time when the notebook instance was created

      • NotebookInstanceLifecycleConfigName — (String)

        Returns the name of a notebook instance lifecycle configuration.

        For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

      • DirectInternetAccess — (String)

        Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

        For more information, see Notebook Instances Are Internet-Enabled by Default.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • VolumeSizeInGB — (Integer)

        The size, in GB, of the ML storage volume attached to the notebook instance.

      • AcceleratorTypes — (Array<String>)

        A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      • DefaultCodeRepository — (String)

        The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • AdditionalCodeRepositories — (Array<String>)

        An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • RootAccess — (String)

        Whether root access is enabled or disabled for users of the notebook instance.

        Note: Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request) —

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

See Also:

sagemaker.waitFor('notebookInstanceDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstance() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the notebookInstanceDeleted state

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

Parameters:

  • params (Object) —
    • NotebookInstanceName — (String)

      The name of the notebook instance that you want information about.

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:

      • NotebookInstanceArn — (String)

        The Amazon Resource Name (ARN) of the notebook instance.

      • NotebookInstanceName — (String)

        The name of the Amazon SageMaker notebook instance.

      • NotebookInstanceStatus — (String)

        The status of the notebook instance.

        Possible values include:
        • "Pending"
        • "InService"
        • "Stopping"
        • "Stopped"
        • "Failed"
        • "Deleting"
        • "Updating"
      • FailureReason — (String)

        If status is Failed, the reason it failed.

      • Url — (String)

        The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      • InstanceType — (String)

        The type of ML compute instance running on the notebook instance.

        Possible values include:
        • "ml.t2.medium"
        • "ml.t2.large"
        • "ml.t2.xlarge"
        • "ml.t2.2xlarge"
        • "ml.t3.medium"
        • "ml.t3.large"
        • "ml.t3.xlarge"
        • "ml.t3.2xlarge"
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5d.xlarge"
        • "ml.c5d.2xlarge"
        • "ml.c5d.4xlarge"
        • "ml.c5d.9xlarge"
        • "ml.c5d.18xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
      • SubnetId — (String)

        The ID of the VPC subnet.

      • SecurityGroups — (Array<String>)

        The IDs of the VPC security groups.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the instance.

      • KmsKeyId — (String)

        The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      • NetworkInterfaceId — (String)

        The network interface IDs that Amazon SageMaker created at the time of creating the instance.

      • LastModifiedTime — (Date)

        A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

      • CreationTime — (Date)

        A timestamp. Use this parameter to return the time when the notebook instance was created

      • NotebookInstanceLifecycleConfigName — (String)

        Returns the name of a notebook instance lifecycle configuration.

        For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

      • DirectInternetAccess — (String)

        Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

        For more information, see Notebook Instances Are Internet-Enabled by Default.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • VolumeSizeInGB — (Integer)

        The size, in GB, of the ML storage volume attached to the notebook instance.

      • AcceleratorTypes — (Array<String>)

        A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      • DefaultCodeRepository — (String)

        The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • AdditionalCodeRepositories — (Array<String>)

        An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

      • RootAccess — (String)

        Whether root access is enabled or disabled for users of the notebook instance.

        Note: Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request) —

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

See Also:

sagemaker.waitFor('trainingJobCompletedOrStopped', params = {}, [callback]) ⇒ AWS.Request

Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJob() operation every 120 seconds (at most 180 times).

Examples:

Waiting for the trainingJobCompletedOrStopped state

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

Parameters:

  • params (Object) —
    • TrainingJobName — (String)

      The name of the training 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)