:doc:`Personalize <../../personalize>` / Paginator / ListBatchSegmentJobs

********************
ListBatchSegmentJobs
********************



.. py:class:: Personalize.Paginator.ListBatchSegmentJobs

  ::

    
    paginator = client.get_paginator('list_batch_segment_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Personalize.Client.list_batch_segment_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          solutionVersionArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type solutionVersionArn: string
    :param solutionVersionArn: 

      The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'batchSegmentJobs': [
                {
                    'batchSegmentJobArn': 'string',
                    'jobName': 'string',
                    'status': 'string',
                    'creationDateTime': datetime(2015, 1, 1),
                    'lastUpdatedDateTime': datetime(2015, 1, 1),
                    'failureReason': 'string',
                    'solutionVersionArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **batchSegmentJobs** *(list) --* 

          A list containing information on each job that is returned.

          
          

          - *(dict) --* 

            A truncated version of the `BatchSegmentJob <https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html>`__ datatype. `ListBatchSegmentJobs <https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html>`__ operation returns a list of batch segment job summaries.

            
            

            - **batchSegmentJobArn** *(string) --* 

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

              
            

            - **jobName** *(string) --* 

              The name of the batch segment job.

              
            

            - **status** *(string) --* 

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

               

              
              * PENDING
               
              * IN PROGRESS
               
              * ACTIVE
               
              * CREATE FAILED
              

              
            

            - **creationDateTime** *(datetime) --* 

              The time at which the batch segment job was created.

              
            

            - **lastUpdatedDateTime** *(datetime) --* 

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

              
            

            - **failureReason** *(string) --* 

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

              
            

            - **solutionVersionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    