quotes

Creates, updates, deletes, gets or lists a quotes resource.

Overview

Name	quotes
Type	Resource
Id	aws.outposts.quotes

Fields

The following fields are returned by SELECT queries:

get_quote

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account. (pattern: <code>\d{12}</code>)
country_code	string	The country code for the Outpost site location. (pattern: <code>^[A-Z]{2}$</code>)
created_date	string (date-time)	The date the quote was created.
description	string	The description of the quote. (pattern: <code>^[\S \n]*$</code>)
expiration_date	string (date-time)	The date the quote expires.
ordering_requirements	array	The requirements that must be met before an order can be submitted for the quote.
outpost_arn	string	The Amazon Resource Name (ARN) of the Outpost. (pattern: <code>^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$</code>)
quote_id	string	The ID of the quote. (pattern: <code>^oq-[a-f0-9]{17}$</code>)
quote_options	array	The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.
quote_status	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. (CREATED, ORDER_SUBMITTED, EXPIRED)
requested_capacities	array	The capacity requirements specified in the quote request.
requested_constraints	array	The physical constraints specified in the quote request.
requested_payment_options	array	The payment options specified in the quote request.
requested_payment_terms	array	The payment terms specified in the quote request.
status_message	string	A message about the status of the quote. (pattern: <code>^[\S \n]+$</code>)
submitted_order_id	string	The ID of the order submitted for the quote. (pattern: <code>^oo-[a-f0-9]{17}$</code>)

list_quotes

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account. (pattern: <code>\d{12}</code>)
country_code	string	The country code for the Outpost site location. (pattern: <code>^[A-Z]{2}$</code>)
created_date	string (date-time)	The date the quote was created.
description	string	The description of the quote. (pattern: <code>^[\S \n]*$</code>)
expiration_date	string (date-time)	The date the quote expires.
outpost_arn	string	The Amazon Resource Name (ARN) of the Outpost. (pattern: <code>^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$</code>)
quote_id	string	The ID of the quote. (pattern: <code>^oq-[a-f0-9]{17}$</code>)
quote_options	array	The configuration and pricing options for the quote.
quote_status	string	The status of the quote. (CREATED, ORDER_SUBMITTED, EXPIRED)
requested_capacities	array	The capacity requirements specified in the quote request.
requested_constraints	array	The physical constraints specified in the quote request.
requested_payment_options	array	The payment options specified in the quote request.
requested_payment_terms	array	The payment terms specified in the quote request.
status_message	string	A message about the status of the quote. (pattern: <code>^[\S \n]+$</code>)
submitted_order_id	string	The ID of the order submitted for the quote. (pattern: <code>^oo-[a-f0-9]{17}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_quote	select	quote_identifier, region		Gets information about the specified quote.
list_quotes	select	region	NextToken, MaxResults	Lists the quotes for your Amazon Web Services account.
create_quote	insert	region, CountryCode, RequestedCapacities		Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.
update_quote	update	quote_identifier, region		Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.
delete_quote	delete	quote_identifier, region		Deletes the specified quote.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
quote_identifier	string	The ID of the quote.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum page size.
NextToken	string	The pagination token.

SELECT examples

get_quote

Gets information about the specified quote.

SELECT
account_id,
country_code,
created_date,
description,
expiration_date,
ordering_requirements,
outpost_arn,
quote_id,
quote_options,
quote_status,
requested_capacities,
requested_constraints,
requested_payment_options,
requested_payment_terms,
status_message,
submitted_order_id
FROM aws.outposts.quotes
WHERE quote_identifier = '{{ quote_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_quotes

Lists the quotes for your Amazon Web Services account.

SELECT
account_id,
country_code,
created_date,
description,
expiration_date,
outpost_arn,
quote_id,
quote_options,
quote_status,
requested_capacities,
requested_constraints,
requested_payment_options,
requested_payment_terms,
status_message,
submitted_order_id
FROM aws.outposts.quotes
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_quote

Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.

INSERT INTO aws.outposts.quotes (
OutpostIdentifier,
CountryCode,
RequestedCapacities,
RequestedConstraints,
RequestedPaymentOptions,
RequestedPaymentTerms,
Description,
region
)
SELECT 
'{{ OutpostIdentifier }}',
'{{ CountryCode }}' /* required */,
'{{ RequestedCapacities }}' /* required */,
'{{ RequestedConstraints }}',
'{{ RequestedPaymentOptions }}',
'{{ RequestedPaymentTerms }}',
'{{ Description }}',
'{{ region }}'
RETURNING
quote
;

Manifest

# Description fields are for documentation purposes
- name: quotes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the quotes resource.
  - name: OutpostIdentifier
    value: "{{ OutpostIdentifier }}"
  - name: CountryCode
    value: "{{ CountryCode }}"
  - name: RequestedCapacities
    value:
      - QuoteCapacityType: "{{ QuoteCapacityType }}"
        Unit: "{{ Unit }}"
        Quantity: {{ Quantity }}
  - name: RequestedConstraints
    value:
      - QuoteConstraintType: "{{ QuoteConstraintType }}"
        Value: "{{ Value }}"
  - name: RequestedPaymentOptions
    value:
      - "{{ RequestedPaymentOptions }}"
  - name: RequestedPaymentTerms
    value:
      - "{{ RequestedPaymentTerms }}"
  - name: Description
    value: "{{ Description }}"

UPDATE examples

update_quote

Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.

UPDATE aws.outposts.quotes
SET 
OutpostIdentifier = '{{ OutpostIdentifier }}',
CountryCode = '{{ CountryCode }}',
RequestedCapacities = '{{ RequestedCapacities }}',
RequestedConstraints = '{{ RequestedConstraints }}',
RequestedPaymentOptions = '{{ RequestedPaymentOptions }}',
RequestedPaymentTerms = '{{ RequestedPaymentTerms }}',
Description = '{{ Description }}'
WHERE 
quote_identifier = '{{ quote_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
quote;

DELETE examples

delete_quote

Deletes the specified quote.

DELETE FROM aws.outposts.quotes
WHERE quote_identifier = '{{ quote_identifier }}' --required
AND region = '{{ region }}' --required
;