software.amazon.awssdk.services.sagemaker.model

Class CreateModelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateModelRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateModelRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateModelRequest.Builder	builder()
List<ContainerDefinition>	containers() Specifies the containers in the inference pipeline.
Boolean	enableNetworkIsolation() Isolates the model container.
boolean	equals(Object obj)
String	executionRoleArn() 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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	modelName() The name of the new model.
ContainerDefinition	primaryContainer() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateModelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateModelRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VpcConfig	vpcConfig() A VpcConfig object that specifies the VPC that you want your model to connect to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

modelName

public String modelName()

The name of the new model.

Returns:

The name of the new model.

primaryContainer

public ContainerDefinition primaryContainer()

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:

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.

containers

public List<ContainerDefinition> containers()

Specifies the containers in the inference pipeline.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specifies the containers in the inference pipeline.

executionRoleArn

public String executionRoleArn()

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:

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.

tags

public List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

vpcConfig

public VpcConfig 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:

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.

enableNetworkIsolation

public Boolean enableNetworkIsolation()

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:

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.

toBuilder

public CreateModelRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static CreateModelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateModelRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.