You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::CreateModelInput

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

Overview

Note:

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

{
  model_name: "ModelName", # required
  primary_container: {
    container_hostname: "ContainerHostname",
    image: "Image",
    mode: "SingleModel", # accepts SingleModel, MultiModel
    model_data_url: "Url",
    environment: {
      "EnvironmentKey" => "EnvironmentValue",
    },
    model_package_name: "ArnOrName",
  },
  containers: [
    {
      container_hostname: "ContainerHostname",
      image: "Image",
      mode: "SingleModel", # accepts SingleModel, MultiModel
      model_data_url: "Url",
      environment: {
        "EnvironmentKey" => "EnvironmentValue",
      },
      model_package_name: "ArnOrName",
    },
  ],
  execution_role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  enable_network_isolation: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#containersArray<Types::ContainerDefinition>

Specifies the containers in the inference pipeline.

Returns:



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#enable_network_isolationBoolean

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

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

Returns:

  • (Boolean)


2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#execution_role_arnString

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.

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

Returns:

  • (String)


2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#model_nameString

The name of the new model.

Returns:

  • (String)


2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#primary_containerTypes::ContainerDefinition

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.



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

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.

Returns:



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2220

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  include Aws::Structure
end