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

Image

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

Contents

CreationTime

When the image was created.

Type: Timestamp

Required: Yes

Description

The description of the image.

Type: String

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

Pattern: .*

Required: No

DisplayName

The name of the image as displayed.

Type: String

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

Pattern: ^\S(.*\S)?$

Required: No

FailureReason

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

Type: String

Length Constraints: Maximum length of 1024.

Required: No

ImageArn

The Amazon Resource Name (ARN) of the image.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

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

ImageStatus

The status of the image.

Type: String

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

Required: Yes

LastModifiedTime

When the image was last modified.

Type: Timestamp

Required: Yes

See Also

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