AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . outposts ]

list-quotes

Description

Lists the quotes for your Amazon Web Services account.

See also: AWS API Documentation

list-quotes 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: Quotes

Synopsis

  list-quotes
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--v2-debug]

Options

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

--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. 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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Quotes -> (list)

Information about the quotes.

(structure)

Summary information about a quote.

QuoteId -> (string)

The ID of the quote.

AccountId -> (string)

The ID of the account that owns the quote.

QuoteStatus -> (string)

The status of the quote.

StatusMessage -> (string)

A message about the status of the quote.

OutpostArn -> (string)

The ARN of the Outpost associated with the quote.

CountryCode -> (string)

The country code for the Outpost site location.

RequestedCapacities -> (list)

The capacity requirements specified in the quote request.

(structure)

A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

QuoteCapacityType -> (string)

The type of capacity. Valid values are EC2 , EBS , and S3 .

Unit -> (string)

The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge ). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

Quantity -> (float)

The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

RequestedConstraints -> (list)

The physical constraints specified in the quote request.

(structure)

A physical constraint for a quote.

QuoteConstraintType -> (string)

The type of constraint. Valid values are RACK_MAXIMUM , RACK_MAX_POWER_KVA , and RACK_MAX_WEIGHT_LBS .

Value -> (string)

The value of the constraint.

RequestedPaymentOptions -> (list)

The payment options specified in the quote request.

(string)

RequestedPaymentTerms -> (list)

The payment terms specified in the quote request.

(string)

QuoteOptions -> (list)

The configuration and pricing options for the quote.

(structure)

A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.

QuoteOptionIdentifier -> (string)

The ID of the quote option.

Capacities -> (list)

The capacities included in this quote option.

(structure)

A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

QuoteCapacityType -> (string)

The type of capacity. Valid values are EC2 , EBS , and S3 .

Unit -> (string)

The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge ). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

Quantity -> (float)

The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

CapacitySummary -> (structure)

A summary of the existing, final, and changed capacity for this quote option.

ExistingCapacities -> (list)

The existing capacities on the Outpost before the quote is fulfilled.

(structure)

A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

QuoteCapacityType -> (string)

The type of capacity. Valid values are EC2 , EBS , and S3 .

Unit -> (string)

The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge ). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

Quantity -> (float)

The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

FinalCapacities -> (list)

The final capacities on the Outpost after the quote is fulfilled.

(structure)

A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

QuoteCapacityType -> (string)

The type of capacity. Valid values are EC2 , EBS , and S3 .

Unit -> (string)

The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge ). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

Quantity -> (float)

The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

CapacityChange -> (list)

The change in capacity between the existing and final state.

(structure)

A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.

QuoteCapacityType -> (string)

The type of capacity. Valid values are EC2 , EBS , and S3 .

Unit -> (string)

The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge ). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).

Quantity -> (float)

The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.

Specifications -> (list)

The physical specifications for the racks or servers in this quote option.

(structure)

A physical specification for a quote option. Describes the rack or server configuration that would be deployed.

QuoteSpecificationType -> (string)

The type of specification. Valid values are NEW_RACK , UPDATED_RACK , EXISTING_RACK , and SERVER .

ExistingRackSpecificationDetails -> (structure)

The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK .

RackId -> (string)

The ID of the rack.

RackUse -> (string)

The use of the rack. Valid values are COMPUTE and NETWORKING .

RackPowerDrawKva -> (float)

The maximum power draw of the rack in kVA.

RackWeightLbs -> (float)

The weight of the rack in pounds.

RackHeightInches -> (float)

The height of the rack in inches.

RackWidthInches -> (float)

The width of the rack in inches.

RackDepthInches -> (float)

The depth of the rack in inches.

RackUnitHeight -> (string)

The rack unit height.

  • HEIGHT_42U - 42 rack units.
  • HEIGHT_2U - 2 rack units.
  • HEIGHT_1U - 1 rack unit.

EC2Capacities -> (list)

The Amazon EC2 capacities for the rack.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

MaxSize -> (string)

The maximum size of the EC2 capacity.

Quantity -> (string)

The quantity of the EC2 capacity.

FinalRackSpecificationDetails -> (structure)

The final rack specification details after the quote is fulfilled.

RackId -> (string)

The ID of the rack.

RackUse -> (string)

The use of the rack. Valid values are COMPUTE and NETWORKING .

RackPowerDrawKva -> (float)

The maximum power draw of the rack in kVA.

RackWeightLbs -> (float)

The weight of the rack in pounds.

RackHeightInches -> (float)

The height of the rack in inches.

RackWidthInches -> (float)

The width of the rack in inches.

RackDepthInches -> (float)

The depth of the rack in inches.

RackUnitHeight -> (string)

The rack unit height.

  • HEIGHT_42U - 42 rack units.
  • HEIGHT_2U - 2 rack units.
  • HEIGHT_1U - 1 rack unit.

EC2Capacities -> (list)

The Amazon EC2 capacities for the rack.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

MaxSize -> (string)

The maximum size of the EC2 capacity.

Quantity -> (string)

The quantity of the EC2 capacity.

ServerSpecificationDetails -> (structure)

The server specification details, if the specification type is SERVER .

ServerPowerDrawKva -> (float)

The maximum power draw of the server in kVA.

ServerWeightLbs -> (float)

The weight of the server in pounds.

ServerHeightInches -> (float)

The height of the server in inches.

ServerWidthInches -> (float)

The width of the server in inches.

ServerDepthInches -> (float)

The depth of the server in inches.

RackUnitHeight -> (string)

The rack unit height of the server.

  • HEIGHT_2U - 2 rack units.
  • HEIGHT_1U - 1 rack unit.

EC2Capacities -> (list)

The Amazon EC2 capacities for the server.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

MaxSize -> (string)

The maximum size of the EC2 capacity.

Quantity -> (string)

The quantity of the EC2 capacity.

PricingOptions -> (list)

The pricing options for this quote option.

(structure)

A pricing option for the specified Outpost.

PricingType -> (string)

The type of pricing model.

SubscriptionPricingDetails -> (structure)

The subscription pricing details for this pricing option.

PaymentOption -> (string)

The payment option.

PaymentTerm -> (string)

The payment term.

UpfrontPrice -> (float)

The upfront price.

MonthlyRecurringPrice -> (float)

The monthly recurring price.

Currency -> (string)

The currency of the price. Currently only USD is supported.

SubmittedOrderId -> (string)

The ID of the order submitted for the quote.

CreatedDate -> (timestamp)

The date the quote was created.

ExpirationDate -> (timestamp)

The date the quote expires.

Description -> (string)

The description of the quote.

NextToken -> (string)

The pagination token.