2020/09/30 - AWS MediaConnect - 5 new api methods
Changes Update mediaconnect client to latest version
Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
See also: AWS API Documentation
Request Syntax
client.purchase_offering(
OfferingArn='string',
ReservationName='string',
Start='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the offering.
string
[REQUIRED] The name that you want to use for the reservation.
string
[REQUIRED] The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.
dict
Response Syntax
{
'Reservation': {
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
}
}
Response Structure
(dict) -- AWS Elemental MediaConnect purchased offering successfully.
Reservation (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
ReservationState (string) -- The status of your reservation.
ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in 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.
Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.
Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).
See also: AWS API Documentation
Request Syntax
client.list_reservations(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
string
The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
dict
Response Syntax
{
'NextToken': 'string',
'Reservations': [
{
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
},
]
}
Response Structure
(dict) -- MediaConnect returned the list of reservations successfully.
NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
Reservations (list) -- A list of all reservations that have been purchased by this account in the current AWS Region.
(dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
ReservationState (string) -- The status of your reservation.
ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in 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.
Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.
Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).
See also: AWS API Documentation
Request Syntax
client.describe_reservation(
ReservationArn='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the reservation.
dict
Response Syntax
{
'Reservation': {
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'OfferingArn': 'string',
'OfferingDescription': 'string',
'PricePerUnit': 'string',
'PriceUnits': 'HOURLY',
'ReservationArn': 'string',
'ReservationName': 'string',
'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
'ResourceSpecification': {
'ReservedBitrate': 123,
'ResourceType': 'Mbps_Outbound_Bandwidth'
},
'Start': 'string'
}
}
Response Structure
(dict) -- MediaConnect returned the reservation details successfully.
Reservation (dict) -- A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
CurrencyCode (string) -- The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
Duration (integer) -- The length of time that this reservation is active. MediaConnect defines this value in the offering.
DurationUnits (string) -- The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
End (string) -- The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
OfferingArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
OfferingDescription (string) -- A description of the offering. MediaConnect defines this value in the offering.
PricePerUnit (string) -- The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
PriceUnits (string) -- The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
ReservationArn (string) -- The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
ReservationName (string) -- The name that you assigned to the reservation when you purchased the offering.
ReservationState (string) -- The status of your reservation.
ResourceSpecification (dict) -- A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in 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.
Start (string) -- The day and time that the reservation becomes active. You set this value when you purchase the offering.
Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.
See also: AWS API Documentation
Request Syntax
client.list_offerings(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return per API request. For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
string
The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
dict
Response Syntax
{
'NextToken': 'string',
'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.
NextToken (string) -- The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
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.
Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.describe_offering(
OfferingArn='string'
)
string
[REQUIRED] The Amazon Resource Name (ARN) of the offering.
dict
Response Syntax
{
'Offering': {
'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 offering details successfully.
Offering (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.