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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#containers ⇒ Array<Types::ContainerDefinition>

Specifies the containers in the inference pipeline.

Returns:



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#enable_network_isolation ⇒ Boolean

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

<note markdown=“1”> The Semantic Segmentation built-in algorithm does not support network isolation.

</note>

Returns:

  • (Boolean) 


3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#execution_role_arn ⇒ 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 markdown=“1”> To be able to pass this role to Amazon SageMaker, the caller of this API must have the ‘iam:PassRole` permission.

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html

Returns:

  • (String) 


3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#model_name ⇒ String

The name of the new model.

Returns:

  • (String) 


3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#primary_container ⇒ Types::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.

Returns:



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#tags ⇒ Array<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*.

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what

Returns:



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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

#vpc_config ⇒ Types::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].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html [3]: docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html

Returns:



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 3618

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