Bedrock / Paginator / ListEvaluationJobs

ListEvaluationJobs

class Bedrock.Paginator.ListEvaluationJobs

paginator = client.get_paginator('list_evaluation_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Bedrock.Client.list_evaluation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    nameContains='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• creationTimeAfter (datetime) – A filter that includes model evaluation jobs created after the time specified.

• creationTimeBefore (datetime) – A filter that includes model evaluation jobs created prior to the time specified.

• statusEquals (string) – Only return jobs where the status condition is met.

• nameContains (string) – Query parameter string for model evaluation job names.

• sortBy (string) – Allows you to sort model evaluation jobs by when they were created.

• sortOrder (string) – How you want the order of jobs sorted.

• 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

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobName': 'string',
            'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'creationTime': datetime(2015, 1, 1),
            'jobType': 'Human'|'Automated',
            'evaluationTaskTypes': [
                'Summarization'|'Classification'|'QuestionAndAnswer'|'Generation'|'Custom',
            ],
            'modelIdentifiers': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • jobSummaries (list) –

    A summary of the model evaluation jobs.

    • (dict) –

      A summary of the model evaluation job.

      • jobArn (string) –

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

      • jobName (string) –

        The name of the model evaluation job.

      • status (string) –

        The current status of the model evaluation job.

      • creationTime (datetime) –

        When the model evaluation job was created.

      • jobType (string) –

        The type, either human or automatic, of model evaluation job.

      • evaluationTaskTypes (list) –

        What task type was used in the model evaluation job.

        • (string) –

      • modelIdentifiers (list) –

        The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.