Class: Aws::SageMaker::Types::CreateAutoMLJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass CreateAutoMLJobRequest data as a hash:

{
  auto_ml_job_name: "AutoMLJobName", # required
  input_data_config: [ # required
    {
      data_source: { # required
        s3_data_source: { # required
          s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
          s3_uri: "S3Uri", # required
        },
      },
      compression_type: "None", # accepts None, Gzip
      target_attribute_name: "TargetAttributeName", # required
    },
  ],
  output_data_config: { # required
    kms_key_id: "KmsKeyId",
    s3_output_path: "S3Uri", # required
  },
  problem_type: "BinaryClassification", # accepts BinaryClassification, MulticlassClassification, Regression
  auto_ml_job_objective: {
    metric_name: "Accuracy", # required, accepts Accuracy, MSE, F1, F1macro
  },
  auto_ml_job_config: {
    completion_criteria: {
      max_candidates: 1,
      max_runtime_per_training_job_in_seconds: 1,
      max_auto_ml_job_runtime_in_seconds: 1,
    },
    security_config: {
      volume_kms_key_id: "KmsKeyId",
      enable_inter_container_traffic_encryption: false,
      vpc_config: {
        security_group_ids: ["SecurityGroupId"], # required
        subnets: ["SubnetId"], # required
      },
    },
  },
  role_arn: "RoleArn", # required
  generate_candidate_definitions_only: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_ml_job_config ⇒ Types::AutoMLJobConfig

Contains CompletionCriteria and SecurityConfig.

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#auto_ml_job_name ⇒ String

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

Returns:

  • (String) 


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#auto_ml_job_objective ⇒ Types::AutoMLJobObjective

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.

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#generate_candidate_definitions_only ⇒ Boolean

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

Returns:

  • (Boolean) 


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#input_data_config ⇒ Array<Types::AutoMLChannel>

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

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#output_data_config ⇒ Types::AutoMLOutputDataConfig

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

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#problem_type ⇒ String

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

Returns:

  • (String) 


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 2333

class CreateAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :input_data_config,
  :output_data_config,
  :problem_type,
  :auto_ml_job_objective,
  :auto_ml_job_config,
  :role_arn,
  :generate_candidate_definitions_only,
  :tags)
  include Aws::Structure
end