SageMaker / Client / describe_image_version

describe_image_version#

SageMaker.Client.describe_image_version(**kwargs)#

Describes a version of a SageMaker AI image.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_version(
    ImageName='string',
    Version=123,
    Alias='string'
)
Parameters:

  • ImageName (string) –

    [REQUIRED]

    The name of the image.

  • Version (integer) – The version of the image. If not specified, the latest version is described.

  • Alias (string) – The alias of the image version.

Return type:

dict

Returns:

Response Syntax

{
    'BaseImage': 'string',
    'ContainerImage': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'ImageArn': 'string',
    'ImageVersionArn': 'string',
    'ImageVersionStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'Version': 123,
    'VendorGuidance': 'NOT_PROVIDED'|'STABLE'|'TO_BE_ARCHIVED'|'ARCHIVED',
    'JobType': 'TRAINING'|'INFERENCE'|'NOTEBOOK_KERNEL',
    'MLFramework': 'string',
    'ProgrammingLang': 'string',
    'Processor': 'CPU'|'GPU',
    'Horovod': True|False,
    'ReleaseNotes': 'string'
}

Response Structure

  • (dict) –

    • BaseImage (string) –

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

    • ContainerImage (string) –

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

    • CreationTime (datetime) –

      When the version was created.

    • FailureReason (string) –

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

    • ImageArn (string) –

      The ARN of the image the version is based on.

    • ImageVersionArn (string) –

      The ARN of the version.

    • ImageVersionStatus (string) –

      The status of the version.

    • LastModifiedTime (datetime) –

      When the version was last modified.

    • Version (integer) –

      The version number.

    • VendorGuidance (string) –

      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.

    • JobType (string) –

      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.

    • MLFramework (string) –

      The machine learning framework vended in the image version.

    • ProgrammingLang (string) –

      The supported programming language and its version.

    • Processor (string) –

      Indicates CPU or GPU compatibility.

      • CPU: The image version is compatible with CPU.

      • GPU: The image version is compatible with GPU.

    • Horovod (boolean) –

      Indicates Horovod compatibility.

    • ReleaseNotes (string) –

      The maintainer description of the image version.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound