Skip to content

CreateModelInput

Source code in docs_src/capo_sagemaker/types/create_model_input.py
class CreateModelInput(TypedDict, closed=True):
    model_name: NotRequired["capo_sagemaker.types.model_name.ModelName"]
    """<p>The name of the new model.</p>"""
    primary_container: NotRequired[
        "capo_sagemaker.types.container_definition.ContainerDefinition"
    ]
    """<p>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. </p>"""
    containers: NotRequired[
        "capo_sagemaker.types.container_definition_list.ContainerDefinitionList"
    ]
    """<p>Specifies the containers in the inference pipeline.</p>"""
    inference_execution_config: NotRequired[
        "capo_sagemaker.types.inference_execution_config.InferenceExecutionConfig"
    ]
    """<p>Specifies details of how containers in a multi-container endpoint are called.</p>"""
    execution_role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p> <note> <p>To be able to pass this role to SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</p> </note>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>"""
    vpc_config: NotRequired["capo_sagemaker.types.vpc_config.VpcConfig"]
    """<p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> 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. <code>VpcConfig</code> is used in hosting services and in batch transform. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html">Protect Endpoints by Using an Amazon Virtual Private Cloud</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html">Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud</a>.</p>"""
    enable_network_isolation: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</p>"""

containers instance-attribute

containers: NotRequired[ContainerDefinitionList]

Specifies the containers in the inference pipeline.

enable_network_isolation instance-attribute

enable_network_isolation: NotRequired[Boolean]

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

execution_role_arn instance-attribute

execution_role_arn: NotRequired[RoleArn]

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.

inference_execution_config instance-attribute

inference_execution_config: NotRequired[InferenceExecutionConfig]

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

model_name instance-attribute

model_name: NotRequired[ModelName]

The name of the new model.

primary_container instance-attribute

primary_container: NotRequired[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.

tags instance-attribute

tags: NotRequired[TagList]

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.

vpc_config instance-attribute

vpc_config: NotRequired[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.