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: "ContainerImage",
    image_config: {
      repository_access_mode: "Platform", # required, accepts Platform, Vpc
      repository_auth_config: {
        repository_credentials_provider_arn: "RepositoryCredentialsProviderArn", # required
      },
    },
    mode: "SingleModel", # accepts SingleModel, MultiModel
    model_data_url: "Url",
    environment: {
      "EnvironmentKey" => "EnvironmentValue",
    },
    model_package_name: "VersionedArnOrName",
    inference_specification_name: "InferenceSpecificationName",
    multi_model_config: {
      model_cache_setting: "Enabled", # accepts Enabled, Disabled
    },
  },
  containers: [
    {
      container_hostname: "ContainerHostname",
      image: "ContainerImage",
      image_config: {
        repository_access_mode: "Platform", # required, accepts Platform, Vpc
        repository_auth_config: {
          repository_credentials_provider_arn: "RepositoryCredentialsProviderArn", # required
        },
      },
      mode: "SingleModel", # accepts SingleModel, MultiModel
      model_data_url: "Url",
      environment: {
        "EnvironmentKey" => "EnvironmentValue",
      },
      model_package_name: "VersionedArnOrName",
      inference_specification_name: "InferenceSpecificationName",
      multi_model_config: {
        model_cache_setting: "Enabled", # accepts Enabled, Disabled
      },
    },
  ],
  inference_execution_config: {
    mode: "Serial", # required, accepts Serial, Direct
  },
  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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#containersArray<Types::ContainerDefinition>

Specifies the containers in the inference pipeline.

Returns:



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :inference_execution_config,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  SENSITIVE = []
  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.

Returns:

  • (Boolean)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

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

#execution_role_arnString

The Amazon Resource Name (ARN) of the IAM role that 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 SageMaker Roles.

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

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

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

#inference_execution_configTypes::InferenceExecutionConfig

Specifies details of how containers in a multi-container endpoint are called.



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

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

#model_nameString

The name of the new model.

Returns:

  • (String)


8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :inference_execution_config,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  SENSITIVE = []
  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.



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

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

#tagsArray<Types::Tag>

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Returns:



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

class CreateModelInput < Struct.new(
  :model_name,
  :primary_container,
  :containers,
  :inference_execution_config,
  :execution_role_arn,
  :tags,
  :vpc_config,
  :enable_network_isolation)
  SENSITIVE = []
  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:



8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8200

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