ListModelCardVersions - Amazon SageMaker
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListModelCardVersions

List existing versions of an Amazon SageMaker Model Card.

Request Syntax

{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "ModelCardName": "string",
   "ModelCardStatus": "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

Only list model card versions that were created after the time specified.

Type: Timestamp

Required: No

CreationTimeBefore

Only list model card versions that were created before the time specified.

Type: Timestamp

Required: No

MaxResults

The maximum number of model card versions to list.

Type: Integer

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

Required: No

ModelCardName

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

Type: String

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

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

Required: Yes

ModelCardStatus

Only list model card versions with the specified approval status.

Type: String

Valid Values: Draft | PendingReview | Approved | Archived

Required: No

NextToken

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Sort listed model card versions by version. Sorts by version by default.

Type: String

Valid Values: Version

Required: No

SortOrder

Sort model card versions by ascending or descending order.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{
   "ModelCardVersionSummaryList": [ 
      { 
         "CreationTime": number,
         "LastModifiedTime": number,
         "ModelCardArn": "string",
         "ModelCardName": "string",
         "ModelCardStatus": "string",
         "ModelCardVersion": 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.

ModelCardVersionSummaryList

The summaries of the listed versions of the model card.

Type: Array of ModelCardVersionSummary objects

NextToken

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

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: