Paws::SageMaker::CreateTrainingJob - Arguments for method CreateTrainingJob on Paws::SageMaker


This class represents the parameters used for calling the method CreateTrainingJob on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method CreateTrainingJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTrainingJob.


    my $api.sagemaker = Paws->service('SageMaker');
    my $CreateTrainingJobResponse = $api . sagemaker->CreateTrainingJob(
      AlgorithmSpecification => {
        TrainingInputMode => 'Pipe',           # values: Pipe, File
        AlgorithmName     => 'MyArnOrName',    # min: 1, max: 170; OPTIONAL
        MetricDefinitions => [
            Name  => 'MyMetricName',           # min: 1, max: 255
            Regex => 'MyMetricRegex',          # min: 1, max: 500

        ],                                     # max: 20; OPTIONAL
        TrainingImage => 'MyAlgorithmImage',   # max: 255; OPTIONAL
      OutputDataConfig => {
        S3OutputPath => 'MyS3Uri',             # max: 1024
        KmsKeyId     => 'MyKmsKeyId',          # max: 2048; OPTIONAL
      ResourceConfig => {
        InstanceCount => 1,                    # min: 1
        InstanceType  => 'ml.m4.xlarge'
        , # values: ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge
        VolumeSizeInGB => 1,               # min: 1
        VolumeKmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
      RoleArn           => 'MyRoleArn',
      StoppingCondition => {
        MaxRuntimeInSeconds => 1,          # min: 1; OPTIONAL
      TrainingJobName                       => 'MyTrainingJobName',
      EnableInterContainerTrafficEncryption => 1,                     # OPTIONAL
      EnableNetworkIsolation                => 1,                     # OPTIONAL
      HyperParameters                       => {
        'MyParameterKey' => 'MyParameterValue', # key: max: 256, value: max: 256
      },    # OPTIONAL
      InputDataConfig => [
          ChannelName => 'MyChannelName',    # min: 1, max: 64
          DataSource  => {
            S3DataSource => {
              S3DataType => 'ManifestFile'
              ,    # values: ManifestFile, S3Prefix, AugmentedManifestFile
              S3Uri          => 'MyS3Uri',    # max: 1024
              AttributeNames => [
                'MyAttributeName', ...        # min: 1, max: 256
              ],                              # max: 16; OPTIONAL
              S3DataDistributionType => 'FullyReplicated'
              ,    # values: FullyReplicated, ShardedByS3Key; OPTIONAL

          CompressionType => 'None',             # values: None, Gzip; OPTIONAL
          ContentType     => 'MyContentType',    # max: 256; OPTIONAL
          InputMode       => 'Pipe',             # values: Pipe, File
          RecordWrapperType => 'None',    # values: None, RecordIO; OPTIONAL
          ShuffleConfig     => {
            Seed => 1,

          },                              # OPTIONAL
      ],                                  # OPTIONAL
      Tags => [
          Key   => 'MyTagKey',            # min: 1, max: 128
          Value => 'MyTagValue',          # max: 256

      ],                                  # OPTIONAL
      VpcConfig => {
        SecurityGroupIds => [
          'MySecurityGroupId', ...        # max: 32
        ],                                # min: 1, max: 5
        Subnets => [
          'MySubnetId', ...               # max: 32
        ],                                # min: 1, max: 16

      },    # OPTIONAL

    # Results:
    my $TrainingJobArn = $CreateTrainingJobResponse->TrainingJobArn;

    # Returns a L<Paws::SageMaker::CreateTrainingJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see


REQUIRED AlgorithmSpecification => Paws::SageMaker::AlgorithmSpecification

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 (

EnableInterContainerTrafficEncryption => Bool

To encrypt all communications between ML compute instances in distributed training, choose True,. Encryption provides greater security for distributed training, but training can take longer because of additional communications between ML compute instances.

EnableNetworkIsolation => Bool

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.

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

HyperParameters => Paws::SageMaker::HyperParameters

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.

InputDataConfig => ArrayRef[Paws::SageMaker::Channel]

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

REQUIRED OutputDataConfig => Paws::SageMaker::OutputDataConfig

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

REQUIRED ResourceConfig => Paws::SageMaker::ResourceConfig

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.

REQUIRED RoleArn => Str

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 (

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

REQUIRED StoppingCondition => Paws::SageMaker::StoppingCondition

Sets a duration for training. Use this parameter 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 might use this 120-second window to save the model artifacts.

When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job. This intermediate data is a valid model artifact. You can use it to create a model using the CreateModel API.

Tags => ArrayRef[Paws::SageMaker::Tag]

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

REQUIRED TrainingJobName => Str

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

VpcConfig => Paws::SageMaker::VpcConfig

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 (


This class forms part of Paws, documenting arguments for method CreateTrainingJob in Paws::SageMaker


The source code is located here:

Please report bugs to: