SageMaker / Paginator / ListModelCardExportJobs

ListModelCardExportJobs#

class SageMaker.Paginator.ListModelCardExportJobs#
paginator = client.get_paginator('list_model_card_export_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SageMaker.Client.list_model_card_export_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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