Skip to content

DescribeImageVersionResponse

Source code in docs_src/capo_sagemaker/types/describe_image_version_response.py
class DescribeImageVersionResponse(TypedDict, closed=True):
    base_image: NotRequired["capo_sagemaker.types.image_base_image.ImageBaseImage"]
    """<p>The registry path of the container image on which this image version is based.</p>"""
    container_image: NotRequired[
        "capo_sagemaker.types.image_container_image.ImageContainerImage"
    ]
    """<p>The registry path of the container image that contains this image version.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the version was created.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>When a create or delete operation fails, the reason for the failure.</p>"""
    image_arn: NotRequired["capo_sagemaker.types.image_arn.ImageArn"]
    """<p>The ARN of the image the version is based on.</p>"""
    image_version_arn: NotRequired[
        "capo_sagemaker.types.image_version_arn.ImageVersionArn"
    ]
    """<p>The ARN of the version.</p>"""
    image_version_status: NotRequired[
        "capo_sagemaker.types.image_version_status.ImageVersionStatus"
    ]
    """<p>The status of the version.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the version was last modified.</p>"""
    version: NotRequired["capo_sagemaker.types.image_version_number.ImageVersionNumber"]
    """<p>The version number.</p>"""
    vendor_guidance: NotRequired["capo_sagemaker.types.vendor_guidance.VendorGuidance"]
    """<p>The stability 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>"""

base_image instance-attribute

base_image: NotRequired[ImageBaseImage]

The registry path of the container image on which this image version is based.

container_image instance-attribute

container_image: NotRequired[ImageContainerImage]

The registry path of the container image that contains this image version.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

When the version was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

When a create or delete operation fails, the reason for the failure.

horovod instance-attribute

horovod: NotRequired[Horovod]

Indicates Horovod compatibility.

image_arn instance-attribute

image_arn: NotRequired[ImageArn]

The ARN of the image the version is based on.

image_version_arn instance-attribute

image_version_arn: NotRequired[ImageVersionArn]

The ARN of the version.

image_version_status instance-attribute

image_version_status: NotRequired[ImageVersionStatus]

The status of the version.

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.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

When the version was last modified.

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

version instance-attribute

version: NotRequired[ImageVersionNumber]

The version number.