DescribeImageVersion - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeImageVersion

Describes a version of a SageMaker image.

Request Syntax

{ "Alias": "string", "ImageName": "string", "Version": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Alias

The alias of the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$

Required: No

ImageName

The name of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Required: Yes

Version

The version of the image. If not specified, the latest version is described.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax

{ "BaseImage": "string", "ContainerImage": "string", "CreationTime": number, "FailureReason": "string", "Horovod": boolean, "ImageArn": "string", "ImageVersionArn": "string", "ImageVersionStatus": "string", "JobType": "string", "LastModifiedTime": number, "MLFramework": "string", "Processor": "string", "ProgrammingLang": "string", "ReleaseNotes": "string", "VendorGuidance": "string", "Version": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BaseImage

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .*

ContainerImage

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

CreationTime

When the version was created.

Type: Timestamp

FailureReason

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

Type: String

Length Constraints: Maximum length of 1024.

Horovod

Indicates Horovod compatibility.

Type: Boolean

ImageArn

The ARN of the image the version is based on.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

ImageVersionArn

The ARN of the version.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

ImageVersionStatus

The status of the version.

Type: String

Valid Values: CREATING | CREATED | CREATE_FAILED | DELETING | DELETE_FAILED

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.

Type: String

Valid Values: TRAINING | INFERENCE | NOTEBOOK_KERNEL

LastModifiedTime

When the version was last modified.

Type: Timestamp

MLFramework

The machine learning framework vended in the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

Processor

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

Type: String

Valid Values: CPU | GPU

ProgrammingLang

The supported programming language and its version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

ReleaseNotes

The maintainer description of the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .*

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.

Type: String

Valid Values: NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED

Version

The version number.

Type: Integer

Valid Range: Minimum value of 0.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: