Package software.amazon.awssdk.services.sagemaker.model

Class CreateImageVersionRequest

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.CreateImageVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateImageVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	A list of aliases created with the image version.
String	baseImage()	The registry path of the container image to use as the starting point for this version.
static CreateImageVersionRequest.Builder	builder()
String	clientToken()	A unique ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAliases()	For responses, this returns true if the service returned a value for the Aliases property.
int	hashCode()
Boolean	horovod()	Indicates Horovod compatibility.
String	imageName()	The ImageName of the Image to create a version of.
JobType	jobType()	Indicates SageMaker AI job type compatibility.
String	jobTypeAsString()	Indicates SageMaker AI job type compatibility.
String	mlFramework()	The machine learning framework vended in the image version.
Processor	processor()	Indicates CPU or GPU compatibility.
String	processorAsString()	Indicates CPU or GPU compatibility.
String	programmingLang()	The supported programming language and its version.
String	releaseNotes()	The maintainer description of the image version.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateImageVersionRequest.Builder>	serializableBuilderClass()
CreateImageVersionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VendorGuidance	vendorGuidance()	The stability of the image version, specified by the maintainer.
String	vendorGuidanceAsString()	The stability of the image version, specified by the maintainer.

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

baseImage

public final String baseImage()

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

Returns:

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

clientToken

public final String clientToken()

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

Returns:

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

imageName

public final String imageName()

The ImageName of the Image to create a version of.

Returns:

The ImageName of the Image to create a version of.

hasAliases

public final boolean hasAliases()

For responses, this returns true if the service returned a value for the Aliases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

aliases

public final List<String> aliases()

A list of aliases created with the image version.

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 hasAliases() method.

Returns:

A list of aliases created with the image version.

vendorGuidance

public final VendorGuidance vendorGuidance()

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().

Returns:

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

See Also:

VendorGuidance

vendorGuidanceAsString

public final String vendorGuidanceAsString()

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().

Returns:

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

See Also:

VendorGuidance

jobType

public final JobType jobType()

Indicates SageMaker AI job type compatibility.

• TRAINING: The image version is compatible with SageMaker AI training jobs.

• INFERENCE: The image version is compatible with SageMaker AI inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

Indicates SageMaker AI job type compatibility.

• TRAINING: The image version is compatible with SageMaker AI training jobs.

• INFERENCE: The image version is compatible with SageMaker AI inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

See Also:

JobType

jobTypeAsString

public final String jobTypeAsString()

Indicates SageMaker AI job type compatibility.

• TRAINING: The image version is compatible with SageMaker AI training jobs.

• INFERENCE: The image version is compatible with SageMaker AI inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

Indicates SageMaker AI job type compatibility.

• TRAINING: The image version is compatible with SageMaker AI training jobs.

• INFERENCE: The image version is compatible with SageMaker AI inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

See Also:

JobType

mlFramework

public final String mlFramework()

The machine learning framework vended in the image version.

Returns:

The machine learning framework vended in the image version.

programmingLang

public final String programmingLang()

The supported programming language and its version.

Returns:

The supported programming language and its version.

processor

public final Processor processor()

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

If the service returns an enum value that is not available in the current SDK version, processor will return Processor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from processorAsString().

Returns:

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

See Also:

Processor

processorAsString

public final String processorAsString()

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

If the service returns an enum value that is not available in the current SDK version, processor will return Processor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from processorAsString().

Returns:

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

See Also:

Processor

horovod

public final Boolean horovod()

Indicates Horovod compatibility.

Returns:

Indicates Horovod compatibility.

releaseNotes

public final String releaseNotes()

The maintainer description of the image version.

Returns:

The maintainer description of the image version.

toBuilder

public CreateImageVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateImageVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateImageVersionRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo