:doc:`CostExplorer <../../ce>` / Paginator / ListSavingsPlansPurchaseRecommendationGeneration

************************************************
ListSavingsPlansPurchaseRecommendationGeneration
************************************************



.. py:class:: CostExplorer.Paginator.ListSavingsPlansPurchaseRecommendationGeneration

  ::

    
    paginator = client.get_paginator('list_savings_plans_purchase_recommendation_generation')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CostExplorer.Client.list_savings_plans_purchase_recommendation_generation`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListSavingsPlansPurchaseRecommendationGeneration>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          GenerationStatus='SUCCEEDED'|'PROCESSING'|'FAILED',
          RecommendationIds=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GenerationStatus: string
    :param GenerationStatus: 

      The status of the recommendation generation.

      

    
    :type RecommendationIds: list
    :param RecommendationIds: 

      The IDs for each specific recommendation.

      

    
      - *(string) --* 

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

      
      ::

        {
            'GenerationSummaryList': [
                {
                    'RecommendationId': 'string',
                    'GenerationStatus': 'SUCCEEDED'|'PROCESSING'|'FAILED',
                    'GenerationStartedTime': 'string',
                    'GenerationCompletionTime': 'string',
                    'EstimatedCompletionTime': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **GenerationSummaryList** *(list) --* 

          The list of historical recommendation generations.

          
          

          - *(dict) --* 

            The summary of the Savings Plans recommendation generation.

            
            

            - **RecommendationId** *(string) --* 

              Indicates the ID for this specific recommendation.

              
            

            - **GenerationStatus** *(string) --* 

              Indicates whether the recommendation generation succeeded, is processing, or failed.

              
            

            - **GenerationStartedTime** *(string) --* 

              Indicates the start time of the recommendation generation.

              
            

            - **GenerationCompletionTime** *(string) --* 

              Indicates the completion time of the recommendation generation.

              
            

            - **EstimatedCompletionTime** *(string) --* 

              Indicates the estimated time for when the recommendation generation will complete.

              
        
      
        

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

          A token to resume pagination.

          
    