DescribeImage
Describes a SageMaker AI image.
Request Syntax
{
"ImageName": "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.
- ImageName
-
The name of the image to describe.
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
Response Syntax
{
"CreationTime": number,
"Description": "string",
"DisplayName": "string",
"FailureReason": "string",
"ImageArn": "string",
"ImageName": "string",
"ImageStatus": "string",
"LastModifiedTime": number,
"RoleArn": "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.
- CreationTime
-
When the image was created.
Type: Timestamp
- Description
-
The description of the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
.* - DisplayName
-
The name of the image as displayed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^\S(.*\S)?$ - FailureReason
-
When a create, update, or delete operation fails, the reason for the failure.
Type: String
Length Constraints: Maximum length of 1024.
- 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])*$ - 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}$ - ImageStatus
-
The status of the image.
Type: String
Valid Values:
CREATING | CREATED | CREATE_FAILED | UPDATING | UPDATE_FAILED | DELETING | DELETE_FAILED - LastModifiedTime
-
When the image was last modified.
Type: Timestamp
- RoleArn
-
The ARN of 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+=,.@\-_/]+$
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:
