DescribeImageVersion - Amazon SageMaker Service

DescribeImageVersion

Describes a version of a SageMaker image.

Request Syntax

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

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])*$

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", "ImageArn": "string", "ImageVersionArn": "string", "ImageVersionStatus": "string", "LastModifiedTime": number, "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.

ImageArn

The Amazon Resource Name (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

LastModifiedTime

When the version was last modified.

Type: Timestamp

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 AWS SDKs, see the following: