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.

Other 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, processingJobCompletedOrStopped

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.

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

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

  • s3UseArnRegion (Boolean) —

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

  • retryDelayOptions (map) —

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

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

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

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

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

Property Details

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.

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

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Service Reference:

Examples:

Calling the associateTrialComponent operation

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

      The name of the component to associated with the trial.

    • TrialName — (String)

      The name of the trial to associate with.

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:

      • TrialComponentArn — (String)

        The ARN of the trial component.

      • TrialArn — (String)

        The Amazon Resource Name (ARN) of the trial.

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.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.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 | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.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 | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.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.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.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 | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.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:

                    The preceding JSON matches the following s3Uris:

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

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

                    "relative/path/custdata-2",

                    ...

                    "relative/path/custdata-N"

                    ]

                    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

                    ...

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

                    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.g4dn.xlarge"
              • "ml.g4dn.2xlarge"
              • "ml.g4dn.4xlarge"
              • "ml.g4dn.8xlarge"
              • "ml.g4dn.12xlarge"
              • "ml.g4dn.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"
              • "ml.c5n.xlarge"
              • "ml.c5n.2xlarge"
              • "ml.c5n.4xlarge"
              • "ml.c5n.9xlarge"
              • "ml.c5n.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.
              Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
            • VolumeKmsKeyId — (String)

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

              Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

              The VolumeKmsKeyId can be in 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",

                    ...

                    "relative/path/custdata-N"

                    ]

                    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

                    ...

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

                    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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about 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:

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

              • Alias name: alias/ExampleAlias

              • Alias name ARN: 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 CreateModel 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 model 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:

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

              • Alias name: alias/ExampleAlias

              • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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

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

Creates a running App for the specified UserProfile. Supported Apps are JupyterServer, KernelGateway, and TensorBoard. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Studio Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. Apps will automatically terminate and be deleted when stopped from within Studio, or when the DeleteApp API is manually called. UserProfiles are limited to 5 concurrently running Apps at a time.

Service Reference:

Examples:

Calling the createApp operation

