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 ]

describe-reservation

Description

Get details for a reservation.

See also: AWS API Documentation

Synopsis

  describe-reservation
--reservation-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--reservation-id (string) Unique reservation ID, e.g. '1234567'

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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'

RenewalSettings -> (structure)

Renewal settings for the reservation

AutomaticRenewal -> (string)

Automatic renewal status for the reservation

RenewalCount -> (integer)

Count for the reservation renewal

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'