SageMaker / Client / describe_image
describe_image#
- SageMaker.Client.describe_image(**kwargs)#
Describes a SageMaker image.
See also: AWS API Documentation
Request Syntax
response = client.describe_image( ImageName='string' )
- Parameters:
ImageName (string) –
[REQUIRED]
The name of the image to describe.
- Return type:
dict
- Returns:
Response Syntax
{ 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'DisplayName': 'string', 'FailureReason': 'string', 'ImageArn': 'string', 'ImageName': 'string', 'ImageStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1), 'RoleArn': 'string' }
Response Structure
(dict) –
CreationTime (datetime) –
When the image was created.
Description (string) –
The description of the image.
DisplayName (string) –
The name of the image as displayed.
FailureReason (string) –
When a create, update, or delete operation fails, the reason for the failure.
ImageArn (string) –
The ARN of the image.
ImageName (string) –
The name of the image.
ImageStatus (string) –
The status of the image.
LastModifiedTime (datetime) –
When the image was last modified.
RoleArn (string) –
The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
Exceptions
SageMaker.Client.exceptions.ResourceNotFound