var params = {
  AppName: 'STRING_VALUE', /* required */
  AppType: JupyterServer | KernelGateway | TensorBoard, /* required */
  DomainId: 'STRING_VALUE', /* required */
  UserProfileName: 'STRING_VALUE', /* required */
  ResourceSpec: {
    InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
    SageMakerImageArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createApp(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: {}) —
    • DomainId — (String)

      The domain ID.

    • UserProfileName — (String)

      The user profile name.

    • AppType — (String)

      The type of app.

      Possible values include:
      • "JupyterServer"
      • "KernelGateway"
      • "TensorBoard"
    • AppName — (String)

      The name of the app.

    • Tags — (Array<map>)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • ResourceSpec — (map)

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn — (String)

        The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • InstanceType — (String)

        The instance type.

        Possible values include:
        • "system"
        • "ml.t3.micro"
        • "ml.t3.small"
        • "ml.t3.medium"
        • "ml.t3.large"
        • "ml.t3.xlarge"
        • "ml.t3.2xlarge"
        • "ml.m5.large"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.8xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.16xlarge"
        • "ml.m5.24xlarge"
        • "ml.c5.large"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.12xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5.24xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
        • "ml.g4dn.xlarge"
        • "ml.g4dn.2xlarge"
        • "ml.g4dn.4xlarge"
        • "ml.g4dn.8xlarge"
        • "ml.g4dn.12xlarge"
        • "ml.g4dn.16xlarge"

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:

      • AppArn — (String)

        The app's Amazon Resource Name (ARN).

Returns:

  • (AWS.Request) —

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

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

Creates an AutoPilot job.

After you run an AutoPilot job, you can find the best performing model by calling , and then deploy that model by following the steps described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services.

For information about how to use AutoPilot, see Use AutoPilot to Automate Model Development.

Service Reference:

Examples:

Calling the createAutoMLJob operation

var params = {
  AutoMLJobName: 'STRING_VALUE', /* required */
  InputDataConfig: [ /* required */
    {
      DataSource: { /* required */
        S3DataSource: { /* required */
          S3DataType: ManifestFile | S3Prefix, /* required */
          S3Uri: 'STRING_VALUE' /* required */
        }
      },
      TargetAttributeName: 'STRING_VALUE', /* required */
      CompressionType: None | Gzip
    },
    /* more items */
  ],
  OutputDataConfig: { /* required */
    S3OutputPath: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  AutoMLJobConfig: {
    CompletionCriteria: {
      MaxAutoMLJobRuntimeInSeconds: 'NUMBER_VALUE',
      MaxCandidates: 'NUMBER_VALUE',
      MaxRuntimePerTrainingJobInSeconds: 'NUMBER_VALUE'
    },
    SecurityConfig: {
      EnableInterContainerTrafficEncryption: true || false,
      VolumeKmsKeyId: 'STRING_VALUE',
      VpcConfig: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Subnets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  AutoMLJobObjective: {
    MetricName: Accuracy | MSE | F1 | F1macro /* required */
  },
  GenerateCandidateDefinitionsOnly: true || false,
  ProblemType: BinaryClassification | MulticlassClassification | Regression,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createAutoMLJob(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: {}) —
    • AutoMLJobName — (String)

      Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.

    • InputDataConfig — (Array<map>)

      Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 1000 rows.

      • DataSource — required — (map)

        The data source.

        • S3DataSource — required — (map)

          The Amazon S3 location of the input data.

          Note: The input data must be in CSV format and contain at least 1000 rows.
          • S3DataType — required — (String)

            The data type.

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

            The URL to the Amazon S3 data source.

      • CompressionType — (String)

        You can use Gzip or None. The default value is None.

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

        The name of the target variable in supervised learning, a.k.a. 'y'.

    • OutputDataConfig — (map)

      Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.

      • KmsKeyId — (String)

        The AWS KMS encryption key ID.

      • S3OutputPath — required — (String)

        The Amazon S3 output path. Must be 128 characters or less.

    • ProblemType — (String)

      Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.

      Possible values include:
      • "BinaryClassification"
      • "MulticlassClassification"
      • "Regression"
    • AutoMLJobObjective — (map)

      Defines the job's objective. You provide a MetricName and AutoML will infer minimize or maximize. If this is not provided, the most commonly used ObjectiveMetric for problem type will be selected.

      • MetricName — required — (String)

        The name of the metric.

        Possible values include:
        • "Accuracy"
        • "MSE"
        • "F1"
        • "F1macro"
    • AutoMLJobConfig — (map)

      Contains CompletionCriteria and SecurityConfig.

      • CompletionCriteria — (map)

        How long a job is allowed to run, or how many candidates a job is allowed to generate.

        • MaxCandidates — (Integer)

          The maximum number of times a training job is allowed to run.

        • MaxRuntimePerTrainingJobInSeconds — (Integer)

          The maximum time, in seconds, a job is allowed to run.

        • MaxAutoMLJobRuntimeInSeconds — (Integer)

          The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.

      • SecurityConfig — (map)

        Security configuration for traffic encryption or Amazon VPC settings.

        • VolumeKmsKeyId — (String)

          The key used to encrypt stored data.

        • EnableInterContainerTrafficEncryption — (Boolean)

          Whether to use traffic encryption between the container layers.

        • VpcConfig — (map)

          VPC configuration.

          • 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

    • RoleArn — (String)

      The ARN of the role that will be used to access the data.

    • GenerateCandidateDefinitionsOnly — (Boolean)

      This will generate possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

    • Tags — (Array<map>)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

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

      • AutoMLJobArn — (String)

        When a job is created, it is assigned a unique ARN.

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 | KERAS | MXNET | ONNX | PYTORCH | XGBOOST | TFLITE, /* 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 | ml_inf1 | jetson_tx1 | jetson_tx2 | jetson_nano | jetson_xavier | rasp3b | imx8qm | deeplens | rk3399 | rk3288 | aisage | sbe_c | qcs605 | qcs603 | sitara_am57x | amba_cv22 /* 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]}

        • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

          • Examples for one input:

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

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

          • Examples for two inputs:

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

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

        • 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"
        • "KERAS"
        • "MXNET"
        • "ONNX"
        • "PYTORCH"
        • "XGBOOST"
        • "TFLITE"
    • 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"
        • "ml_inf1"
        • "jetson_tx1"
        • "jetson_tx2"
        • "jetson_nano"
        • "jetson_xavier"
        • "rasp3b"
        • "imx8qm"
        • "deeplens"
        • "rk3399"
        • "rk3288"
        • "aisage"
        • "sbe_c"
        • "qcs605"
        • "qcs603"
        • "sitara_am57x"
        • "amba_cv22"
    • 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.

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

Creates a Domain for Amazon SageMaker Studio, which can be accessed by end-users in a web browser. A Domain has an associated directory, list of authorized users, and a variety of security, application, policies, and Amazon Virtual Private Cloud configurations. An AWS account is limited to one Domain, per region. Users within a domain can share notebook files and other artifacts with each other. When a Domain is created, an Amazon Elastic File System (EFS) is also created for use by all of the users within the Domain. Each user receives a private home directory within the EFS for notebooks, Git repositories, and data files.

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  AuthMode: SSO | IAM, /* required */
  DefaultUserSettings: { /* required */
    ExecutionRole: 'STRING_VALUE',
    JupyterServerAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    },
    KernelGatewayAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    },
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    SharingSettings: {
      NotebookOutputOption: Allowed | Disabled,
      S3KmsKeyId: 'STRING_VALUE',
      S3OutputPath: 'STRING_VALUE'
    },
    TensorBoardAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    }
  },
  DomainName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcId: 'STRING_VALUE', /* required */
  HomeEfsFileSystemKmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createDomain(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: {}) —
    • DomainName — (String)

      A name for the domain.

    • AuthMode — (String)

      The mode of authentication that member use to access the domain.

      Possible values include:
      • "SSO"
      • "IAM"
    • DefaultUserSettings — (map)

      The default user settings.

      • ExecutionRole — (String)

        The execution role for the user.

      • SecurityGroups — (Array<String>)

        The security groups.

      • SharingSettings — (map)

        The sharing settings.

        • NotebookOutputOption — (String)

          The notebook output option.

          Possible values include:
          • "Allowed"
          • "Disabled"
        • S3OutputPath — (String)

          The Amazon S3 output path.

        • S3KmsKeyId — (String)

          The AWS Key Management Service encryption key ID.

      • JupyterServerAppSettings — (map)

        The Jupyter server's app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"
      • KernelGatewayAppSettings — (map)

        The kernel gateway app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"
      • TensorBoardAppSettings — (map)

        The TensorBoard app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"
    • SubnetIds — (Array<String>)

      Security setting to limit to a set of subnets.

    • VpcId — (String)

      Security setting to limit the domain's communication to a Amazon Virtual Private Cloud.

    • Tags — (Array<map>)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • HomeEfsFileSystemKmsKeyId — (String)

      The AWS Key Management Service (KMS) encryption key ID. Encryption with a customer master key (CMK) is not supported.

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:

      • DomainArn — (String)

        The Amazon Resource Name (ARN) of the created domain.

      • Url — (String)

        The URL to the created domain.

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.

Use this API to deploy models using Amazon SageMaker hosting services.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).

Note: You must not delete an EndpointConfig that is 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.

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 in 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 if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. 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.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).

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 | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.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 */
  ],
  DataCaptureConfig: {
    CaptureOptions: [ /* required */
      {
        CaptureMode: Input | Output /* required */
      },
      /* more items */
    ],
    DestinationS3Uri: 'STRING_VALUE', /* required */
    InitialSamplingPercentage: 'NUMBER_VALUE', /* required */
    CaptureContentTypeHeader: {
      CsvContentTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      JsonContentTypes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    EnableCapture: true || false,
    KmsKeyId: 'STRING_VALUE'
  },
  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"
        • "ml.inf1.xlarge"
        • "ml.inf1.2xlarge"
        • "ml.inf1.6xlarge"
        • "ml.inf1.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"
    • DataCaptureConfig — (map)

      • EnableCapture — (Boolean)

      • InitialSamplingPercentage — required — (Integer)

      • DestinationS3Uri — required — (String)

      • KmsKeyId — (String)

      • CaptureOptions — required — (Array<map>)

        • CaptureMode — required — (String)

          Possible values include:

          • "Input"
          • "Output"
      • CaptureContentTypeHeader — (map)

        • CsvContentTypes — (Array<String>)

        • JsonContentTypes — (Array<String>)

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

      The KmsKeyId can be any of the following formats:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

      • Alias name: alias/ExampleAlias

      • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

      The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS

      Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

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.

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

Creates an Amazon SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

Service Reference:

Examples:

Calling the createExperiment operation

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

      The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

    • DisplayName — (String)

      The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

    • Description — (String)

      The description of the experiment.

    • Tags — (Array<map>)

      A list of tags to associate with the experiment. You can use Search API to search on the tags.

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

      • ExperimentArn — (String)

        The Amazon Resource Name (ARN) of the experiment.

Returns:

  • (AWS.Request) —

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

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

Creates a flow definition.

Service Reference:

Examples:

Calling the createFlowDefinition operation

var params = {
  FlowDefinitionName: 'STRING_VALUE', /* required */
  HumanLoopConfig: { /* required */
    HumanTaskUiArn: 'STRING_VALUE', /* required */
    TaskCount: 'NUMBER_VALUE', /* required */
    TaskDescription: 'STRING_VALUE', /* required */
    TaskTitle: 'STRING_VALUE', /* required */
    WorkteamArn: 'STRING_VALUE', /* required */
    PublicWorkforceTaskPrice: {
      AmountInUsd: {
        Cents: 'NUMBER_VALUE',
        Dollars: 'NUMBER_VALUE',
        TenthFractionsOfACent: 'NUMBER_VALUE'
      }
    },
    TaskAvailabilityLifetimeInSeconds: 'NUMBER_VALUE',
    TaskKeywords: [
      'STRING_VALUE',
      /* more items */
    ],
    TaskTimeLimitInSeconds: 'NUMBER_VALUE'
  },
  OutputConfig: { /* required */
    S3OutputPath: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  HumanLoopActivationConfig: {
    HumanLoopActivationConditionsConfig: { /* required */
      HumanLoopActivationConditions: any /* This value will be JSON encoded on your behalf with JSON.stringify() */ /* required */
    }
  },
  HumanLoopRequestSource: {
    AwsManagedHumanLoopRequestSource: AWS/Rekognition/DetectModerationLabels/Image/V3 | AWS/Textract/AnalyzeDocument/Forms/V1 /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createFlowDefinition(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: {}) —
    • FlowDefinitionName — (String)

      The name of your flow definition.

    • HumanLoopRequestSource — (map)

      Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

      • AwsManagedHumanLoopRequestSource — required — (String)

        Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

        Possible values include:
        • "AWS/Rekognition/DetectModerationLabels/Image/V3"
        • "AWS/Textract/AnalyzeDocument/Forms/V1"
    • HumanLoopActivationConfig — (map)

      An object containing information about the events that trigger a human workflow.

      • HumanLoopActivationConditionsConfig — required — (map)

        Container structure for defining under what conditions SageMaker creates a human loop.

        • HumanLoopActivationConditions — required — (String)

          JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

    • HumanLoopConfig — (map)

      An object containing information about the tasks the human reviewers will perform.

      • WorkteamArn — required — (String)

        Amazon Resource Name (ARN) of a team of workers.

      • HumanTaskUiArn — required — (String)

        The Amazon Resource Name (ARN) of the human task user interface.

      • TaskTitle — required — (String)

        A title for the human worker task.

      • TaskDescription — required — (String)

        A description for the human worker task.

      • TaskCount — required — (Integer)

        The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

      • TaskAvailabilityLifetimeInSeconds — (Integer)

        The length of time that a task remains available for labeling by human workers.

      • TaskTimeLimitInSeconds — (Integer)

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

      • TaskKeywords — (Array<String>)

        Keywords used to describe the task so that workers can discover the task.

      • PublicWorkforceTaskPrice — (map)

        Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

        Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

        • 0.036

        • 0.048

        • 0.060

        • 0.072

        • 0.120

        • 0.240

        • 0.360

        • 0.480

        • 0.600

        • 0.720

        • 0.840

        • 0.960

        • 1.080

        • 1.200

        Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

        • 0.012

        • 0.024

        • 0.036

        • 0.048

        • 0.060

        • 0.072

        • 0.120

        • 0.240

        • 0.360

        • 0.480

        • 0.600

        • 0.720

        • 0.840

        • 0.960

        • 1.080

        • 1.200

        Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

        • 0.840

        • 0.960

        • 1.080

        • 1.200

        Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

        • 2.400

        • 2.280

        • 2.160

        • 2.040

        • 1.920

        • 1.800

        • 1.680

        • 1.560

        • 1.440

        • 1.320

        • 1.200

        • 1.080

        • 0.960

        • 0.840

        • 0.720

        • 0.600

        • 0.480

        • 0.360

        • 0.240

        • 0.120

        • 0.072

        • 0.060

        • 0.048

        • 0.036

        • 0.024

        • 0.012

        Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

        • 1.200

        • 1.080

        • 0.960

        • 0.840

        • 0.720

        • 0.600

        • 0.480

        • 0.360

        • 0.240

        • 0.120

        • 0.072

        • 0.060

        • 0.048

        • 0.036

        • 0.024

        • 0.012

        Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

        • 1.200

        • 1.080

        • 0.960

        • 0.840

        • 0.720

        • 0.600

        • 0.480

        • 0.360

        • 0.240

        • 0.120

        • 0.072

        • 0.060

        • 0.048

        • 0.036

        • 0.024

        • 0.012

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

    • OutputConfig — (map)

      An object containing information about where the human review results will be uploaded.

      • S3OutputPath — required — (String)

        The Amazon S3 path where the object containing human output will be made available.

      • KmsKeyId — (String)

        The Amazon Key Management Service (KMS) key ID for server-side encryption.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

    • Tags — (Array<map>)

      An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

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

      • FlowDefinitionArn — (String)

        The Amazon Resource Name (ARN) of the flow definition you create.

Returns:

  • (AWS.Request) —

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

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

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

Service Reference:

Examples:

Calling the createHumanTaskUi operation

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

      The name of the user interface you are creating.

    • UiTemplate — (map)

      The Liquid template for the worker user interface.

      • Content — required — (String)

        The content of the Liquid template for the worker user interface.

    • Tags — (Array<map>)

      An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

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

      • HumanTaskUiArn — (String)

        The Amazon Resource Name (ARN) of the human review workflow user interface you create.

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,
    TuningJobCompletionCriteria: {
      TargetObjectiveMetricValue: 'NUMBER_VALUE' /* required */
    }
  },
  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.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.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 | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.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'
    },
    DefinitionName: 'STRING_VALUE',
    EnableInterContainerTrafficEncryption: true || false,
    EnableManagedSpotTraining: true || false,
    EnableNetworkIsolation: true || false,
    HyperParameterRanges: {
      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 */
      ]
    },
    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>': ... */
    },
    TuningObjective: {
      MetricName: 'STRING_VALUE', /* required */
      Type: Maximize | Minimize /* required */
    },
    VpcConfig: {
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  TrainingJobDefinitions: [
    {
      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.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.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 | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.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'
      },
      DefinitionName: 'STRING_VALUE',
      EnableInterContainerTrafficEncryption: true || false,
      EnableManagedSpotTraining: true || false,
      EnableNetworkIsolation: true || false,
      HyperParameterRanges: {
        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 */
        ]
      },
      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>': ... */
      },
      TuningObjective: {
        MetricName: 'STRING_VALUE', /* required */
        Type: Maximize | Minimize /* required */
      },
      VpcConfig: {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Subnets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* 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 How Hyperparameter Tuning Works.

      • 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 strategy, 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

            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.

            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

            Hyperparameter 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"
      • TuningJobCompletionCriteria — (map)

        The tuning job's completion criteria.

        • TargetObjectiveMetricValue — required — (Float)

          The objective metric's value.

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

      • DefinitionName — (String)

        The job definition name.

      • TuningObjective — (map)

        Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

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

      • HyperParameterRanges — (map)

        Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

        Note: You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
        • 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

            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.

            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

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

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

                The preceding JSON matches the following s3Uris:

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

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

                "relative/path/custdata-2",

                ...

                "relative/path/custdata-N"

                ]

                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

                ...

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

                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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

      • 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.g4dn.xlarge"
          • "ml.g4dn.2xlarge"
          • "ml.g4dn.4xlarge"
          • "ml.g4dn.8xlarge"
          • "ml.g4dn.12xlarge"
          • "ml.g4dn.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"
          • "ml.c5n.xlarge"
          • "ml.c5n.2xlarge"
          • "ml.c5n.4xlarge"
          • "ml.c5n.9xlarge"
          • "ml.c5n.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.
          Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
        • VolumeKmsKeyId — (String)

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

          Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

          The VolumeKmsKeyId can be in 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.

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

    • TrainingJobDefinitions — (Array<map>)

      • DefinitionName — (String)

        The job definition name.

      • TuningObjective — (map)

        Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

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

      • HyperParameterRanges — (map)

        Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

        Note: You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
        • 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

            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.

            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

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

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

                The preceding JSON matches the following s3Uris:

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

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

                "relative/path/custdata-2",

                ...

                "relative/path/custdata-N"

                ]

                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

                ...

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

                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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

      • 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.g4dn.xlarge"
          • "ml.g4dn.2xlarge"
          • "ml.g4dn.4xlarge"
          • "ml.g4dn.8xlarge"
          • "ml.g4dn.12xlarge"
          • "ml.g4dn.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"
          • "ml.c5n.xlarge"
          • "ml.c5n.2xlarge"
          • "ml.c5n.4xlarge"
          • "ml.c5n.9xlarge"
          • "ml.c5n.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.
          Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
        • VolumeKmsKeyId — (String)

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

          Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

          The VolumeKmsKeyId can be in 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.

      • 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'
    },
    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 labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

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

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

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

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

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

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

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

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

        EU Frankfurt (eu-central-1):

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

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

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

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

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

        • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

      • 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). The default value is 864000 seconds (10 days). 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. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects.

      • 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

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

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

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

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

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

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

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

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

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

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

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

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

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

          • 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

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

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

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

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

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

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

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

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

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

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

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

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

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

          • Named entity recognition - 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

          • Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

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

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

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

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

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

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

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

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

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

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

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

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

          • Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

          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 that contains inference code, artifacts (from prior training), and a 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.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).

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',
      Mode: SingleModel | MultiModel,
      ModelDataUrl: 'STRING_VALUE',
      ModelPackageName: 'STRING_VALUE'
    },
    /* more items */
  ],
  EnableNetworkIsolation: true || false,
  PrimaryContainer: {
    ContainerHostname: 'STRING_VALUE',
    Environment: {
      '<EnvironmentKey>': 'STRING_VALUE',
      /* '<EnvironmentKey>': ... */
    },
    Image: 'STRING_VALUE',
    Mode: SingleModel | MultiModel,
    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 the 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

      • Mode — (String)

        Whether the container hosts a single model or multiple models.

        Possible values include:
        • "SingleModel"
        • "MultiModel"
      • 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 the 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

      • Mode — (String)

        Whether the container hosts a single model or multiple models.

        Possible values include:
        • "SingleModel"
        • "MultiModel"
      • 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

    • EnableNetworkIsolation — (Boolean)

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

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 | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.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",

                    ...

                    "relative/path/custdata-N"

                    ]

                    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

                    ...

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

                    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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about 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:

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

              • Alias name: alias/ExampleAlias

              • Alias name ARN: 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 CreateModel 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 model 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:

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

              • Alias name: alias/ExampleAlias

              • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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

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

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.

