Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . medialive ]

purchase-offering

Description

Purchase an offering and create a reservation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  purchase-offering
--count <value>
[--name <value>]
--offering-id <value>
[--request-id <value>]
[--start <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--count (integer) Number of resources

--name (string) Name for the new reservation

--offering-id (string) Offering to purchase, e.g. '87654321'

--request-id (string) Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

--start (string) Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.

--tags (map) A collection of key-value pairs

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Reservation -> (structure)

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 -> (double)

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 -> (structure)

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)

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'

Tags -> (map)

A collection of key-value pairs

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string

UsagePrice -> (double)

Recurring usage charge for each reserved resource, e.g. '157.0'