Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListModelCardExportJobs

List the export jobs for the Amazon SageMaker Model Card.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "ModelCardExportJobNameContains": "string",
   "ModelCardName": "string",
   "ModelCardVersion": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StatusEquals": "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 export jobs that were created after the time specified.

Type: Timestamp

Required: No

CreationTimeBefore

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

Type: Timestamp

Required: No

MaxResults

The maximum number of model card export jobs to list.

Type: Integer

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

Required: No

ModelCardExportJobNameContains

Only list model card export jobs 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

ModelCardName

List export jobs for the model card with the specified name.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

ModelCardVersion

List export jobs for the model card with the specified version.

Type: Integer

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

Sort model card export jobs by ascending or descending order.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

Only list model card export jobs with the specified status.

Type: String

Valid Values: InProgress | Completed | Failed

Required: No

Response Syntax


{
   "ModelCardExportJobSummaries": [ 
      { 
         "CreatedAt": number,
         "LastModifiedAt": number,
         "ModelCardExportJobArn": "string",
         "ModelCardExportJobName": "string",
         "ModelCardName": "string",
         "ModelCardVersion": number,
         "Status": "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.

ModelCardExportJobSummaries

The summaries of the listed model card export jobs.

Type: Array of ModelCardExportJobSummary objects

NextToken

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, 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.