Service Reference:

Examples:

Calling the createMonitoringSchedule operation

var params = {
  MonitoringScheduleConfig: { /* required */
    MonitoringJobDefinition: { /* required */
      MonitoringAppSpecification: { /* required */
        ImageUri: 'STRING_VALUE', /* required */
        ContainerArguments: [
          'STRING_VALUE',
          /* more items */
        ],
        ContainerEntrypoint: [
          'STRING_VALUE',
          /* more items */
        ],
        PostAnalyticsProcessorSourceUri: 'STRING_VALUE',
        RecordPreprocessorSourceUri: 'STRING_VALUE'
      },
      MonitoringInputs: [ /* required */
        {
          EndpointInput: { /* required */
            EndpointName: 'STRING_VALUE', /* required */
            LocalPath: 'STRING_VALUE', /* required */
            S3DataDistributionType: FullyReplicated | ShardedByS3Key,
            S3InputMode: Pipe | File
          }
        },
        /* more items */
      ],
      MonitoringOutputConfig: { /* required */
        MonitoringOutputs: [ /* required */
          {
            S3Output: { /* required */
              LocalPath: 'STRING_VALUE', /* required */
              S3Uri: 'STRING_VALUE', /* required */
              S3UploadMode: Continuous | EndOfJob
            }
          },
          /* more items */
        ],
        KmsKeyId: 'STRING_VALUE'
      },
      MonitoringResources: { /* required */
        ClusterConfig: { /* required */
          InstanceCount: 'NUMBER_VALUE', /* required */
          InstanceType: 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.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 | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge, /* required */
          VolumeSizeInGB: 'NUMBER_VALUE', /* required */
          VolumeKmsKeyId: 'STRING_VALUE'
        }
      },
      RoleArn: 'STRING_VALUE', /* required */
      BaselineConfig: {
        ConstraintsResource: {
          S3Uri: 'STRING_VALUE'
        },
        StatisticsResource: {
          S3Uri: 'STRING_VALUE'
        }
      },
      Environment: {
        '<ProcessingEnvironmentKey>': 'STRING_VALUE',
        /* '<ProcessingEnvironmentKey>': ... */
      },
      NetworkConfig: {
        EnableInterContainerTrafficEncryption: true || false,
        EnableNetworkIsolation: true || false,
        VpcConfig: {
          SecurityGroupIds: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          Subnets: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      StoppingCondition: {
        MaxRuntimeInSeconds: 'NUMBER_VALUE' /* required */
      }
    },
    ScheduleConfig: {
      ScheduleExpression: 'STRING_VALUE' /* required */
    }
  },
  MonitoringScheduleName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createMonitoringSchedule(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: {}) —
    • MonitoringScheduleName — (String)

      The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.

    • MonitoringScheduleConfig — (map)

      The configuration object that specifies the monitoring schedule and defines the monitoring job.

      • ScheduleConfig — (map)

        Configures the monitoring schedule.

        • ScheduleExpression — required — (String)

          A cron expression that describes details about the monitoring schedule.

          Currently the only supported cron expressions are:

          • If you want to set the job to start every hour, please use the following:

            Hourly: cron(0 * ? * * *)

          • If you want to start the job daily:

            cron(0 [00-23] ? * * *)

          For example, the following are valid cron expressions:

          • Daily at noon UTC: cron(0 12 ? * * *)

          • Daily at midnight UTC: cron(0 0 ? * * *)

          To support running every 6, 12 hours, the following are also supported:

          cron(0 [00-23]/[01-24] ? * * *)

          For example, the following are valid cron expressions:

          • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

          • Every two hours starting at midnight: cron(0 0/2 ? * * *)

          Note:
          • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
          • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.
      • MonitoringJobDefinition — required — (map)

        Defines the monitoring job.

        • BaselineConfig — (map)

          Baseline configuration used to validate that the data conforms to the specified constraints and statistics

          • ConstraintsResource — (map)

            The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

            • S3Uri — (String)

              The Amazon S3 URI for the constraints resource.

          • StatisticsResource — (map)

            The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

            • S3Uri — (String)

              The Amazon S3 URI for the statistics resource.

        • MonitoringInputs — required — (Array<map>)

          The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

          • EndpointInput — required — (map)

            The endpoint for a monitoring job.

            • EndpointName — required — (String)

              An endpoint in customer's account which has enabled DataCaptureConfig enabled.

            • LocalPath — required — (String)

              Path to the filesystem where the endpoint data is available to the container.

            • S3InputMode — (String)

              Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

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

              Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated

              Possible values include:
              • "FullyReplicated"
              • "ShardedByS3Key"
        • MonitoringOutputConfig — required — (map)

          The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

          • MonitoringOutputs — required — (Array<map>)

            Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

            • S3Output — required — (map)

              The Amazon S3 storage location where the results of a monitoring job are saved.

              • S3Uri — required — (String)

                A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

              • LocalPath — required — (String)

                The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

              • S3UploadMode — (String)

                Whether to upload the results of the monitoring job continuously or after the job completes.

                Possible values include:
                • "Continuous"
                • "EndOfJob"
          • 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.

        • MonitoringResources — required — (map)

          Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

          • ClusterConfig — required — (map)

            The configuration for the cluster resources used to run the processing job.

            • InstanceCount — required — (Integer)

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

            • InstanceType — required — (String)

              The ML compute instance type for the processing job.

              Possible values include:
              • "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.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"
              • "ml.r5.large"
              • "ml.r5.xlarge"
              • "ml.r5.2xlarge"
              • "ml.r5.4xlarge"
              • "ml.r5.8xlarge"
              • "ml.r5.12xlarge"
              • "ml.r5.16xlarge"
              • "ml.r5.24xlarge"
            • VolumeSizeInGB — required — (Integer)

              The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

            • 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 model monitoring job.

        • MonitoringAppSpecification — required — (map)

          Configures the monitoring job to run a specified Docker container image.

          • ImageUri — required — (String)

            The container image to be run by the monitoring job.

          • ContainerEntrypoint — (Array<String>)

            Specifies the entrypoint for a container used to run the monitoring job.

          • ContainerArguments — (Array<String>)

            An array of arguments for the container used to run the monitoring job.

          • RecordPreprocessorSourceUri — (String)

            An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

          • PostAnalyticsProcessorSourceUri — (String)

            An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

        • StoppingCondition — (map)

          Specifies a time limit for how long the monitoring job is allowed to run.

          • MaxRuntimeInSeconds — required — (Integer)

            The maximum runtime allowed in seconds.

        • Environment — (map<String>)

          Sets the environment variables in the Docker container.

        • NetworkConfig — (map)

          Specifies networking options for an monitoring job.

          • EnableInterContainerTrafficEncryption — (Boolean)

            Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

          • EnableNetworkIsolation — (Boolean)

            Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

          • VpcConfig — (map)

            Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

        • RoleArn — required — (String)

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

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

      • MonitoringScheduleArn — (String)

        The Amazon Resource Name (ARN) of the monitoring schedule.

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) permissions 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.

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

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with that Amazon Elastic File System (EFS). This operation can only be called when AuthMode equals IAM.

Service Reference:

Examples:

Calling the createPresignedDomainUrl operation

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

      The domain ID.

    • UserProfileName — (String)

      The name of the UserProfile to sign-in as.

    • SessionExpirationDurationInSeconds — (Integer)

      The session expiration duration in seconds.

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)

        The presigned URL.

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

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

Creates a processing job.

Service Reference:

Examples:

Calling the createProcessingJob operation

var params = {
  AppSpecification: { /* required */
    ImageUri: 'STRING_VALUE', /* required */
    ContainerArguments: [
      'STRING_VALUE',
      /* more items */
    ],
    ContainerEntrypoint: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ProcessingJobName: 'STRING_VALUE', /* required */
  ProcessingResources: { /* required */
    ClusterConfig: { /* required */
      InstanceCount: 'NUMBER_VALUE', /* required */
      InstanceType: 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.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 | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge, /* required */
      VolumeSizeInGB: 'NUMBER_VALUE', /* required */
      VolumeKmsKeyId: 'STRING_VALUE'
    }
  },
  RoleArn: 'STRING_VALUE', /* required */
  Environment: {
    '<ProcessingEnvironmentKey>': 'STRING_VALUE',
    /* '<ProcessingEnvironmentKey>': ... */
  },
  ExperimentConfig: {
    ExperimentName: 'STRING_VALUE',
    TrialComponentDisplayName: 'STRING_VALUE',
    TrialName: 'STRING_VALUE'
  },
  NetworkConfig: {
    EnableInterContainerTrafficEncryption: true || false,
    EnableNetworkIsolation: true || false,
    VpcConfig: {
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Subnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  ProcessingInputs: [
    {
      InputName: 'STRING_VALUE', /* required */
      S3Input: { /* required */
        LocalPath: 'STRING_VALUE', /* required */
        S3DataType: ManifestFile | S3Prefix, /* required */
        S3InputMode: Pipe | File, /* required */
        S3Uri: 'STRING_VALUE', /* required */
        S3CompressionType: None | Gzip,
        S3DataDistributionType: FullyReplicated | ShardedByS3Key
      }
    },
    /* more items */
  ],
  ProcessingOutputConfig: {
    Outputs: [ /* required */
      {
        OutputName: 'STRING_VALUE', /* required */
        S3Output: { /* required */
          LocalPath: 'STRING_VALUE', /* required */
          S3UploadMode: Continuous | EndOfJob, /* required */
          S3Uri: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ],
    KmsKeyId: 'STRING_VALUE'
  },
  StoppingCondition: {
    MaxRuntimeInSeconds: 'NUMBER_VALUE' /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createProcessingJob(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: {}) —
    • ProcessingInputs — (Array<map>)

      For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

      • InputName — required — (String)

        The name of the inputs for the processing job.

      • S3Input — required — (map)

        The S3 inputs for the processing job.

        • S3Uri — required — (String)

          The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.

        • LocalPath — required — (String)

          The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job. LocalPath is an absolute path to the input data.

        • S3DataType — required — (String)

          Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. 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 the processing job.

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

          Whether to use File or Pipe input mode. 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.

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

          Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.

          Possible values include:
          • "FullyReplicated"
          • "ShardedByS3Key"
        • S3CompressionType — (String)

          Whether to use Gzip compression for Amazon S3 storage.

          Possible values include:
          • "None"
          • "Gzip"
    • ProcessingOutputConfig — (map)

      Output configuration for the processing job.

      • Outputs — required — (Array<map>)

        Output configuration information for a processing job.

        • OutputName — required — (String)

          The name for the processing job output.

        • S3Output — required — (map)

          Configuration for processing job outputs in Amazon S3.

          • S3Uri — required — (String)

            A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

          • LocalPath — required — (String)

            The local path to the Amazon S3 bucket where you want Amazon SageMaker to save the results of an processing job. LocalPath is an absolute path to the input data.

          • S3UploadMode — required — (String)

            Whether to upload the results of the processing job continuously or after the job completes.

            Possible values include:
            • "Continuous"
            • "EndOfJob"
      • KmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

    • ProcessingJobName — (String)

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

    • ProcessingResources — (map)

      Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

      • ClusterConfig — required — (map)

        The configuration for the resources in a cluster used to run the processing job.

        • InstanceCount — required — (Integer)

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

        • InstanceType — required — (String)

          The ML compute instance type for the processing job.

          Possible values include:
          • "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.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"
          • "ml.r5.large"
          • "ml.r5.xlarge"
          • "ml.r5.2xlarge"
          • "ml.r5.4xlarge"
          • "ml.r5.8xlarge"
          • "ml.r5.12xlarge"
          • "ml.r5.16xlarge"
          • "ml.r5.24xlarge"
        • VolumeSizeInGB — required — (Integer)

          The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

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

    • StoppingCondition — (map)

      The time limit for how long the processing job is allowed to run.

      • MaxRuntimeInSeconds — required — (Integer)

        Specifies the maximum runtime in seconds.

    • AppSpecification — (map)

      Configures the processing job to run a specified Docker container image.

      • ImageUri — required — (String)

        The container image to be run by the processing job.

      • ContainerEntrypoint — (Array<String>)

        The entrypoint for a container used to run a processing job.

      • ContainerArguments — (Array<String>)

        The arguments for a container used to run a processing job.

    • Environment — (map<String>)

      Sets the environment variables in the Docker container.

    • NetworkConfig — (map)

      Networking options for a processing job.

      • EnableInterContainerTrafficEncryption — (Boolean)

        Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

      • EnableNetworkIsolation — (Boolean)

        Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

      • VpcConfig — (map)

        Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

    • RoleArn — (String)

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

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

    • ExperimentConfig — (map)

      Configuration for the experiment.

      • ExperimentName — (String)

        The name of the experiment.

      • TrialName — (String)

        The name of the trial.

      • TrialComponentDisplayName — (String)

        Display name for the trial component.

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:

      • ProcessingJobArn — (String)

        The Amazon Resource Name (ARN) of the processing job.

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 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',
    EnableSageMakerMetricsTimeSeries: true || false,
    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.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.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 | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.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'
  },
  DebugHookConfig: {
    S3OutputPath: 'STRING_VALUE', /* required */
    CollectionConfigurations: [
      {
        CollectionName: 'STRING_VALUE',
        CollectionParameters: {
          '<ConfigKey>': 'STRING_VALUE',
          /* '<ConfigKey>': ... */
        }
      },
      /* more items */
    ],
    HookParameters: {
      '<ConfigKey>': 'STRING_VALUE',
      /* '<ConfigKey>': ... */
    },
    LocalPath: 'STRING_VALUE'
  },
  DebugRuleConfigurations: [
    {
      RuleConfigurationName: 'STRING_VALUE', /* required */
      RuleEvaluatorImage: 'STRING_VALUE', /* required */
      InstanceType: 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.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 | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge,
      LocalPath: 'STRING_VALUE',
      RuleParameters: {
        '<ConfigKey>': 'STRING_VALUE',
        /* '<ConfigKey>': ... */
      },
      S3OutputPath: 'STRING_VALUE',
      VolumeSizeInGB: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  EnableInterContainerTrafficEncryption: true || false,
  EnableManagedSpotTraining: true || false,
  EnableNetworkIsolation: true || false,
  ExperimentConfig: {
    ExperimentName: 'STRING_VALUE',
    TrialComponentDisplayName: 'STRING_VALUE',
    TrialName: 'STRING_VALUE'
  },
  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 */
  ],
  TensorBoardOutputConfig: {
    S3OutputPath: 'STRING_VALUE', /* required */
    LocalPath: 'STRING_VALUE'
  },
  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.

      • EnableSageMakerMetricsTimeSeries — (Boolean)

        To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

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

              The preceding JSON matches the following s3Uris:

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

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

              "relative/path/custdata-2",

              ...

              "relative/path/custdata-N"

              ]

              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

              ...

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

              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.g4dn.xlarge"
        • "ml.g4dn.2xlarge"
        • "ml.g4dn.4xlarge"
        • "ml.g4dn.8xlarge"
        • "ml.g4dn.12xlarge"
        • "ml.g4dn.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"
        • "ml.c5n.xlarge"
        • "ml.c5n.2xlarge"
        • "ml.c5n.4xlarge"
        • "ml.c5n.9xlarge"
        • "ml.c5n.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.
        Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
      • VolumeKmsKeyId — (String)

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

        Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

        The VolumeKmsKeyId can be in 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

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

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

    • DebugHookConfig — (map)

      Configuration information for the debug hook parameters, collection configuration, and storage paths.

      • LocalPath — (String)

        Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/.

      • S3OutputPath — required — (String)

        Path to Amazon S3 storage location for tensors.

      • HookParameters — (map<String>)

        Configuration information for the debug hook parameters.

      • CollectionConfigurations — (Array<map>)

        Configuration information for tensor collections.

        • CollectionName — (String)

          The name of the tensor collection. The name must be unique relative to other rule configuration names.

        • CollectionParameters — (map<String>)

          Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

    • DebugRuleConfigurations — (Array<map>)

      Configuration information for debugging rules.

      • RuleConfigurationName — required — (String)

        The name of the rule configuration. It must be unique relative to other rule configuration names.

      • LocalPath — (String)

        Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

      • S3OutputPath — (String)

        Path to Amazon S3 storage location for rules.

      • RuleEvaluatorImage — required — (String)

        The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

      • InstanceType — (String)

        The instance type to deploy for a training job.

        Possible values include:
        • "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.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"
        • "ml.r5.large"
        • "ml.r5.xlarge"
        • "ml.r5.2xlarge"
        • "ml.r5.4xlarge"
        • "ml.r5.8xlarge"
        • "ml.r5.12xlarge"
        • "ml.r5.16xlarge"
        • "ml.r5.24xlarge"
      • VolumeSizeInGB — (Integer)

        The size, in GB, of the ML storage volume attached to the processing instance.

      • RuleParameters — (map<String>)

        Runtime configuration for rule container.

    • TensorBoardOutputConfig — (map)

      Configuration of storage locations for TensorBoard output.

      • LocalPath — (String)

        Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

      • S3OutputPath — required — (String)

        Path to Amazon S3 storage location for TensorBoard output.

    • ExperimentConfig — (map)

      Configuration for the experiment.

      • ExperimentName — (String)

        The name of the experiment.

      • TrialName — (String)

        The name of the trial.

      • TrialComponentDisplayName — (String)

        Display name for the trial component.

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, see Batch Transform.

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>': ... */
  },
  ExperimentConfig: {
    ExperimentName: 'STRING_VALUE',
    TrialComponentDisplayName: 'STRING_VALUE',
    TrialName: 'STRING_VALUE'
  },
  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 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 the SplitType property 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",

              ...

              "relative/path/custdata-N"

              ]

              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

              ...

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

              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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about 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:

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

        • Alias name: alias/ExampleAlias

        • Alias name ARN: 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 CreateModel 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 model 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:

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

        • Alias name: alias/ExampleAlias

        • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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

    • ExperimentConfig — (map)

      Configuration for the experiment.

      • ExperimentName — (String)

        The name of the experiment.

      • TrialName — (String)

        The name of the trial.

      • TrialComponentDisplayName — (String)

        Display name for the trial component.

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.

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

Creates an Amazon SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single Amazon SageMaker experiment.

When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

Service Reference:

Examples:

Calling the createTrial operation

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

      The name of the trial. The name must be unique in your AWS account and is not case-sensitive.

    • DisplayName — (String)

      The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

    • ExperimentName — (String)

      The name of the experiment to associate the trial with.

    • Tags — (Array<map>)

      A list of tags to associate with the trial. You can use Search API to search on the tags.

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

      • TrialArn — (String)

        The Amazon Resource Name (ARN) of the trial.

Returns:

  • (AWS.Request) —

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

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

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

Note: CreateTrialComponent can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error.

Service Reference:

Examples:

Calling the createTrialComponent operation

var params = {
  TrialComponentName: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  InputArtifacts: {
    '<TrialComponentKey64>': {
      Value: 'STRING_VALUE', /* required */
      MediaType: 'STRING_VALUE'
    },
    /* '<TrialComponentKey64>': ... */
  },
  OutputArtifacts: {
    '<TrialComponentKey64>': {
      Value: 'STRING_VALUE', /* required */
      MediaType: 'STRING_VALUE'
    },
    /* '<TrialComponentKey64>': ... */
  },
  Parameters: {
    '<TrialComponentKey256>': {
      NumberValue: 'NUMBER_VALUE',
      StringValue: 'STRING_VALUE'
    },
    /* '<TrialComponentKey256>': ... */
  },
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Status: {
    Message: 'STRING_VALUE',
    PrimaryStatus: InProgress | Completed | Failed | Stopping | Stopped
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sagemaker.createTrialComponent(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: {}) —
    • TrialComponentName — (String)

      The name of the component. The name must be unique in your AWS account and is not case-sensitive.

    • DisplayName — (String)

      The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

    • Status — (map)

      The status of the component. States include:

      • InProgress

      • Completed

      • Failed

      • PrimaryStatus — (String)

        The status of the trial component.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Stopping"
        • "Stopped"
      • Message — (String)

        If the component failed, a message describing why.

    • StartTime — (Date)

      When the component started.

    • EndTime — (Date)

      When the component ended.

    • Parameters — (map<map>)

      The hyperparameters for the component.

      • StringValue — (String)

        The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.

      • NumberValue — (Float)

        The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

    • InputArtifacts — (map<map>)

      The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

      • MediaType — (String)

        The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

      • Value — required — (String)

        The location of the artifact.

    • OutputArtifacts — (map<map>)

      The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

      • MediaType — (String)

        The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

      • Value — required — (String)

        The location of the artifact.

    • Tags — (Array<map>)

      A list of tags to associate with the component. You can use Search API to search on the tags.

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

      • TrialComponentArn — (String)

        The Amazon Resource Name (ARN) of the trial component.

Returns:

  • (AWS.Request) —

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

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

Creates a user profile. A user profile represents a single user within a Domain, and is the main way to reference a "person" for the purposes of sharing, reporting and other user-oriented features. This entity is created during on-boarding to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a UserProfile is automatically created.

This entity is the primary holder of settings for an individual user and, through the domain, has a reference to the user's private Amazon Elastic File System (EFS) home directory.

Service Reference:

Examples:

Calling the createUserProfile operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  UserProfileName: 'STRING_VALUE', /* required */
  SingleSignOnUserIdentifier: 'STRING_VALUE',
  SingleSignOnUserValue: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  UserSettings: {
    ExecutionRole: 'STRING_VALUE',
    JupyterServerAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    },
    KernelGatewayAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    },
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    SharingSettings: {
      NotebookOutputOption: Allowed | Disabled,
      S3KmsKeyId: 'STRING_VALUE',
      S3OutputPath: 'STRING_VALUE'
    },
    TensorBoardAppSettings: {
      DefaultResourceSpec: {
        InstanceType: system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge,
        SageMakerImageArn: 'STRING_VALUE'
      }
    }
  }
};
sagemaker.createUserProfile(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: {}) —
    • DomainId — (String)

      The ID of the associated Domain.

    • UserProfileName — (String)

      A name for the UserProfile.

    • SingleSignOnUserIdentifier — (String)

      A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.

    • SingleSignOnUserValue — (String)

      The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.

    • Tags — (Array<map>)

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • UserSettings — (map)

      A collection of settings.

      • ExecutionRole — (String)

        The execution role for the user.

      • SecurityGroups — (Array<String>)

        The security groups.

      • SharingSettings — (map)

        The sharing settings.

        • NotebookOutputOption — (String)

          The notebook output option.

          Possible values include:
          • "Allowed"
          • "Disabled"
        • S3OutputPath — (String)

          The Amazon S3 output path.

        • S3KmsKeyId — (String)

          The AWS Key Management Service encryption key ID.

      • JupyterServerAppSettings — (map)

        The Jupyter server's app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"
      • KernelGatewayAppSettings — (map)

        The kernel gateway app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"
      • TensorBoardAppSettings — (map)

        The TensorBoard app settings.

        • DefaultResourceSpec — (map)

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn — (String)

            The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • InstanceType — (String)

            The instance type.

            Possible values include:
            • "system"
            • "ml.t3.micro"
            • "ml.t3.small"
            • "ml.t3.medium"
            • "ml.t3.large"
            • "ml.t3.xlarge"
            • "ml.t3.2xlarge"
            • "ml.m5.large"
            • "ml.m5.xlarge"
            • "ml.m5.2xlarge"
            • "ml.m5.4xlarge"
            • "ml.m5.8xlarge"
            • "ml.m5.12xlarge"
            • "ml.m5.16xlarge"
            • "ml.m5.24xlarge"
            • "ml.c5.large"
            • "ml.c5.xlarge"
            • "ml.c5.2xlarge"
            • "ml.c5.4xlarge"
            • "ml.c5.9xlarge"
            • "ml.c5.12xlarge"
            • "ml.c5.18xlarge"
            • "ml.c5.24xlarge"
            • "ml.p3.2xlarge"
            • "ml.p3.8xlarge"
            • "ml.p3.16xlarge"
            • "ml.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.16xlarge"

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:

      • UserProfileArn — (String)

        The user profile Amazon Resource Name (ARN).

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.

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

Used to stop and delete an app.

Service Reference:

Examples:

Calling the deleteApp operation

var params = {
  AppName: 'STRING_VALUE', /* required */
  AppType: JupyterServer | KernelGateway | TensorBoard, /* required */
  DomainId: 'STRING_VALUE', /* required */
  UserProfileName: 'STRING_VALUE' /* required */
};
sagemaker.deleteApp(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: {}) —
    • DomainId — (String)

      The domain ID.

    • UserProfileName — (String)

      The user profile name.

    • AppType — (String)

      The type of app.

      Possible values include:
      • "JupyterServer"
      • "KernelGateway"
      • "TensorBoard"
    • AppName — (String)

      The name of the app.

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.

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

Used to delete a domain. Use with caution. If RetentionPolicy is set to Delete, all of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

Service Reference:

Examples:

Calling the deleteDomain operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  RetentionPolicy: {
    HomeEfsFileSystem: Retain | Delete
  }
};
sagemaker.deleteDomain(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: {}) —
    • DomainId — (String)

      The domain ID.

    • RetentionPolicy — (map)

      The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

      • HomeEfsFileSystem — (String)

        The default is Retain, which specifies to keep the data stored on the EFS volume.

        Specify Delete to delete the data stored on the EFS volume.

        Possible values include:
        • "Retain"
        • "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.

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

Deletes an Amazon SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

Service Reference:

Examples:

Calling the deleteExperiment operation

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

      The name of the experiment 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:

      • ExperimentArn — (String)

        The Amazon Resource Name (ARN) of the experiment that is being deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified flow definition.

Service Reference:

Examples:

Calling the deleteFlowDefinition operation

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

      The name of the flow definition you are deleting.

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.

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

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

Service Reference:

Examples:

Calling the deleteMonitoringSchedule operation

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

      The name of the monitoring schedule 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.

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.

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

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

Service Reference:

Examples:

Calling the deleteTrial operation

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

      The name of the trial 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:

      • TrialArn — (String)

        The Amazon Resource Name (ARN) of the trial that is being deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Service Reference:

Examples:

Calling the deleteTrialComponent operation

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

      The name of the component 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:

      • TrialComponentArn — (String)

        The Amazon Resource Name (ARN) of the component is being deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes a user profile.

Service Reference:

Examples:

Calling the deleteUserProfile operation

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

      The domain ID.

    • UserProfileName — (String)

      The user profile name.

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:

                      The preceding JSON matches the following s3Uris:

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

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

                      "relative/path/custdata-2",

                      ...

                      "relative/path/custdata-N"

                      ]

                      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

                      ...

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

                      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.g4dn.xlarge"
                • "ml.g4dn.2xlarge"
                • "ml.g4dn.4xlarge"
                • "ml.g4dn.8xlarge"
                • "ml.g4dn.12xlarge"
                • "ml.g4dn.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"
                • "ml.c5n.xlarge"
                • "ml.c5n.2xlarge"
                • "ml.c5n.4xlarge"
                • "ml.c5n.9xlarge"
                • "ml.c5n.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.
                Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
              • VolumeKmsKeyId — (String)

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

                Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

                The VolumeKmsKeyId can be in 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",

                      ...

                      "relative/path/custdata-N"

                      ]

                      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

                      ...

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

                      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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about 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:

                • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

                • Alias name: alias/ExampleAlias

                • Alias name ARN: 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 CreateModel 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 model 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:

                • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

                • Alias name: alias/ExampleAlias

                • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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

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

Describes the app.

Service Reference:

Examples:

Calling the describeApp operation

var params = {
  AppName: 'STRING_VALUE', /* required */
  AppType: JupyterServer | KernelGateway | TensorBoard, /* required */
  DomainId: 'STRING_VALUE', /* required */
  UserProfileName: 'STRING_VALUE' /* required */
};
sagemaker.describeApp(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: {}) —
    • DomainId — (String)

      The domain ID.

    • UserProfileName — (String)

      The user profile name.

    • AppType — (String)

      The type of app.

      Possible values include:
      • "JupyterServer"
      • "KernelGateway"
      • "TensorBoard"
    • AppName — (String)

      The name of the app.

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:

      • AppArn — (String)

        The app's Amazon Resource Name (ARN).

      • AppType — (String)

        The type of app.

        Possible values include:
        • "JupyterServer"
        • "KernelGateway"
        • "TensorBoard"
      • AppName — (String)

        The name of the app.

      • DomainId — (String)

        The domain ID.

      • UserProfileName — (String)

        The user profile name.

      • Status — (String)

        The status.

        Possible values include:
        • "Deleted"
        • "Deleting"
        • "Failed"
        • "InService"
        • "Pending"
      • LastHealthCheckTimestamp — (Date)

        The timestamp of the last health check.

      • LastUserActivityTimestamp — (Date)

        The timestamp of the last user's activity.

      • CreationTime — (Date)

        The creation time.

      • FailureReason — (String)

        The failure reason.

      • ResourceSpec — (map)

        The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

        • SageMakerImageArn — (String)

          The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

        • InstanceType — (String)

          The instance type.

          Possible values include:
          • "system"
          • "ml.t3.micro"
          • "ml.t3.small"
          • "ml.t3.medium"
          • "ml.t3.large"
          • "ml.t3.xlarge"
          • "ml.t3.2xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.8xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.16xlarge"
          • "ml.m5.24xlarge"
          • "ml.c5.large"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.12xlarge"
          • "ml.c5.18xlarge"
          • "ml.c5.24xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.g4dn.xlarge"
          • "ml.g4dn.2xlarge"
          • "ml.g4dn.4xlarge"
          • "ml.g4dn.8xlarge"
          • "ml.g4dn.12xlarge"
          • "ml.g4dn.16xlarge"

Returns:

  • (AWS.Request) —

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

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

Returns information about an Amazon SageMaker job.

Service Reference:

Examples:

Calling the describeAutoMLJob operation

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

      Request information about a job using that job's unique name.

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:

      • AutoMLJobName — (String)

        Returns the name of a job.

      • AutoMLJobArn — (String)

        Returns the job's ARN.

      • InputDataConfig — (Array<map>)

        Returns the job's input data config.

        • DataSource — required — (map)

          The data source.

          • S3DataSource — required — (map)

            The Amazon S3 location of the input data.

            Note: The input data must be in CSV format and contain at least 1000 rows.
            • S3DataType — required — (String)

              The data type.

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

              The URL to the Amazon S3 data source.

        • CompressionType — (String)

          You can use Gzip or None. The default value is None.

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

          The name of the target variable in supervised learning, a.k.a. 'y'.

      • OutputDataConfig — (map)

        Returns the job's output data config.

        • KmsKeyId — (String)

          The AWS KMS encryption key ID.

        • S3OutputPath — required — (String)

          The Amazon S3 output path. Must be 128 characters or less.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

      • AutoMLJobObjective — (map)

        Returns the job's objective.

        • MetricName — required — (String)

          The name of the metric.

          Possible values include:
          • "Accuracy"
          • "MSE"
          • "F1"
          • "F1macro"
      • ProblemType — (String)

        Returns the job's problem type.

        Possible values include:
        • "BinaryClassification"
        • "MulticlassClassification"
        • "Regression"
      • AutoMLJobConfig — (map)

        Returns the job's config.

        • CompletionCriteria — (map)

          How long a job is allowed to run, or how many candidates a job is allowed to generate.

          • MaxCandidates — (Integer)

            The maximum number of times a training job is allowed to run.

          • MaxRuntimePerTrainingJobInSeconds — (Integer)

            The maximum time, in seconds, a job is allowed to run.

          • MaxAutoMLJobRuntimeInSeconds — (Integer)

            The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.

        • SecurityConfig — (map)

          Security configuration for traffic encryption or Amazon VPC settings.

          • VolumeKmsKeyId — (String)

            The key used to encrypt stored data.

          • EnableInterContainerTrafficEncryption — (Boolean)

            Whether to use traffic encryption between the container layers.

          • VpcConfig — (map)

            VPC configuration.

            • 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

      • CreationTime — (Date)

        Returns the job's creation time.

      • EndTime — (Date)

        Returns the job's end time.

      • LastModifiedTime — (Date)

        Returns the job's last modified time.

      • FailureReason — (String)

        Returns the job's FailureReason.

      • BestCandidate — (map)

        Returns the job's BestCandidate.

        • CandidateName — required — (String)

          The candidate name.

        • FinalAutoMLJobObjectiveMetric — (map)

          The candidate result from a job.

          • Type — (String)

            The metric type used.

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

            The name of the metric.

            Possible values include:
            • "Accuracy"
            • "MSE"
            • "F1"
            • "F1macro"
          • Value — required — (Float)

            The value of the metric.

        • ObjectiveStatus — required — (String)

          The objective status.

          Possible values include:
          • "Succeeded"
          • "Pending"
          • "Failed"
        • CandidateSteps — required — (Array<map>)

          The candidate's steps.

          • CandidateStepType — required — (String)

            Whether the Candidate is at the transform, training, or processing step.

            Possible values include:
            • "AWS::SageMaker::TrainingJob"
            • "AWS::SageMaker::TransformJob"
            • "AWS::SageMaker::ProcessingJob"
          • CandidateStepArn — required — (String)

            The ARN for the Candidate's step.

          • CandidateStepName — required — (String)

            The name for the Candidate's step.

        • CandidateStatus — required — (String)

          The candidate's status.

          Possible values include:
          • "Completed"
          • "InProgress"
          • "Failed"
          • "Stopped"
          • "Stopping"
        • InferenceContainers — (Array<map>)

          The inference containers.

          • Image — required — (String)

            The ECR path of the container. Refer to ContainerDefinition for more details.

          • ModelDataUrl — required — (String)

            The location of the model artifacts. Refer to ContainerDefinition for more details.

          • Environment — (map<String>)

            Environment variables to set in the container. Refer to ContainerDefinition for more details.

        • CreationTime — required — (Date)

          The creation time.

        • EndTime — (Date)

          The end time.

        • LastModifiedTime — required — (Date)

          The last modified time.

        • FailureReason — (String)

          The failure reason.

      • AutoMLJobStatus — (String)

        Returns the job's AutoMLJobStatus.

        Possible values include:
        • "Completed"
        • "InProgress"
        • "Failed"
        • "Stopped"
        • "Stopping"
      • AutoMLJobSecondaryStatus — (String)

        Returns the job's AutoMLJobSecondaryStatus.

        Possible values include:
        • "Starting"
        • "AnalyzingData"
        • "FeatureEngineering"
        • "ModelTuning"
        • "MaxCandidatesReached"
        • "Failed"
        • "Stopped"
        • "MaxAutoMLJobRuntimeReached"
        • "Stopping"
        • "CandidateDefinitionsGenerated"
      • GenerateCandidateDefinitionsOnly — (Boolean)

        Returns the job's output from GenerateCandidateDefinitionsOnly.

      • AutoMLJobArtifacts — (map)

        Returns information on the job's artifacts found in AutoMLJobArtifacts.

        • CandidateDefinitionNotebookLocation — (String)

          The URL to the notebook location.

        • DataExplorationNotebookLocation — (String)

          The URL to the notebook location.

      • ResolvedAttributes — (map)

        This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're auto-inferred values, if not provided by you. If you do provide them, then they'll be the same as provided.

        • AutoMLJobObjective — (map)

          Applies a metric to minimize or maximize for the job's objective.

          • MetricName — required — (String)

            The name of the metric.

            Possible values include:
            • "Accuracy"
            • "MSE"
            • "F1"
            • "F1macro"
        • ProblemType — (String)

          The problem type.

          Possible values include:
          • "BinaryClassification"
          • "MulticlassClassification"
          • "Regression"
        • CompletionCriteria — (map)

          How long a job is allowed to run, or how many candidates a job is allowed to generate.

          • MaxCandidates — (Integer)

            The maximum number of times a training job is allowed to run.

          • MaxRuntimePerTrainingJobInSeconds — (Integer)

            The maximum time, in seconds, a job is allowed to run.

          • MaxAutoMLJobRuntimeInSeconds — (Integer)

            The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.

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]}

          • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

            • Examples for one input:

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

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

            • Examples for two inputs:

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

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

          • 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"
          • "KERAS"
          • "MXNET"
          • "ONNX"
          • "PYTORCH"
          • "XGBOOST"
          • "TFLITE"
      • 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"
          • "ml_inf1"
          • "jetson_tx1"
          • "jetson_tx2"
          • "jetson_nano"
          • "jetson_xavier"
          • "rasp3b"
          • "imx8qm"
          • "deeplens"
          • "rk3399"
          • "rk3288"
          • "aisage"
          • "sbe_c"
          • "qcs605"
          • "qcs603"
          • "sitara_am57x"
          • "amba_cv22"

