UpdateImage
Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.
Request Syntax
{
"DeleteProperties": [ "string" ],
"Description": "string",
"DisplayName": "string",
"ImageName": "string",
"RoleArn": "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.
- DeleteProperties
-
A list of properties to delete. Only the
DescriptionandDisplayNameproperties can be deleted.Type: Array of strings
Array Members: Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 11.
Pattern:
(^DisplayName$)|(^Description$)Required: No
- Description
-
The new description for the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
.*Required: No
- DisplayName
-
The new display name for the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^\S(.*\S)?$Required: No
- ImageName
-
The name of the image to update.
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 new ARN for the IAM role that enables Amazon SageMaker AI 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: 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
- 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:
