AWS CLI Command Reference

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

describe-offering

Description

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

Synopsis

  describe-offering
--offering-arn <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

--offering-arn (string) The Amazon Resource Name (ARN) of the offering.

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

Offering -> (structure)

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

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.