Returns:

  • (AWS.Request) —

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

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

The desciption of the domain.

Service Reference:

Examples:

Calling the describeDomain operation

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

      The domain ID.

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:

      • DomainArn — (String)

        The domain's Amazon Resource Name (ARN).

      • DomainId — (String)

        The domain ID.

      • DomainName — (String)

        The domain name.

      • HomeEfsFileSystemId — (String)

        The ID of the Amazon Elastic File System (EFS) managed by this Domain.

      • SingleSignOnManagedApplicationInstanceId — (String)

        The SSO managed application instance ID.

      • Status — (String)

        The status.

        Possible values include:
        • "Deleting"
        • "Failed"
        • "InService"
        • "Pending"
      • CreationTime — (Date)

        The creation time.

      • LastModifiedTime — (Date)

        The last modified time.

      • FailureReason — (String)

        The failure reason.

      • AuthMode — (String)

        The domain's authentication mode.

        Possible values include:
        • "SSO"
        • "IAM"
      • DefaultUserSettings — (map)

        Settings which are applied to all UserProfile in this domain, if settings are not explicitly specified in a given UserProfile.

        • ExecutionRole — (String)

          The execution role for the user.

        • SecurityGroups — (Array<String>)

          The security groups.

        • SharingSettings — (map)

          The sharing settings.

          • NotebookOutputOption — (String)

            The notebook output option.

            Possible values include:
            • "Allowed"
            • "Disabled"
          • S3OutputPath — (String)

            The Amazon S3 output path.

          • S3KmsKeyId — (String)

            The AWS Key Management Service encryption key ID.

        • JupyterServerAppSettings — (map)

          The Jupyter server's app settings.

          • DefaultResourceSpec — (map)

            The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • SageMakerImageArn — (String)

              The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • InstanceType — (String)

              The instance type.

              Possible values include:
              • "system"
              • "ml.t3.micro"
              • "ml.t3.small"
              • "ml.t3.medium"
              • "ml.t3.large"
              • "ml.t3.xlarge"
              • "ml.t3.2xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.8xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.16xlarge"
              • "ml.m5.24xlarge"
              • "ml.c5.large"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.12xlarge"
              • "ml.c5.18xlarge"
              • "ml.c5.24xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.g4dn.xlarge"
              • "ml.g4dn.2xlarge"
              • "ml.g4dn.4xlarge"
              • "ml.g4dn.8xlarge"
              • "ml.g4dn.12xlarge"
              • "ml.g4dn.16xlarge"
        • KernelGatewayAppSettings — (map)

          The kernel gateway app settings.

          • DefaultResourceSpec — (map)

            The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • SageMakerImageArn — (String)

              The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • InstanceType — (String)

              The instance type.

              Possible values include:
              • "system"
              • "ml.t3.micro"
              • "ml.t3.small"
              • "ml.t3.medium"
              • "ml.t3.large"
              • "ml.t3.xlarge"
              • "ml.t3.2xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.8xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.16xlarge"
              • "ml.m5.24xlarge"
              • "ml.c5.large"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.12xlarge"
              • "ml.c5.18xlarge"
              • "ml.c5.24xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.g4dn.xlarge"
              • "ml.g4dn.2xlarge"
              • "ml.g4dn.4xlarge"
              • "ml.g4dn.8xlarge"
              • "ml.g4dn.12xlarge"
              • "ml.g4dn.16xlarge"
        • TensorBoardAppSettings — (map)

          The TensorBoard app settings.

          • DefaultResourceSpec — (map)

            The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • SageMakerImageArn — (String)

              The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

            • InstanceType — (String)

              The instance type.

              Possible values include:
              • "system"
              • "ml.t3.micro"
              • "ml.t3.small"
              • "ml.t3.medium"
              • "ml.t3.large"
              • "ml.t3.xlarge"
              • "ml.t3.2xlarge"
              • "ml.m5.large"
              • "ml.m5.xlarge"
              • "ml.m5.2xlarge"
              • "ml.m5.4xlarge"
              • "ml.m5.8xlarge"
              • "ml.m5.12xlarge"
              • "ml.m5.16xlarge"
              • "ml.m5.24xlarge"
              • "ml.c5.large"
              • "ml.c5.xlarge"
              • "ml.c5.2xlarge"
              • "ml.c5.4xlarge"
              • "ml.c5.9xlarge"
              • "ml.c5.12xlarge"
              • "ml.c5.18xlarge"
              • "ml.c5.24xlarge"
              • "ml.p3.2xlarge"
              • "ml.p3.8xlarge"
              • "ml.p3.16xlarge"
              • "ml.g4dn.xlarge"
              • "ml.g4dn.2xlarge"
              • "ml.g4dn.4xlarge"
              • "ml.g4dn.8xlarge"
              • "ml.g4dn.12xlarge"
              • "ml.g4dn.16xlarge"
      • HomeEfsFileSystemKmsKeyId — (String)

        The AWS Key Management Service encryption key ID.

      • SubnetIds — (Array<String>)

        Security setting to limit to a set of subnets.

      • Url — (String)

        The domain's URL.

      • VpcId — (String)

        The ID of the Amazon Virtual Private Cloud.

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.

      • DataCaptureConfig — (map)

        • EnableCapture — required — (Boolean)

        • CaptureStatus — required — (String)

          Possible values include:

          • "Started"
          • "Stopped"
        • CurrentSamplingPercentage — required — (Integer)

        • DestinationS3Uri — required — (String)

        • KmsKeyId — required — (String)

      • 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"
          • "ml.inf1.xlarge"
          • "ml.inf1.2xlarge"
          • "ml.inf1.6xlarge"
          • "ml.inf1.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"
      • DataCaptureConfig — (map)

        • EnableCapture — (Boolean)

        • InitialSamplingPercentage — required — (Integer)

        • DestinationS3Uri — required — (String)

        • KmsKeyId — (String)

        • CaptureOptions — required — (Array<map>)

          • CaptureMode — required — (String)

            Possible values include:

            • "Input"
            • "Output"
        • CaptureContentTypeHeader — (map)

          • CsvContentTypes — (Array<String>)

          • JsonContentTypes — (Array<String>)

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

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

