ListImageVersions - Amazon SageMaker Service

ListImageVersions

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "ImageName": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "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 versions created on or after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

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

Type: Timestamp

Required: No

ImageName

The name of the image to list the versions of.

Type: String

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

Pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$

Required: Yes

LastModifiedTimeAfter

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

Type: Timestamp

Required: No

LastModifiedTimeBefore

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

Type: Timestamp

Required: No

MaxResults

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

Type: Integer

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

Required: No

NextToken

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

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 | VERSION

Required: No

SortOrder

The sort order. The default value is DESCENDING.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

{ "ImageVersions": [ { "CreationTime": number, "FailureReason": "string", "ImageArn": "string", "ImageVersionArn": "string", "ImageVersionStatus": "string", "LastModifiedTime": number, "Version": 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.

ImageVersions

A list of versions and their properties.

Type: Array of ImageVersion objects

NextToken

A token for getting the next set of versions, 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.

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: