[ aws . outposts ]

get-quote

Description

Gets information about the specified quote.

See also: AWS API Documentation

Synopsis

  get-quote
--quote-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--quote-identifier (string) [required]

The ID of the quote.

Constraints:

• min: 1
• max: 255
• pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:quote/)?oq-[a-f0-9]{17}$

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream
• off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

Quote -> (structure)

Information about the quote.

QuoteId -> (string)

The ID of the quote.

Constraints:

• min: 1
• max: 255
• pattern: ^oq-[a-f0-9]{17}$

AccountId -> (string)

The ID of the account that owns the quote.

Constraints:

• min: 12
• max: 12
• pattern: \d{12}

QuoteStatus -> (string)

The status of the quote.

• CREATED - The quote has been created and is available for review.
• ORDER_SUBMITTED - An order has been submitted for the quote.
• EXPIRED - The quote has expired and can no longer be used to submit an order.

Possible values:

• CREATED
• ORDER_SUBMITTED
• EXPIRED

StatusMessage -> (string)

A message about the status of the quote.

Constraints:

• min: 1
• max: 2048
• pattern: ^[\S \n]+$

OutpostArn -> (string)

The ARN of the Outpost associated with the quote.

Constraints:

• min: 1
• max: 255
• pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$

CountryCode -> (string)

The country code for the Outpost site location.

Constraints:

• min: 2
• max: 2
• pattern: ^[A-Z]{2}$

RequestedCapacities -> (list)

The capacity requirements specified in the quote request.

Constraints:

• max: 2000

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

Possible values:

• EC2
• EBS
• 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).

Constraints:

• min: 1
• max: 1000
• pattern: ^[\S \n]+$

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.

Constraints:

• max: 10

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

Possible values:

• RACK_MAXIMUM
• RACK_MAX_POWER_KVA
• RACK_MAX_WEIGHT_LBS

Value -> (string)

The value of the constraint.

Constraints:

• min: 1
• max: 2048
• pattern: ^[\S \n]+$

RequestedPaymentOptions -> (list)

The payment options specified in the quote request.

Constraints:

• max: 3

(string)

Possible values:

• ALL_UPFRONT
• NO_UPFRONT
• PARTIAL_UPFRONT

RequestedPaymentTerms -> (list)

The payment terms specified in the quote request.

Constraints:

• max: 3

(string)

Possible values:

• THREE_YEARS
• ONE_YEAR
• FIVE_YEARS

QuoteOptions -> (list)

The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.

Constraints:

• max: 10

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

Constraints:

• min: 1
• max: 21
• pattern: ^oqo-[a-f0-9]{17}$

Capacities -> (list)

The capacities included in this quote option.

Constraints:

• max: 2000

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

Possible values:

• EC2
• EBS
• 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).

Constraints:

• min: 1
• max: 1000
• pattern: ^[\S \n]+$

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.

Constraints:

• max: 2000

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

Possible values:

• EC2
• EBS
• 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).

Constraints:

• min: 1
• max: 1000
• pattern: ^[\S \n]+$

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.

Constraints:

• max: 2000

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

Possible values:

• EC2
• EBS
• 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).

Constraints:

• min: 1
• max: 1000
• pattern: ^[\S \n]+$

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.

Constraints:

• max: 2000

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

Possible values:

• EC2
• EBS
• 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).

Constraints:

• min: 1
• max: 1000
• pattern: ^[\S \n]+$

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.

Constraints:

• max: 100

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

Possible values:

• UPDATED_RACK
• NEW_RACK
• EXISTING_RACK
• 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.

Constraints:

• min: 5
• max: 20
• pattern: ^[\S \n]+$

RackUse -> (string)

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

Possible values:

• NETWORKING
• COMPUTE

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.

Possible values:

• HEIGHT_42U
• HEIGHT_2U
• HEIGHT_1U

EC2Capacities -> (list)

The Amazon EC2 capacities for the rack.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

Constraints:

• min: 1
• max: 10
• pattern: ^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$

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.

Constraints:

• min: 5
• max: 20
• pattern: ^[\S \n]+$

RackUse -> (string)

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

Possible values:

• NETWORKING
• COMPUTE

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.

Possible values:

• HEIGHT_42U
• HEIGHT_2U
• HEIGHT_1U

EC2Capacities -> (list)

The Amazon EC2 capacities for the rack.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

Constraints:

• min: 1
• max: 10
• pattern: ^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$

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.

Possible values:

• HEIGHT_42U
• HEIGHT_2U
• HEIGHT_1U

EC2Capacities -> (list)

The Amazon EC2 capacities for the server.

(structure)

Information about EC2 capacity.

Family -> (string)

The family of the EC2 capacity.

Constraints:

• min: 1
• max: 10
• pattern: ^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$

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.

Constraints:

• max: 9

(structure)

A pricing option for the specified Outpost.

PricingType -> (string)

The type of pricing model.

Possible values:

• SUBSCRIPTION

SubscriptionPricingDetails -> (structure)

The subscription pricing details for this pricing option.

PaymentOption -> (string)

The payment option.

Possible values:

• ALL_UPFRONT
• NO_UPFRONT
• PARTIAL_UPFRONT

PaymentTerm -> (string)

The payment term.

Possible values:

• THREE_YEARS
• ONE_YEAR
• FIVE_YEARS

UpfrontPrice -> (float)

The upfront price.

MonthlyRecurringPrice -> (float)

The monthly recurring price.

Currency -> (string)

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

Possible values:

• USD

OrderingRequirements -> (list)

The requirements that must be met before an order can be submitted for the quote.

Constraints:

• max: 50

(structure)

A requirement that must be met before an order can be submitted for a quote.

StatusMessage -> (string)

A message about the ordering requirement.

Constraints:

• min: 1
• max: 2048
• pattern: ^[\S \n]+$

OrderingRequirementType -> (string)

The type of ordering requirement. Indicates which check failed or passed.

• OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.
• MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.
• VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.
• RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.
• OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.
• SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.
• COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.
• OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.
• OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.
• ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.
• SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.
• SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.
• SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.
• OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.
• OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.
• OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.
• UNSUPPORTED - The requirement type is not recognized.

Possible values:

• OUTPOST_ACTIVE_CHECK_ERROR
• MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR
• VALID_ZIP_CODE_CHECK_ERROR
• RACK_PHYSICAL_PROPERTIES_CHECK_ERROR
• OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR
• SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR
• COUNTRY_CODE_MISMATCH_CHECK_ERROR
• OUTPOST_GENERATION_MISMATCH_ERROR
• UNSUPPORTED
• OUTPOST_ID_MISSING_ON_QUOTE_ERROR
• ENTERPRISE_SUPPORT_ERROR
• SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR
• SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR
• SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR
• OUTPOST_STATE_CHANGED_ERROR
• OUTPOST_NOT_FOUND_ERROR
• OUTPOST_RENEWAL_REQUIRED_ERROR

Status -> (string)

The status of the ordering requirement. Valid values are PASS , FAIL , and EXEMPT .

Possible values:

• PASS
• FAIL
• EXEMPT

SubmittedOrderId -> (string)

The ID of the order submitted for the quote.

Constraints:

• min: 1
• max: 20
• pattern: ^oo-[a-f0-9]{17}$

CreatedDate -> (timestamp)

The date the quote was created.

ExpirationDate -> (timestamp)

The date the quote expires.

Description -> (string)

The description of the quote.

Constraints:

• min: 0
• max: 1024
• pattern: ^[\S \n]*$