Provides a list of an experiment's properties.

Service Reference:

Examples:

Calling the describeExperiment operation

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

      The name of the experiment 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:

      • ExperimentName — (String)

        The name of the experiment.

      • ExperimentArn — (String)

        The Amazon Resource Name (ARN) of the experiment.

      • DisplayName — (String)

        The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

      • Source — (map)

        The ARN of the source and, optionally, the type.

        • SourceArn — required — (String)

          The Amazon Resource Name (ARN) of the source.

        • SourceType — (String)

          The source type.

      • Description — (String)

        The description of the experiment.

      • CreationTime — (Date)

        When the experiment was created.

      • CreatedBy — (map)

        Who created the experiment.

        • UserProfileArn — (String)

          The Amazon Resource Name (ARN) of the user's profile.

        • UserProfileName — (String)

          The name of the user's profile.

        • DomainId — (String)

          The domain associated with the user.

      • LastModifiedTime — (Date)

        When the experiment was last modified.

      • LastModifiedBy — (map)

        Who last modified the experiment.

        • UserProfileArn — (String)

          The Amazon Resource Name (ARN) of the user's profile.

        • UserProfileName — (String)

          The name of the user's profile.

        • DomainId — (String)

          The domain associated with the user.

Returns:

  • (AWS.Request) —

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

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

