Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateImage

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

Request Syntax


{
   "Description": "string",
   "DisplayName": "string",
   "ImageName": "string",
   "RoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

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.

Description

The description of the image.

Type: String

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

Pattern: .*

Required: No

DisplayName

The display name of the image. If not provided, ImageName is displayed.

Type: String

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

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

Required: No

ImageName

The name of the image. Must be unique to your account.

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

RoleArn

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes

Tags

A list of tags to apply to the image.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


{
   "ImageArn": "string"
}

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.

ImageArn

The ARN of the image.

Type: String

Length Constraints: Maximum length of 256.

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

Errors

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

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400