[ aws . medialive ]

list-reservations

Description

List purchased reservations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-reservations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Reservations

Synopsis

  list-reservations
[--channel-class <value>]
[--codec <value>]
[--maximum-bitrate <value>]
[--maximum-framerate <value>]
[--resolution <value>]
[--resource-type <value>]
[--special-feature <value>]
[--video-quality <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--channel-class (string) Filter by channel class, ‘STANDARD’ or ‘SINGLE_PIPELINE’

--codec (string) Filter by codec, ‘AVC’, ‘HEVC’, ‘MPEG2’, or ‘AUDIO’

--maximum-bitrate (string) Filter by bitrate, ‘MAX_10_MBPS’, ‘MAX_20_MBPS’, or ‘MAX_50_MBPS’

--maximum-framerate (string) Filter by framerate, ‘MAX_30_FPS’ or ‘MAX_60_FPS’

--resolution (string) Filter by resolution, ‘SD’, ‘HD’, ‘FHD’, or ‘UHD’

--resource-type (string) Filter by resource type, ‘INPUT’, ‘OUTPUT’, ‘MULTIPLEX’, or ‘CHANNEL’

--special-feature (string) Filter by special feature, ‘ADVANCED_AUDIO’ or ‘AUDIO_NORMALIZATION’

--video-quality (string) Filter by video quality, ‘STANDARD’, ‘ENHANCED’, or ‘PREMIUM’

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

Token to retrieve the next page of results

Reservations -> (list)

List of reservations

(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’