Returns information about the specified flow definition.

Service Reference:

Examples:

Calling the describeFlowDefinition operation

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

      The name of the flow definition.

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:

      • FlowDefinitionArn — (String)

        The Amazon Resource Name (ARN) of the flow defintion.

      • FlowDefinitionName — (String)

        The Amazon Resource Name (ARN) of the flow definition.

      • FlowDefinitionStatus — (String)

        The status of the flow definition. Valid values are listed below.

        Possible values include:
        • "Initializing"
        • "Active"
        • "Failed"
        • "Deleting"
      • CreationTime — (Date)

        The timestamp when the flow definition was created.

      • HumanLoopRequestSource — (map)

        Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

        • AwsManagedHumanLoopRequestSource — required — (String)

          Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

          Possible values include:
          • "AWS/Rekognition/DetectModerationLabels/Image/V3"
          • "AWS/Textract/AnalyzeDocument/Forms/V1"
      • HumanLoopActivationConfig — (map)

        An object containing information about what triggers a human review workflow.

        • HumanLoopActivationConditionsConfig — required — (map)

          Container structure for defining under what conditions SageMaker creates a human loop.

          • HumanLoopActivationConditions — required — (String)

            JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

      • HumanLoopConfig — (map)

        An object containing information about who works on the task, the workforce task price, and other task details.

        • WorkteamArn — required — (String)

          Amazon Resource Name (ARN) of a team of workers.

        • HumanTaskUiArn — required — (String)

          The Amazon Resource Name (ARN) of the human task user interface.

        • TaskTitle — required — (String)

          A title for the human worker task.

        • TaskDescription — required — (String)

          A description for the human worker task.

        • TaskCount — required — (Integer)

          The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

        • TaskAvailabilityLifetimeInSeconds — (Integer)

          The length of time that a task remains available for labeling by human workers.

        • TaskTimeLimitInSeconds — (Integer)

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

        • TaskKeywords — (Array<String>)

          Keywords used to describe the task so that workers can discover the task.

        • PublicWorkforceTaskPrice — (map)

          Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

          Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

          • 0.036

          • 0.048

          • 0.060

          • 0.072

          • 0.120

          • 0.240

          • 0.360

          • 0.480

          • 0.600

          • 0.720

          • 0.840

          • 0.960

          • 1.080

          • 1.200

          Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

          • 0.012

          • 0.024

          • 0.036

          • 0.048

          • 0.060

          • 0.072

          • 0.120

          • 0.240

          • 0.360

          • 0.480

          • 0.600

          • 0.720

          • 0.840

          • 0.960

          • 1.080

          • 1.200

          Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

          • 0.840

          • 0.960

          • 1.080

          • 1.200

          Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

          • 2.400

          • 2.280

          • 2.160

          • 2.040

          • 1.920

          • 1.800

          • 1.680

          • 1.560

          • 1.440

          • 1.320

          • 1.200

          • 1.080

          • 0.960

          • 0.840

          • 0.720

          • 0.600

          • 0.480

          • 0.360

          • 0.240

          • 0.120

          • 0.072

          • 0.060

          • 0.048

          • 0.036

          • 0.024

          • 0.012

          Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

          • 1.200

          • 1.080

          • 0.960

          • 0.840

          • 0.720

          • 0.600

          • 0.480

          • 0.360

          • 0.240

          • 0.120

          • 0.072

          • 0.060

          • 0.048

          • 0.036

          • 0.024

          • 0.012

          Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

          • 1.200

          • 1.080

          • 0.960

          • 0.840

          • 0.720

          • 0.600

          • 0.480

          • 0.360

          • 0.240

          • 0.120

          • 0.072

          • 0.060

          • 0.048

          • 0.036

          • 0.024

          • 0.012

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

      • OutputConfig — (map)

        An object containing information about the output file.

        • S3OutputPath — required — (String)

          The Amazon S3 path where the object containing human output will be made available.

        • KmsKeyId — (String)

          The Amazon Key Management Service (KMS) key ID for server-side encryption.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.

      • FailureReason — (String)

