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)
boolean	equalsBySdkFields(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)
boolean	hasContainers() Returns true if the Containers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
InferenceExecutionConfig	inferenceExecutionConfig() Specifies details of how containers in a multi-container endpoint are called.
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()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

modelName

public final String modelName()

The name of the new model.

Returns:

The name of the new model.

primaryContainer

public final 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.

hasContainers

public final boolean hasContainers()

Returns true if the Containers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

containers

public final List<ContainerDefinition> containers()

Specifies the containers in the inference pipeline.

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

You can use hasContainers() to see if a value was sent in this field.

Returns:

Specifies the containers in the inference pipeline.

inferenceExecutionConfig

public final InferenceExecutionConfig inferenceExecutionConfig()

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

Returns:

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

executionRoleArn

public final 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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

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

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

You can use hasTags() to see if a value was sent in this field.

Returns:

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

vpcConfig

public final 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 final Boolean enableNetworkIsolation()

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

Returns:

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

toBuilder

public CreateModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateModelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo