:doc:`MediaLive <../../medialive>` / Paginator / ListOfferings

*************
ListOfferings
*************



.. py:class:: MediaLive.Paginator.ListOfferings

  ::

    
    paginator = client.get_paginator('list_offerings')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MediaLive.Client.list_offerings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/ListOfferings>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ChannelClass='string',
          ChannelConfiguration='string',
          Codec='string',
          Duration='string',
          MaximumBitrate='string',
          MaximumFramerate='string',
          Resolution='string',
          ResourceType='string',
          SpecialFeature='string',
          VideoQuality='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ChannelClass: string
    :param ChannelClass: Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

    
    :type ChannelConfiguration: string
    :param ChannelConfiguration: Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)

    
    :type Codec: string
    :param Codec: Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'

    
    :type Duration: string
    :param Duration: Filter by offering duration, e.g. '12'

    
    :type MaximumBitrate: string
    :param MaximumBitrate: Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

    
    :type MaximumFramerate: string
    :param MaximumFramerate: Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

    
    :type Resolution: string
    :param Resolution: Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'

    
    :type ResourceType: string
    :param ResourceType: Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

    
    :type SpecialFeature: string
    :param SpecialFeature: Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

    
    :type VideoQuality: string
    :param VideoQuality: Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

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

      
      ::

        {
            'Offerings': [
                {
                    'Arn': 'string',
                    'CurrencyCode': 'string',
                    'Duration': 123,
                    'DurationUnits': 'MONTHS',
                    'FixedPrice': 123.0,
                    'OfferingDescription': 'string',
                    'OfferingId': 'string',
                    'OfferingType': 'NO_UPFRONT',
                    'Region': 'string',
                    'ResourceSpecification': {
                        'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
                        'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK'|'AV1',
                        'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
                        'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
                        'Resolution': 'SD'|'HD'|'FHD'|'UHD',
                        'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
                        'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION'|'MGHD'|'MGUHD',
                        'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
                    },
                    'UsagePrice': 123.0
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* List of offerings
        

        - **Offerings** *(list) --* List of offerings
          

          - *(dict) --* Reserved resources available for purchase
            

            - **Arn** *(string) --* Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
            

            - **CurrencyCode** *(string) --* Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
            

            - **Duration** *(integer) --* Lease duration, e.g. '12'
            

            - **DurationUnits** *(string) --* Units for duration, e.g. 'MONTHS'
            

            - **FixedPrice** *(float) --* One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
            

            - **OfferingDescription** *(string) --* Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
            

            - **OfferingId** *(string) --* Unique offering ID, e.g. '87654321'
            

            - **OfferingType** *(string) --* Offering type, e.g. 'NO_UPFRONT'
            

            - **Region** *(string) --* AWS region, e.g. 'us-west-2'
            

            - **ResourceSpecification** *(dict) --* Resource configuration details
              

              - **ChannelClass** *(string) --* Channel class, e.g. 'STANDARD'
              

              - **Codec** *(string) --* Codec, e.g. 'AVC'
              

              - **MaximumBitrate** *(string) --* Maximum bitrate, e.g. 'MAX_20_MBPS'
              

              - **MaximumFramerate** *(string) --* Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
              

              - **Resolution** *(string) --* Resolution, e.g. 'HD'
              

              - **ResourceType** *(string) --* Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
              

              - **SpecialFeature** *(string) --* Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
              

              - **VideoQuality** *(string) --* Video quality, e.g. 'STANDARD' (Outputs only)
          
            

            - **UsagePrice** *(float) --* Recurring usage charge for each reserved resource, e.g. '157.0'
        
      
    