ListOfferings

class MediaConnect.Paginator.ListOfferings
paginator = client.get_paginator('list_offerings')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

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.

Return type
dict
Returns
Response Syntax
{
    'Offerings': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            }
        },
    ]
}

Response Structure

  • (dict) -- MediaConnect returned the list of offerings successfully.
    • Offerings (list) -- A list of offerings that are available to this account in the current AWS Region.
      • (dict) -- A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
        • CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
        • Duration (integer) -- The length of time that your reservation would be active.
        • DurationUnits (string) -- The unit of measurement for the duration of the offering.
        • OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription (string) -- A description of the offering.
        • PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
        • PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
        • ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
          • ReservedBitrate (integer) -- The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType (string) -- The type of resource and the unit that is being billed for.