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>

  • Method Details

    • 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:

    • 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:

    • jobType

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

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

    • jobTypeAsString

      public final String jobTypeAsString()

      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.

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

    • 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:

    • 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:

    • 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()
      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<CreateImageVersionRequest.Builder,CreateImageVersionRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.