:doc:`Snowball <../../snowball>` / Paginator / ListLongTermPricing

*******************
ListLongTermPricing
*******************



.. py:class:: Snowball.Paginator.ListLongTermPricing

  ::

    
    paginator = client.get_paginator('list_long_term_pricing')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Snowball.Client.list_long_term_pricing`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListLongTermPricing>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'LongTermPricingEntries': [
                {
                    'LongTermPricingId': 'string',
                    'LongTermPricingEndDate': datetime(2015, 1, 1),
                    'LongTermPricingStartDate': datetime(2015, 1, 1),
                    'LongTermPricingType': 'OneYear'|'ThreeYear'|'OneMonth',
                    'CurrentActiveJob': 'string',
                    'ReplacementJob': 'string',
                    'IsLongTermPricingAutoRenew': True|False,
                    'LongTermPricingStatus': 'string',
                    'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C'|'V3_5S'|'RACK_5U_C',
                    'JobIds': [
                        'string',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **LongTermPricingEntries** *(list) --* 

          Each ``LongTermPricingEntry`` object contains a status, ID, and other information about the ``LongTermPricing`` type.

          
          

          - *(dict) --* 

            Each ``LongTermPricingListEntry`` object contains information about a long-term pricing type.

            
            

            - **LongTermPricingId** *(string) --* 

              The ID of the long-term pricing type for the device.

              
            

            - **LongTermPricingEndDate** *(datetime) --* 

              The end date the long-term pricing contract.

              
            

            - **LongTermPricingStartDate** *(datetime) --* 

              The start date of the long-term pricing contract.

              
            

            - **LongTermPricingType** *(string) --* 

              The type of long-term pricing that was selected for the device.

              
            

            - **CurrentActiveJob** *(string) --* 

              The current active jobs on the device the long-term pricing type.

              
            

            - **ReplacementJob** *(string) --* 

              A new device that replaces a device that is ordered with long-term pricing.

              
            

            - **IsLongTermPricingAutoRenew** *(boolean) --* 

              If set to ``true``, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.

              
            

            - **LongTermPricingStatus** *(string) --* 

              The status of the long-term pricing type.

              
            

            - **SnowballType** *(string) --* 

              The type of Snow Family devices associated with this long-term pricing job.

              
            

            - **JobIds** *(list) --* 

              The IDs of the jobs that are associated with a long-term pricing type.

              
              

              - *(string) --* 
          
        
      
    