list_offerings

list_offerings(**kwargs)

List offerings available for purchase.

See also: AWS API Documentation

Request Syntax

response = client.list_offerings(
    ChannelClass='string',
    ChannelConfiguration='string',
    Codec='string',
    Duration='string',
    MaxResults=123,
    MaximumBitrate='string',
    MaximumFramerate='string',
    NextToken='string',
    Resolution='string',
    ResourceType='string',
    SpecialFeature='string',
    VideoQuality='string'
)
Parameters
  • ChannelClass (string) -- Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
  • ChannelConfiguration (string) -- Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
  • Codec (string) -- Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
  • Duration (string) -- Filter by offering duration, e.g. '12'
  • MaxResults (integer) -- Placeholder documentation for MaxResults
  • MaximumBitrate (string) -- Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
  • MaximumFramerate (string) -- Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
  • NextToken (string) -- Placeholder documentation for __string
  • Resolution (string) -- Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
  • ResourceType (string) -- Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
  • SpecialFeature (string) -- Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
  • VideoQuality (string) -- Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    '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',
                '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
    • NextToken (string) -- Token to retrieve the next page of results
    • 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'

Exceptions

  • MediaLive.Client.exceptions.BadRequestException
  • MediaLive.Client.exceptions.InternalServerErrorException
  • MediaLive.Client.exceptions.ForbiddenException
  • MediaLive.Client.exceptions.BadGatewayException
  • MediaLive.Client.exceptions.GatewayTimeoutException
  • MediaLive.Client.exceptions.TooManyRequestsException