Personalize / Paginator / ListBatchInferenceJobs


class Personalize.Paginator.ListBatchInferenceJobs#
paginator = client.get_paginator('list_batch_inference_jobs')

Creates an iterator that will paginate through responses from Personalize.Client.list_batch_inference_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • solutionVersionArn (string) – The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

  • 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:



Response Syntax

    'batchInferenceJobs': [
            'batchInferenceJobArn': 'string',
            'jobName': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string',
            'solutionVersionArn': 'string',
            'batchInferenceJobMode': 'BATCH_INFERENCE'|'THEME_GENERATION'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • batchInferenceJobs (list) –

      A list containing information on each job that is returned.

      • (dict) –

        A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

        • batchInferenceJobArn (string) –

          The Amazon Resource Name (ARN) of the batch inference job.

        • jobName (string) –

          The name of the batch inference job.

        • status (string) –

          The status of the batch inference job. The status is one of the following values:

          • PENDING

          • IN PROGRESS

          • ACTIVE

          • CREATE FAILED

        • creationDateTime (datetime) –

          The time at which the batch inference job was created.

        • lastUpdatedDateTime (datetime) –

          The time at which the batch inference job was last updated.

        • failureReason (string) –

          If the batch inference job failed, the reason for the failure.

        • solutionVersionArn (string) –

          The ARN of the solution version used by the batch inference job.

        • batchInferenceJobMode (string) –

          The job’s mode.

    • NextToken (string) –

      A token to resume pagination.