Returns:

  • (AWS.Request) —

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

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

Returns information about the requested human task user interface.

Service Reference:

Examples:

Calling the describeHumanTaskUi operation

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

      The name of the human task user interface 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:

      • HumanTaskUiArn — (String)

        The Amazon Resource Name (ARN) of the human task user interface.

      • HumanTaskUiName — (String)

        The name of the human task user interface.

      • CreationTime — (Date)

        The timestamp when the human task user interface was created.

      • UiTemplate — (map)

        Container for user interface template information.

        • Url — (String)

          The URL for the user interface template.

        • ContentSha256 — (String)

          The SHA-256 digest of the contents of the template.

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 strategy, 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

              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.

              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

              Hyperparameter 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"
        • TuningJobCompletionCriteria — (map)

          The tuning job's completion criteria.

          • TargetObjectiveMetricValue — required — (Float)

            The objective metric's value.

      • TrainingJobDefinition — (map)

        The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

        • DefinitionName — (String)

          The job definition name.

        • TuningObjective — (map)

          Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

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

        • HyperParameterRanges — (map)

          Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

          Note: You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
          • 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

              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.

              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

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

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

                  The preceding JSON matches the following s3Uris:

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

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

                  "relative/path/custdata-2",

                  ...

                  "relative/path/custdata-N"

                  ]

                  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

                  ...

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

                  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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

        • 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.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.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"
            • "ml.c5n.xlarge"
            • "ml.c5n.2xlarge"
            • "ml.c5n.4xlarge"
            • "ml.c5n.9xlarge"
            • "ml.c5n.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.
            Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
          • VolumeKmsKeyId — (String)

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

            Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

            The VolumeKmsKeyId can be in 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.

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

      • TrainingJobDefinitions — (Array<map>)

        • DefinitionName — (String)

          The job definition name.

        • TuningObjective — (map)

          Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

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

        • HyperParameterRanges — (map)

          Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

          Note: You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
          • 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

              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.

              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

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

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

                  The preceding JSON matches the following s3Uris:

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

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

                  "relative/path/custdata-2",

                  ...

                  "relative/path/custdata-N"

                  ]

                  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

                  ...

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

                  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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

        • 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.g4dn.xlarge"
            • "ml.g4dn.2xlarge"
            • "ml.g4dn.4xlarge"
            • "ml.g4dn.8xlarge"
            • "ml.g4dn.12xlarge"
            • "ml.g4dn.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"
            • "ml.c5n.xlarge"
            • "ml.c5n.2xlarge"
            • "ml.c5n.4xlarge"
            • "ml.c5n.9xlarge"
            • "ml.c5n.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.
            Note: Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
          • VolumeKmsKeyId — (String)

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

            Note: Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.

            The VolumeKmsKeyId can be in 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.

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

        • TrainingJobDefinitionName — (String)

          The training job definition name.

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

        • TrainingJobDefinitionName — (String)

          The training job definition name.

        • 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. Please note the following label-category limits:

        • Semantic segmentation labeling jobs using automated labeling: 20 labels

        • Box bounding labeling jobs (all): 10 labels

        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-ImageMultiClassMultiLabel

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

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

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

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

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

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

          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-ImageMultiClassMultiLabel

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

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

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

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

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

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

          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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

          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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

          EU Frankfurt (eu-central-1):

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

          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-ImageMultiClassMultiLabel

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

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

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

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

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

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

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

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

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

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

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

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

          • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

          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-ImageMultiClassMultiLabel

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

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

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

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

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

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

        • 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). The default value is 864000 seconds (10 days). 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. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects.

        • 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

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

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

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

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

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

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

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

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

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

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

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

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

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

            • 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

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

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

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

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

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

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

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

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

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

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

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

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

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

            • Named entity recognition - 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

            • Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

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

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

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

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

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

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

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

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

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

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

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

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

            • Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            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 the 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

        • Mode — (String)

          Whether the container hosts a single model or multiple models.

          Possible values include:
          • "SingleModel"
          • "MultiModel"
        • 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 the 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

        • Mode — (String)

          Whether the container hosts a single model or multiple models.

          Possible values include:
          • "SingleModel"
          • "MultiModel"
        • 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

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

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",

                      ...

                      "relative/path/custdata-N"

                      ]

                      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

                      ...

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

                      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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about 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:

                • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

                • Alias name: alias/ExampleAlias

                • Alias name ARN: 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 CreateModel 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 model 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:

                • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

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

                • Alias name: alias/ExampleAlias

                • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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

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

