:doc:`DeviceFarm <../../devicefarm>` / Paginator / GetOfferingStatus

*****************
GetOfferingStatus
*****************



.. py:class:: DeviceFarm.Paginator.GetOfferingStatus

  ::

    
    paginator = client.get_paginator('get_offering_status')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DeviceFarm.Client.get_offering_status`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/GetOfferingStatus>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 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.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'current': {
                'string': {
                    'type': 'PURCHASE'|'RENEW'|'SYSTEM',
                    'offering': {
                        'id': 'string',
                        'description': 'string',
                        'type': 'RECURRING',
                        'platform': 'ANDROID'|'IOS',
                        'recurringCharges': [
                            {
                                'cost': {
                                    'amount': 123.0,
                                    'currencyCode': 'USD'
                                },
                                'frequency': 'MONTHLY'
                            },
                        ]
                    },
                    'quantity': 123,
                    'effectiveOn': datetime(2015, 1, 1)
                }
            },
            'nextPeriod': {
                'string': {
                    'type': 'PURCHASE'|'RENEW'|'SYSTEM',
                    'offering': {
                        'id': 'string',
                        'description': 'string',
                        'type': 'RECURRING',
                        'platform': 'ANDROID'|'IOS',
                        'recurringCharges': [
                            {
                                'cost': {
                                    'amount': 123.0,
                                    'currencyCode': 'USD'
                                },
                                'frequency': 'MONTHLY'
                            },
                        ]
                    },
                    'quantity': 123,
                    'effectiveOn': datetime(2015, 1, 1)
                }
            },
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Returns the status result for a device offering.

        
        

        - **current** *(dict) --* 

          When specified, gets the offering status for the current period.

          
          

          - *(string) --* 
            

            - *(dict) --* 

              The status of the offering.

              
              

              - **type** *(string) --* 

                The type specified for the offering status.

                
              

              - **offering** *(dict) --* 

                Represents the metadata of an offering status.

                
                

                - **id** *(string) --* 

                  The ID that corresponds to a device offering.

                  
                

                - **description** *(string) --* 

                  A string that describes the offering.

                  
                

                - **type** *(string) --* 

                  The type of offering (for example, ``RECURRING``) for a device.

                  
                

                - **platform** *(string) --* 

                  The platform of the device (for example, ``ANDROID`` or ``IOS``).

                  
                

                - **recurringCharges** *(list) --* 

                  Specifies whether there are recurring charges for the offering.

                  
                  

                  - *(dict) --* 

                    Specifies whether charges for devices are recurring.

                    
                    

                    - **cost** *(dict) --* 

                      The cost of the recurring charge.

                      
                      

                      - **amount** *(float) --* 

                        The numerical amount of an offering or transaction.

                        
                      

                      - **currencyCode** *(string) --* 

                        The currency code of a monetary amount. For example, ``USD`` means U.S. dollars.

                        
                  
                    

                    - **frequency** *(string) --* 

                      The frequency in which charges recur.

                      
                
              
            
              

              - **quantity** *(integer) --* 

                The number of available devices in the offering.

                
              

              - **effectiveOn** *(datetime) --* 

                The date on which the offering is effective.

                
          
      
    
        

        - **nextPeriod** *(dict) --* 

          When specified, gets the offering status for the next period.

          
          

          - *(string) --* 
            

            - *(dict) --* 

              The status of the offering.

              
              

              - **type** *(string) --* 

                The type specified for the offering status.

                
              

              - **offering** *(dict) --* 

                Represents the metadata of an offering status.

                
                

                - **id** *(string) --* 

                  The ID that corresponds to a device offering.

                  
                

                - **description** *(string) --* 

                  A string that describes the offering.

                  
                

                - **type** *(string) --* 

                  The type of offering (for example, ``RECURRING``) for a device.

                  
                

                - **platform** *(string) --* 

                  The platform of the device (for example, ``ANDROID`` or ``IOS``).

                  
                

                - **recurringCharges** *(list) --* 

                  Specifies whether there are recurring charges for the offering.

                  
                  

                  - *(dict) --* 

                    Specifies whether charges for devices are recurring.

                    
                    

                    - **cost** *(dict) --* 

                      The cost of the recurring charge.

                      
                      

                      - **amount** *(float) --* 

                        The numerical amount of an offering or transaction.

                        
                      

                      - **currencyCode** *(string) --* 

                        The currency code of a monetary amount. For example, ``USD`` means U.S. dollars.

                        
                  
                    

                    - **frequency** *(string) --* 

                      The frequency in which charges recur.

                      
                
              
            
              

              - **quantity** *(integer) --* 

                The number of available devices in the offering.

                
              

              - **effectiveOn** *(datetime) --* 

                The date on which the offering is effective.

                
          
      
    
        

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

          A token to resume pagination.

          
    