2018/06/20 - AWS Elemental MediaLive - 6 new api methods
Changes Update medialive client to latest version
Purchase an offering and create a reservation.
See also: AWS API Documentation
Request Syntax
client.purchase_offering( Count=123, Name='string', OfferingId='string', RequestId='string' )
integer
Number of resources
string
Name for the new reservation
string
[REQUIRED] Offering to purchase, e.g. '87654321'
string
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.This field is autopopulated if not provided.
dict
Response Syntax
{ 'Reservation': { 'Arn': 'string', 'Count': 123, 'CurrencyCode': 'string', 'Duration': 123, 'DurationUnits': 'MONTHS', 'End': 'string', 'FixedPrice': 123.0, 'Name': 'string', 'OfferingDescription': 'string', 'OfferingId': 'string', 'OfferingType': 'NO_UPFRONT', 'Region': 'string', 'ReservationId': 'string', 'ResourceSpecification': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', 'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM' }, 'Start': 'string', 'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED', 'UsagePrice': 123.0 } }
Response Structure
(dict) -- Purchased reservation
Reservation (dict) -- Reserved resources available to use
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
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'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
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'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
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', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
Delete an expired reservation.
See also: AWS API Documentation
Request Syntax
client.delete_reservation( ReservationId='string' )
string
[REQUIRED] Unique reservation ID, e.g. '1234567'
dict
Response Syntax
{ 'Arn': 'string', 'Count': 123, 'CurrencyCode': 'string', 'Duration': 123, 'DurationUnits': 'MONTHS', 'End': 'string', 'FixedPrice': 123.0, 'Name': 'string', 'OfferingDescription': 'string', 'OfferingId': 'string', 'OfferingType': 'NO_UPFRONT', 'Region': 'string', 'ReservationId': 'string', 'ResourceSpecification': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', 'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM' }, 'Start': 'string', 'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED', 'UsagePrice': 123.0 }
Response Structure
(dict) -- Deleted reservation
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
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'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
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'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
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', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
List purchased reservations.
See also: AWS API Documentation
Request Syntax
client.list_reservations( Codec='string', MaxResults=123, MaximumBitrate='string', MaximumFramerate='string', NextToken='string', Resolution='string', ResourceType='string', SpecialFeature='string', VideoQuality='string' )
string
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
integer
Placeholder documentation for MaxResults
string
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
string
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
string
Placeholder documentation for __string
string
Filter by resolution, 'SD', 'HD', or 'UHD'
string
Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'
string
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
string
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
dict
Response Syntax
{ 'NextToken': 'string', 'Reservations': [ { 'Arn': 'string', 'Count': 123, 'CurrencyCode': 'string', 'Duration': 123, 'DurationUnits': 'MONTHS', 'End': 'string', 'FixedPrice': 123.0, 'Name': 'string', 'OfferingDescription': 'string', 'OfferingId': 'string', 'OfferingType': 'NO_UPFRONT', 'Region': 'string', 'ReservationId': 'string', 'ResourceSpecification': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', 'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM' }, 'Start': 'string', 'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED', 'UsagePrice': 123.0 }, ] }
Response Structure
(dict) -- List of reservations
NextToken (string) -- Token to retrieve the next page of results
Reservations (list) -- List of reservations
(dict) -- Reserved resources available to use
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
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'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
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'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
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', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
Get details for a reservation.
See also: AWS API Documentation
Request Syntax
client.describe_reservation( ReservationId='string' )
string
[REQUIRED] Unique reservation ID, e.g. '1234567'
dict
Response Syntax
{ 'Arn': 'string', 'Count': 123, 'CurrencyCode': 'string', 'Duration': 123, 'DurationUnits': 'MONTHS', 'End': 'string', 'FixedPrice': 123.0, 'Name': 'string', 'OfferingDescription': 'string', 'OfferingId': 'string', 'OfferingType': 'NO_UPFRONT', 'Region': 'string', 'ReservationId': 'string', 'ResourceSpecification': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', 'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM' }, 'Start': 'string', 'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED', 'UsagePrice': 123.0 }
Response Structure
(dict) -- Reservation details
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
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'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
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'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
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', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
List offerings available for purchase.
See also: AWS API Documentation
Request Syntax
client.list_offerings( ChannelConfiguration='string', Codec='string', MaxResults=123, MaximumBitrate='string', MaximumFramerate='string', NextToken='string', Resolution='string', ResourceType='string', SpecialFeature='string', VideoQuality='string' )
string
Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
string
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
integer
Placeholder documentation for MaxResults
string
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
string
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
string
Placeholder documentation for __string
string
Filter by resolution, 'SD', 'HD', or 'UHD'
string
Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'
string
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
string
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
dict
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': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', '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
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', 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'
Get details for an offering.
See also: AWS API Documentation
Request Syntax
client.describe_offering( OfferingId='string' )
string
[REQUIRED] Unique offering ID, e.g. '87654321'
dict
Response Syntax
{ 'Arn': 'string', 'CurrencyCode': 'string', 'Duration': 123, 'DurationUnits': 'MONTHS', 'FixedPrice': 123.0, 'OfferingDescription': 'string', 'OfferingId': 'string', 'OfferingType': 'NO_UPFRONT', 'Region': 'string', 'ResourceSpecification': { 'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO', 'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS', 'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS', 'Resolution': 'SD'|'HD'|'UHD', 'ResourceType': 'INPUT'|'OUTPUT'|'CHANNEL', 'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION', 'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM' }, 'UsagePrice': 123.0 }
Response Structure
(dict) -- Offering details
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
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', 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'