com.amazonaws.services.sagemaker.model

Class CreateImageVersionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateImageVersionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateImageVersionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateImageVersionRequest()

Method Summary

Modifier and Type	Method and Description
CreateImageVersionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAliases() A list of aliases created with the image version.
String	getBaseImage() The registry path of the container image to use as the starting point for this version.
String	getClientToken() A unique ID.
Boolean	getHorovod() Indicates Horovod compatibility.
String	getImageName() The ImageName of the Image to create a version of.
String	getJobType() Indicates SageMaker job type compatibility.
String	getMLFramework() The machine learning framework vended in the image version.
String	getProcessor() Indicates CPU or GPU compatibility.
String	getProgrammingLang() The supported programming language and its version.
String	getReleaseNotes() The maintainer description of the image version.
String	getVendorGuidance() The stability of the image version, specified by the maintainer.
int	hashCode()
Boolean	isHorovod() Indicates Horovod compatibility.
void	setAliases(Collection<String> aliases) A list of aliases created with the image version.
void	setBaseImage(String baseImage) The registry path of the container image to use as the starting point for this version.
void	setClientToken(String clientToken) A unique ID.
void	setHorovod(Boolean horovod) Indicates Horovod compatibility.
void	setImageName(String imageName) The ImageName of the Image to create a version of.
void	setJobType(String jobType) Indicates SageMaker job type compatibility.
void	setMLFramework(String mLFramework) The machine learning framework vended in the image version.
void	setProcessor(String processor) Indicates CPU or GPU compatibility.
void	setProgrammingLang(String programmingLang) The supported programming language and its version.
void	setReleaseNotes(String releaseNotes) The maintainer description of the image version.
void	setVendorGuidance(String vendorGuidance) The stability of the image version, specified by the maintainer.
String	toString() Returns a string representation of this object.
CreateImageVersionRequest	withAliases(Collection<String> aliases) A list of aliases created with the image version.
CreateImageVersionRequest	withAliases(String... aliases) A list of aliases created with the image version.
CreateImageVersionRequest	withBaseImage(String baseImage) The registry path of the container image to use as the starting point for this version.
CreateImageVersionRequest	withClientToken(String clientToken) A unique ID.
CreateImageVersionRequest	withHorovod(Boolean horovod) Indicates Horovod compatibility.
CreateImageVersionRequest	withImageName(String imageName) The ImageName of the Image to create a version of.
CreateImageVersionRequest	withJobType(JobType jobType) Indicates SageMaker job type compatibility.
CreateImageVersionRequest	withJobType(String jobType) Indicates SageMaker job type compatibility.
CreateImageVersionRequest	withMLFramework(String mLFramework) The machine learning framework vended in the image version.
CreateImageVersionRequest	withProcessor(Processor processor) Indicates CPU or GPU compatibility.
CreateImageVersionRequest	withProcessor(String processor) Indicates CPU or GPU compatibility.
CreateImageVersionRequest	withProgrammingLang(String programmingLang) The supported programming language and its version.
CreateImageVersionRequest	withReleaseNotes(String releaseNotes) The maintainer description of the image version.
CreateImageVersionRequest	withVendorGuidance(String vendorGuidance) The stability of the image version, specified by the maintainer.
CreateImageVersionRequest	withVendorGuidance(VendorGuidance vendorGuidance) The stability of the image version, specified by the maintainer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateImageVersionRequest

public CreateImageVersionRequest()

Method Detail

setBaseImage

public void setBaseImage(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]>

Parameters:

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]>

getBaseImage

public String getBaseImage()

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]>

withBaseImage

public CreateImageVersionRequest withBaseImage(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]>

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateImageVersionRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setImageName

public void setImageName(String imageName)

The ImageName of the Image to create a version of.

Parameters:

imageName - The ImageName of the Image to create a version of.

getImageName

public String getImageName()

The ImageName of the Image to create a version of.

Returns:

The ImageName of the Image to create a version of.

withImageName

public CreateImageVersionRequest withImageName(String imageName)

The ImageName of the Image to create a version of.

Parameters:

imageName - The ImageName of the Image to create a version of.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAliases

