ListModelCards
List existing model cards.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"MaxResults": number,
"ModelCardStatus": "string",
"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
-
Only list model cards that were created after the time specified.
Type: Timestamp
Required: No
- CreationTimeBefore
-
Only list model cards that were created before the time specified.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of model cards to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- ModelCardStatus
-
Only list model cards with the specified approval status.
Type: String
Valid Values:
Draft | PendingReview | Approved | ArchivedRequired: No
- NameContains
-
Only list model cards with names that contain the specified string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- NextToken
-
If the response to a previous
ListModelCardsrequest was truncated, the response includes aNextToken. To retrieve the next set of model cards, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
Sort model cards by either name or creation time. Sorts by creation time by default.
Type: String
Valid Values:
Name | CreationTimeRequired: No
- SortOrder
-
Sort model cards by ascending or descending order.
Type: String
Valid Values:
Ascending | DescendingRequired: No
Response Syntax
{
"ModelCardSummaries": [
{
"CreationTime": number,
"LastModifiedTime": number,
"ModelCardArn": "string",
"ModelCardName": "string",
"ModelCardStatus": "string"
}
],
"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.
- ModelCardSummaries
-
The summaries of the listed model cards.
Type: Array of ModelCardSummary objects
- NextToken
-
If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, 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.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