Describes the schedule for a monitoring job.

Service Reference:

Examples:

Calling the describeMonitoringSchedule operation

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

      Name of a previously created monitoring schedule.

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:

      • MonitoringScheduleArn — (String)

        The Amazon Resource Name (ARN) of the monitoring schedule.

      • MonitoringScheduleName — (String)

        Name of the monitoring schedule.

      • MonitoringScheduleStatus — (String)

        The status of an monitoring job.

        Possible values include:
        • "Pending"
        • "Failed"
        • "Scheduled"
        • "Stopped"
      • FailureReason — (String)

        A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

      • CreationTime — (Date)

        The time at which the monitoring job was created.

      • LastModifiedTime — (Date)

        The time at which the monitoring job was last modified.

      • MonitoringScheduleConfig — (map)

        The configuration object that specifies the monitoring schedule and defines the monitoring job.

        • ScheduleConfig — (map)

          Configures the monitoring schedule.

          • ScheduleExpression — required — (String)

            A cron expression that describes details about the monitoring schedule.

            Currently the only supported cron expressions are:

            • If you want to set the job to start every hour, please use the following:

              Hourly: cron(0 * ? * * *)

            • If you want to start the job daily:

              cron(0 [00-23] ? * * *)

            For example, the following are valid cron expressions:

            • Daily at noon UTC: cron(0 12 ? * * *)

            • Daily at midnight UTC: cron(0 0 ? * * *)

            To support running every 6, 12 hours, the following are also supported:

            cron(0 [00-23]/[01-24] ? * * *)

            For example, the following are valid cron expressions:

            • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

            • Every two hours starting at midnight: cron(0 0/2 ? * * *)

            Note:
            • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
            • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.
        • MonitoringJobDefinition — required — (map)

          Defines the monitoring job.

          • BaselineConfig — (map)

            Baseline configuration used to validate that the data conforms to the specified constraints and statistics

            • ConstraintsResource — (map)

              The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

              • S3Uri — (String)

                The Amazon S3 URI for the constraints resource.

            • StatisticsResource — (map)

              The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

              • S3Uri — (String)

                The Amazon S3 URI for the statistics resource.

          • MonitoringInputs — required — (Array<map>)

            The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

            • EndpointInput — required — (map)

              The endpoint for a monitoring job.

              • EndpointName — required — (String)

                An endpoint in customer's account which has enabled DataCaptureConfig enabled.

              • LocalPath — required — (String)

                Path to the filesystem where the endpoint data is available to the container.

              • S3InputMode — (String)

                Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

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

                Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated

                Possible values include:
                • "FullyReplicated"
                • "ShardedByS3Key"
          • MonitoringOutputConfig — required — (map)

            The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

            • MonitoringOutputs — required — (Array<map>)

              Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

              • S3Output — required — (map)

                The Amazon S3 storage location where the results of a monitoring job are saved.

                • S3Uri — required — (String)

                  A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

                • LocalPath — required — (String)

                  The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

                • S3UploadMode — (String)

                  Whether to upload the results of the monitoring job continuously or after the job completes.

                  Possible values include:
                  • "Continuous"
                  • "EndOfJob"
            • 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.

          • MonitoringResources — required — (map)

            Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

            • ClusterConfig — required — (map)

              The configuration for the cluster resources used to run the processing job.

              • InstanceCount — required — (Integer)

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

              • InstanceType — required — (String)

                The ML compute instance type for the processing job.

                Possible values include:
                • "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.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"
                • "ml.r5.large"
                • "ml.r5.xlarge"
                • "ml.r5.2xlarge"
                • "ml.r5.4xlarge"
                • "ml.r5.8xlarge"
                • "ml.r5.12xlarge"
                • "ml.r5.16xlarge"
                • "ml.r5.24xlarge"
              • VolumeSizeInGB — required — (Integer)

                The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

              • 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 model monitoring job.

          • MonitoringAppSpecification — required — (map)

            Configures the monitoring job to run a specified Docker container image.

            • ImageUri — required — (String)

              The container image to be run by the monitoring job.

            • ContainerEntrypoint — (Array<String>)

              Specifies the entrypoint for a container used to run the monitoring job.

            • ContainerArguments — (Array<String>)

              An array of arguments for the container used to run the monitoring job.

            • RecordPreprocessorSourceUri — (String)

              An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

            • PostAnalyticsProcessorSourceUri — (String)

              An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

          • StoppingCondition — (map)

            Specifies a time limit for how long the monitoring job is allowed to run.

            • MaxRuntimeInSeconds — required — (Integer)

              The maximum runtime allowed in seconds.

          • Environment — (map<String>)

            Sets the environment variables in the Docker container.

          • NetworkConfig — (map)

            Specifies networking options for an monitoring job.

            • EnableInterContainerTrafficEncryption — (Boolean)

              Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

            • EnableNetworkIsolation — (Boolean)

              Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

            • VpcConfig — (map)

              Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and 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. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

          • RoleArn — required — (String)

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

      • EndpointName — (String)

        The name of the endpoint for the monitoring job.

      • LastMonitoringExecutionSummary — (map)

        Describes metadata on the last execution to run, if there was one.

        • MonitoringScheduleName — required — (String)

          The name of the monitoring schedule.

        • ScheduledTime — required — (Date)

          The time the monitoring job was scheduled.

        • CreationTime — required — (Date)

          The time at which the monitoring job was created.

        • LastModifiedTime — required — (Date)

          A timestamp that indicates the last time the monitoring job was modified.

        • MonitoringExecutionStatus — required — (String)

          The status of the monitoring job.

          Possible values include:
          • "Pending"
          • "Completed"
          • "CompletedWithViolations"
          • "InProgress"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • ProcessingJobArn — (String)

          The Amazon Resource Name (ARN) of the monitoring job.

        • EndpointName — (String)

          The name of teh endpoint used to run the monitoring job.

        • FailureReason — (String)

          Contains the reason a monitoring job failed, if it failed.

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