SageMaker / Paginator / ListAIBenchmarkJobs

ListAIBenchmarkJobs

class SageMaker.Paginator.ListAIBenchmarkJobs

paginator = client.get_paginator('list_ai_benchmark_jobs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    NameContains='string',
    StatusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• NameContains (string) – A string in the job name. This filter returns only jobs whose name contains the specified string.

• StatusEquals (string) – A filter that returns only benchmark jobs with the specified status.

• CreationTimeAfter (datetime) – A filter that returns only jobs created after the specified time.

• CreationTimeBefore (datetime) – A filter that returns only jobs created before the specified time.

• SortBy (string) – The field to sort results by. The default is CreationTime.

• SortOrder (string) – The sort order for results. The default is Descending.

• 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

{
    'AIBenchmarkJobs': [
        {
            'AIBenchmarkJobName': 'string',
            'AIBenchmarkJobArn': 'string',
            'AIBenchmarkJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'CreationTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'AIWorkloadConfigName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AIBenchmarkJobs (list) –

    An array of AIBenchmarkJobSummary objects, one for each benchmark job that matches the specified filters.

    • (dict) –

      Summary information about an AI benchmark job.

      • AIBenchmarkJobName (string) –

        The name of the benchmark job.

      • AIBenchmarkJobArn (string) –

        The Amazon Resource Name (ARN) of the benchmark job.

      • AIBenchmarkJobStatus (string) –

        The status of the benchmark job.

      • CreationTime (datetime) –

        A timestamp that indicates when the benchmark job was created.

      • EndTime (datetime) –

        A timestamp that indicates when the benchmark job completed.

      • AIWorkloadConfigName (string) –

        The name of the AI workload configuration used by the benchmark job.