:doc:`ForecastService <../../forecast>` / Paginator / ListForecasts

*************
ListForecasts
*************



.. py:class:: ForecastService.Paginator.ListForecasts

  ::

    
    paginator = client.get_paginator('list_forecasts')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ForecastService.Client.list_forecasts`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Key': 'string',
                  'Value': 'string',
                  'Condition': 'IS'|'IS_NOT'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      An array of filters. For each filter, you provide a condition and a match statement. The condition is either ``IS`` or ``IS_NOT``, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

       

      **Filter properties**

       

      
      * ``Condition`` - The condition to apply. Valid values are ``IS`` and ``IS_NOT``. To include the forecasts that match the statement, specify ``IS``. To exclude matching forecasts, specify ``IS_NOT``.
       
      * ``Key`` - The name of the parameter to filter on. Valid values are ``DatasetGroupArn``, ``PredictorArn``, and ``Status``.
       
      * ``Value`` - The value to match.
      

       

      For example, to list all forecasts whose status is not ACTIVE, you would specify:

       

      ``"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]``

      

    
      - *(dict) --* 

        Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either ``IS`` or ``IS_NOT``, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

        

      
        - **Key** *(string) --* **[REQUIRED]** 

          The name of the parameter to filter on.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The value to match.

          

        
        - **Condition** *(string) --* **[REQUIRED]** 

          The condition to apply. To include the objects that match the statement, specify ``IS``. To exclude matching objects, specify ``IS_NOT``.

          

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

      
      ::

        {
            'Forecasts': [
                {
                    'ForecastArn': 'string',
                    'ForecastName': 'string',
                    'PredictorArn': 'string',
                    'CreatedUsingAutoPredictor': True|False,
                    'DatasetGroupArn': 'string',
                    'Status': 'string',
                    'Message': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModificationTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Forecasts** *(list) --* 

          An array of objects that summarize each forecast's properties.

          
          

          - *(dict) --* 

            Provides a summary of the forecast properties used in the  ListForecasts operation. To get the complete set of properties, call the  DescribeForecast operation, and provide the ``ForecastArn`` that is listed in the summary.

            
            

            - **ForecastArn** *(string) --* 

              The ARN of the forecast.

              
            

            - **ForecastName** *(string) --* 

              The name of the forecast.

              
            

            - **PredictorArn** *(string) --* 

              The ARN of the predictor used to generate the forecast.

              
            

            - **CreatedUsingAutoPredictor** *(boolean) --* 

              Whether the Forecast was created from an AutoPredictor.

              
            

            - **DatasetGroupArn** *(string) --* 

              The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

              
            

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

              The status of the forecast. States include:

               

              
              * ``ACTIVE``
               
              * ``CREATE_PENDING``, ``CREATE_IN_PROGRESS``, ``CREATE_FAILED``
               
              * ``CREATE_STOPPING``, ``CREATE_STOPPED``
               
              * ``DELETE_PENDING``, ``DELETE_IN_PROGRESS``, ``DELETE_FAILED``
              

               

              .. note::

                

                The ``Status`` of the forecast must be ``ACTIVE`` before you can query or export the forecast.

                

              
            

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

              If an error occurred, an informational message about the error.

              
            

            - **CreationTime** *(datetime) --* 

              When the forecast creation task was created.

              
            

            - **LastModificationTime** *(datetime) --* 

              The last time the resource was modified. The timestamp depends on the status of the job:

               

              
              * ``CREATE_PENDING`` - The ``CreationTime``.
               
              * ``CREATE_IN_PROGRESS`` - The current timestamp.
               
              * ``CREATE_STOPPING`` - The current timestamp.
               
              * ``CREATE_STOPPED`` - When the job stopped.
               
              * ``ACTIVE`` or ``CREATE_FAILED`` - When the job finished or failed.
              

              
        
      
    