public List<String> getAliases()

A list of aliases created with the image version.

Returns:

A list of aliases created with the image version.

setAliases

public void setAliases(Collection<String> aliases)

A list of aliases created with the image version.

Parameters:

aliases - A list of aliases created with the image version.

withAliases

public CreateImageVersionRequest withAliases(String... aliases)

A list of aliases created with the image version.

NOTE: This method appends the values to the existing list (if any). Use setAliases(java.util.Collection) or withAliases(java.util.Collection) if you want to override the existing values.

Parameters:

aliases - A list of aliases created with the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAliases

public CreateImageVersionRequest withAliases(Collection<String> aliases)

A list of aliases created with the image version.

Parameters:

aliases - A list of aliases created with the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVendorGuidance

public void setVendorGuidance(String 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.

Parameters:

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.

See Also:

VendorGuidance

getVendorGuidance

public String getVendorGuidance()

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.

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

withVendorGuidance

public CreateImageVersionRequest withVendorGuidance(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance

withVendorGuidance

public CreateImageVersionRequest withVendorGuidance(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance

setJobType

public void setJobType(String jobType)

Indicates SageMaker job type compatibility.

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

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

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

Parameters:

jobType - Indicates SageMaker job type compatibility.

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

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

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

See Also:

JobType

getJobType

public String getJobType()

Indicates SageMaker job type compatibility.

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

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

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

Returns:

Indicates SageMaker job type compatibility.

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

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

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

See Also:

JobType

withJobType

public CreateImageVersionRequest withJobType(String jobType)

Indicates SageMaker job type compatibility.

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

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

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

Parameters:

jobType - Indicates SageMaker job type compatibility.

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

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType

withJobType

public CreateImageVersionRequest withJobType(JobType jobType)

Indicates SageMaker job type compatibility.

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

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

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

Parameters:

jobType - Indicates SageMaker job type compatibility.

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

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType

setMLFramework

public void setMLFramework(String mLFramework)

The machine learning framework vended in the image version.

Parameters:

mLFramework - The machine learning framework vended in the image version.

getMLFramework

public String getMLFramework()

The machine learning framework vended in the image version.

Returns:

The machine learning framework vended in the image version.

withMLFramework

public CreateImageVersionRequest withMLFramework(String mLFramework)

The machine learning framework vended in the image version.

Parameters:

mLFramework - The machine learning framework vended in the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProgrammingLang

public void setProgrammingLang(String programmingLang)

The supported programming language and its version.

Parameters:

programmingLang - The supported programming language and its version.

getProgrammingLang

public String getProgrammingLang()

The supported programming language and its version.

Returns:

The supported programming language and its version.

withProgrammingLang

public CreateImageVersionRequest withProgrammingLang(String programmingLang)

The supported programming language and its version.

Parameters:

programmingLang - The supported programming language and its version.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProcessor

public void setProcessor(String processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

See Also:

Processor

getProcessor

public String getProcessor()

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

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

withProcessor

public CreateImageVersionRequest withProcessor(String processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Processor

withProcessor

public CreateImageVersionRequest withProcessor(Processor processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Processor

setHorovod

public void setHorovod(Boolean horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility.

getHorovod

public Boolean getHorovod()

Indicates Horovod compatibility.

Returns:

Indicates Horovod compatibility.

withHorovod

public CreateImageVersionRequest withHorovod(Boolean horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility.

Returns:

Returns a reference to this object so that method calls can be chained together.

isHorovod

public Boolean isHorovod()

Indicates Horovod compatibility.

Returns:

Indicates Horovod compatibility.

setReleaseNotes

public void setReleaseNotes(String releaseNotes)

The maintainer description of the image version.

Parameters:

releaseNotes - The maintainer description of the image version.

getReleaseNotes

public String getReleaseNotes()

The maintainer description of the image version.

Returns:

The maintainer description of the image version.

withReleaseNotes

public CreateImageVersionRequest withReleaseNotes(String releaseNotes)

The maintainer description of the image version.

Parameters:

releaseNotes - The maintainer description of the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateImageVersionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()