SageMaker / Client / list_model_card_export_jobs

list_model_card_export_jobs#

SageMaker.Client.list_model_card_export_jobs(**kwargs)#

List the export jobs for the Amazon SageMaker Model Card.

See also: AWS API Documentation

Request Syntax

response = client.list_model_card_export_jobs(
    ModelCardName='string',
    ModelCardVersion=123,
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    ModelCardExportJobNameContains='string',
    StatusEquals='InProgress'|'Completed'|'Failed',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ModelCardName (string) –

    [REQUIRED]

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

  • ModelCardVersion (integer) – List export jobs for the model card with the specified version.

  • CreationTimeAfter (datetime) – Only list model card export jobs that were created after the time specified.

  • CreationTimeBefore (datetime) – Only list model card export jobs that were created before the time specified.

  • ModelCardExportJobNameContains (string) – Only list model card export jobs with names that contain the specified string.

  • StatusEquals (string) – Only list model card export jobs with the specified status.

  • SortBy (string) – Sort model card export jobs by either name or creation time. Sorts by creation time by default.

  • SortOrder (string) – Sort model card export jobs by ascending or descending order.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of model card export jobs to list.

Return type:

dict

Returns:

Response Syntax

{
    'ModelCardExportJobSummaries': [
        {
            'ModelCardExportJobName': 'string',
            'ModelCardExportJobArn': 'string',
            'Status': 'InProgress'|'Completed'|'Failed',
            'ModelCardName': 'string',
            'ModelCardVersion': 123,
            'CreatedAt': datetime(2015, 1, 1),
            'LastModifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ModelCardExportJobSummaries (list) –

      The summaries of the listed model card export jobs.

      • (dict) –

        The summary of the Amazon SageMaker Model Card export job.

        • ModelCardExportJobName (string) –

          The name of the model card export job.

        • ModelCardExportJobArn (string) –

          The Amazon Resource Name (ARN) of the model card export job.

        • Status (string) –

          The completion status of the model card export job.

        • ModelCardName (string) –

          The name of the model card that the export job exports.

        • ModelCardVersion (integer) –

          The version of the model card that the export job exports.

        • CreatedAt (datetime) –

          The date and time that the model card export job was created.

        • LastModifiedAt (datetime) –

          The date and time that the model card export job was last modified..

    • NextToken (string) –

      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.