ListImages - Amazon SageMaker Service

ListImages

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "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.

CreationTimeAfter

A filter that returns only images created on or after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only images created on or before the specified time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

A filter that returns only images modified on or after the specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

A filter that returns only images modified on or before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of images to return in the response. The default value is 10.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A filter that returns only images whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9\-.]+$

Required: No

NextToken

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The property used to sort results. The default value is CREATION_TIME.

Type: String

Valid Values: CREATION_TIME | LAST_MODIFIED_TIME | IMAGE_NAME

Required: No

SortOrder

The sort order. The default value is DESCENDING.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

{ "Images": [ { "CreationTime": number, "Description": "string", "DisplayName": "string", "FailureReason": "string", "ImageArn": "string", "ImageName": "string", "ImageStatus": "string", "LastModifiedTime": number } ], "NextToken": "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.

Images

A list of images and their properties.

Type: Array of Image objects

NextToken

A token for getting the next set of images, if there are any.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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

See Also

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