Skip to content

UpdateImageVersionRequest

Source code in docs_src/capo_sagemaker/types/update_image_version_request.py
class UpdateImageVersionRequest(TypedDict, closed=True):
    image_name: NotRequired["capo_sagemaker.types.image_name.ImageName"]
    """<p>The name of the image.</p>"""
    alias: NotRequired[
        "capo_sagemaker.types.sage_maker_image_version_alias.SageMakerImageVersionAlias"
    ]
    """<p>The alias of the image version.</p>"""
    version: NotRequired["capo_sagemaker.types.image_version_number.ImageVersionNumber"]
    """<p>The version of the image.</p>"""
    aliases_to_add: NotRequired[
        "capo_sagemaker.types.sage_maker_image_version_aliases.SageMakerImageVersionAliases"
    ]
    """<p>A list of aliases to add.</p>"""
    aliases_to_delete: NotRequired[
        "capo_sagemaker.types.sage_maker_image_version_aliases.SageMakerImageVersionAliases"
    ]
    """<p>A list of aliases to delete.</p>"""
    vendor_guidance: NotRequired["capo_sagemaker.types.vendor_guidance.VendorGuidance"]
    """<p>The availability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>"""
    job_type: NotRequired["capo_sagemaker.types.job_type.JobType"]
    """<p>Indicates SageMaker AI job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p> </li> </ul>"""
    ml_framework: NotRequired["capo_sagemaker.types.ml_framework.MLFramework"]
    """<p>The machine learning framework vended in the image version.</p>"""
    programming_lang: NotRequired[
        "capo_sagemaker.types.programming_lang.ProgrammingLang"
    ]
    """<p>The supported programming language and its version.</p>"""
    processor: NotRequired["capo_sagemaker.types.processor.Processor"]
    """<p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>"""
    horovod: NotRequired["capo_sagemaker.types.horovod.Horovod"]
    """<p>Indicates Horovod compatibility.</p>"""
    release_notes: NotRequired["capo_sagemaker.types.release_notes.ReleaseNotes"]
    """<p>The maintainer description of the image version.</p>"""

alias instance-attribute

alias: NotRequired[SageMakerImageVersionAlias]

The alias of the image version.

aliases_to_add instance-attribute

aliases_to_add: NotRequired[SageMakerImageVersionAliases]

A list of aliases to add.

aliases_to_delete instance-attribute

aliases_to_delete: NotRequired[SageMakerImageVersionAliases]

A list of aliases to delete.

horovod instance-attribute

horovod: NotRequired[Horovod]

Indicates Horovod compatibility.

image_name instance-attribute

image_name: NotRequired[ImageName]

The name of the image.

job_type instance-attribute

job_type: NotRequired[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.

ml_framework instance-attribute

ml_framework: NotRequired[MLFramework]

The machine learning framework vended in the image version.

processor instance-attribute

processor: NotRequired[Processor]

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

programming_lang instance-attribute

programming_lang: NotRequired[ProgrammingLang]

The supported programming language and its version.

release_notes instance-attribute

release_notes: NotRequired[ReleaseNotes]

The maintainer description of the image version.

vendor_guidance instance-attribute

vendor_guidance: NotRequired[VendorGuidance]

The availability 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.

version instance-attribute

version: NotRequired[ImageVersionNumber]

The version of the image.