:doc:`MachineLearning <../../machinelearning>` / Paginator / DescribeBatchPredictions

************************
DescribeBatchPredictions
************************



.. py:class:: MachineLearning.Paginator.DescribeBatchPredictions

  ::

    
    paginator = client.get_paginator('describe_batch_predictions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MachineLearning.Client.describe_batch_predictions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/machinelearning-2014-12-12/DescribeBatchPredictions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          FilterVariable='CreatedAt'|'LastUpdatedAt'|'Status'|'Name'|'IAMUser'|'MLModelId'|'DataSourceId'|'DataURI',
          EQ='string',
          GT='string',
          LT='string',
          GE='string',
          LE='string',
          NE='string',
          Prefix='string',
          SortOrder='asc'|'dsc',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type FilterVariable: string
    :param FilterVariable: 

      Use one of the following variables to filter a list of ``BatchPrediction``:

       

      
      * ``CreatedAt`` - Sets the search criteria to the ``BatchPrediction`` creation date.
       
      * ``Status`` - Sets the search criteria to the ``BatchPrediction`` status.
       
      * ``Name`` - Sets the search criteria to the contents of the ``BatchPrediction``  ``Name``.
       
      * ``IAMUser`` - Sets the search criteria to the user account that invoked the ``BatchPrediction`` creation.
       
      * ``MLModelId`` - Sets the search criteria to the ``MLModel`` used in the ``BatchPrediction``.
       
      * ``DataSourceId`` - Sets the search criteria to the ``DataSource`` used in the ``BatchPrediction``.
       
      * ``DataURI`` - Sets the search criteria to the data file(s) used in the ``BatchPrediction``. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
      

      

    
    :type EQ: string
    :param EQ: 

      The equal to operator. The ``BatchPrediction`` results will have ``FilterVariable`` values that exactly match the value specified with ``EQ``.

      

    
    :type GT: string
    :param GT: 

      The greater than operator. The ``BatchPrediction`` results will have ``FilterVariable`` values that are greater than the value specified with ``GT``.

      

    
    :type LT: string
    :param LT: 

      The less than operator. The ``BatchPrediction`` results will have ``FilterVariable`` values that are less than the value specified with ``LT``.

      

    
    :type GE: string
    :param GE: 

      The greater than or equal to operator. The ``BatchPrediction`` results will have ``FilterVariable`` values that are greater than or equal to the value specified with ``GE``.

      

    
    :type LE: string
    :param LE: 

      The less than or equal to operator. The ``BatchPrediction`` results will have ``FilterVariable`` values that are less than or equal to the value specified with ``LE``.

      

    
    :type NE: string
    :param NE: 

      The not equal to operator. The ``BatchPrediction`` results will have ``FilterVariable`` values not equal to the value specified with ``NE``.

      

    
    :type Prefix: string
    :param Prefix: 

      A string that is found at the beginning of a variable, such as ``Name`` or ``Id``.

       

      For example, a ``Batch Prediction`` operation could have the ``Name`` ``2014-09-09-HolidayGiftMailer``. To search for this ``BatchPrediction``, select ``Name`` for the ``FilterVariable`` and any of the following strings for the ``Prefix``:

       

      
      * 2014-09
       
      * 2014-09-09
       
      * 2014-09-09-Holiday
      

      

    
    :type SortOrder: string
    :param SortOrder: 

      A two-value parameter that determines the sequence of the resulting list of ``MLModel``s.

       

      
      * ``asc`` - Arranges the list in ascending order (A-Z, 0-9).
       
      * ``dsc`` - Arranges the list in descending order (Z-A, 9-0).
      

       

      Results are sorted by ``FilterVariable``.

      

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

      
      ::

        {
            'Results': [
                {
                    'BatchPredictionId': 'string',
                    'MLModelId': 'string',
                    'BatchPredictionDataSourceId': 'string',
                    'InputDataLocationS3': 'string',
                    'CreatedByIamUser': 'string',
                    'CreatedAt': datetime(2015, 1, 1),
                    'LastUpdatedAt': datetime(2015, 1, 1),
                    'Name': 'string',
                    'Status': 'PENDING'|'INPROGRESS'|'FAILED'|'COMPLETED'|'DELETED',
                    'OutputUri': 'string',
                    'Message': 'string',
                    'ComputeTime': 123,
                    'FinishedAt': datetime(2015, 1, 1),
                    'StartedAt': datetime(2015, 1, 1),
                    'TotalRecordCount': 123,
                    'InvalidRecordCount': 123
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of a ``DescribeBatchPredictions`` operation. The content is essentially a list of ``BatchPrediction``s.

        
        

        - **Results** *(list) --* 

          A list of ``BatchPrediction`` objects that meet the search criteria.

          
          

          - *(dict) --* 

            Represents the output of a ``GetBatchPrediction`` operation.

             

            The content consists of the detailed metadata, the status, and the data file information of a ``Batch Prediction``.

            
            

            - **BatchPredictionId** *(string) --* 

              The ID assigned to the ``BatchPrediction`` at creation. This value should be identical to the value of the ``BatchPredictionID`` in the request.

              
            

            - **MLModelId** *(string) --* 

              The ID of the ``MLModel`` that generated predictions for the ``BatchPrediction`` request.

              
            

            - **BatchPredictionDataSourceId** *(string) --* 

              The ID of the ``DataSource`` that points to the group of observations to predict.

              
            

            - **InputDataLocationS3** *(string) --* 

              The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

              
            

            - **CreatedByIamUser** *(string) --* 

              The AWS user account that invoked the ``BatchPrediction``. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

              
            

            - **CreatedAt** *(datetime) --* 

              The time that the ``BatchPrediction`` was created. The time is expressed in epoch time.

              
            

            - **LastUpdatedAt** *(datetime) --* 

              The time of the most recent edit to the ``BatchPrediction``. The time is expressed in epoch time.

              
            

            - **Name** *(string) --* 

              A user-supplied name or description of the ``BatchPrediction``.

              
            

            - **Status** *(string) --* 

              The status of the ``BatchPrediction``. This element can have one of the following values:

               

              
              * ``PENDING`` - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
               
              * ``INPROGRESS`` - The process is underway.
               
              * ``FAILED`` - The request to perform a batch prediction did not run to completion. It is not usable.
               
              * ``COMPLETED`` - The batch prediction process completed successfully.
               
              * ``DELETED`` - The ``BatchPrediction`` is marked as deleted. It is not usable.
              

              
            

            - **OutputUri** *(string) --* 

              The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the ``s3 key`` portion of the ``outputURI`` field: ':', '//', '/./', '/../'.

              
            

            - **Message** *(string) --* 

              A description of the most recent details about processing the batch prediction request.

              
            

            - **ComputeTime** *(integer) --* 

              Long integer type that is a 64-bit signed number.

              
            

            - **FinishedAt** *(datetime) --* 

              A timestamp represented in epoch time.

              
            

            - **StartedAt** *(datetime) --* 

              A timestamp represented in epoch time.

              
            

            - **TotalRecordCount** *(integer) --* 

              Long integer type that is a 64-bit signed number.

              
            

            - **InvalidRecordCount** *(integer) --* 

              Long integer type that is a 64-bit signed number.

              
        
      
    