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("software.amazon.awssdk:codegen") public final class CreateModelRequest extends SageMakerRequest implements ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateModelRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 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()
For responses, this returns true if the service returned a value for the Containers property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.Map<String,SdkField<?>>
sdkFieldNameToField()
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()
For responses, this returns true if the service returned a value for the Containers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContainers()
method.- 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 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:
- 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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
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 interfaceToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateModelRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateModelRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-