orders

Creates, updates, deletes, gets or lists an orders resource.

Overview

Name	orders
Type	Resource
Id	aws.outposts.orders

Fields

The following fields are returned by SELECT queries:

get_order

Name	Datatype	Description
line_items	array	The line items for the order
order_fulfilled_date	string (date-time)	The fulfillment date of the order.
order_id	string	The ID of the order. (pattern: <code>oo-[a-f0-9]{17}$</code>)
order_submission_date	string (date-time)	The submission date for the order.
order_type	string	The type of order. (OUTPOST, REPLACEMENT)
outpost_id	string	The ID of the Outpost in the order. (pattern: <code>^op-[a-f0-9]{17}$</code>)
payment_option	string	The payment option for the order. (ALL_UPFRONT, NO_UPFRONT, PARTIAL_UPFRONT)
payment_term	string	The payment term. (THREE_YEARS, ONE_YEAR, FIVE_YEARS)
quote_identifier	string	The ID of the quote associated with the order. (pattern: <code>^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:quote/)?oq-[a-f0-9]{17}$</code>)
quote_option_identifier	string	The ID of the quote option associated with the order. (pattern: <code>^oqo-[a-f0-9]{17}$</code>)
status	string	The status of the order. PREPARING - Order is received and being prepared. IN_PROGRESS - Order is either being built or shipped. To get more details, see the line item status. DELIVERED - Order was delivered to the Outpost site. COMPLETED - Order is complete. CANCELLED - Order is cancelled. ERROR - Customer should contact support. The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED. (RECEIVED, PENDING, PROCESSING, INSTALLING, FULFILLED, CANCELLED, PREPARING, IN_PROGRESS, DELIVERED, COMPLETED, ERROR)

list_orders

Name	Datatype	Description
line_item_counts_by_status	object	The status of all line items in the order.
order_fulfilled_date	string (date-time)	The fulfilment date for the order.
order_id	string	The ID of the order. (pattern: <code>oo-[a-f0-9]{17}$</code>)
order_submission_date	string (date-time)	The submission date for the order.
order_type	string	The type of order. (OUTPOST, REPLACEMENT)
outpost_id	string	The ID of the Outpost. (pattern: <code>^op-[a-f0-9]{17}$</code>)
status	string	The status of the order. PREPARING - Order is received and is being prepared. IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status. COMPLETED - Order is complete. CANCELLED - Order is cancelled. ERROR - Customer should contact support. The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED. (RECEIVED, PENDING, PROCESSING, INSTALLING, FULFILLED, CANCELLED, PREPARING, IN_PROGRESS, DELIVERED, COMPLETED, ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_order	select	order_id, region		Gets information about the specified order.
list_orders	select	region	OutpostIdentifierFilter, NextToken, MaxResults	Lists the Outpost orders for your Amazon Web Services account.
create_order	insert	region, OutpostIdentifier, PaymentOption		Creates an order for an Outpost.
cancel_order	exec	order_id, region		Cancels the specified order for an Outpost.

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
order_id	string	The ID of the order.
region	string	AWS region (default: us-east-1)
MaxResults	integer
NextToken	string
OutpostIdentifierFilter	string	The ID or the Amazon Resource Name (ARN) of the Outpost.

SELECT examples

get_order

Gets information about the specified order.

SELECT
line_items,
order_fulfilled_date,
order_id,
order_submission_date,
order_type,
outpost_id,
payment_option,
payment_term,
quote_identifier,
quote_option_identifier,
status
FROM aws.outposts.orders
WHERE order_id = '{{ order_id }}' -- required
AND region = '{{ region }}' -- required
;

list_orders

Lists the Outpost orders for your Amazon Web Services account.

SELECT
line_item_counts_by_status,
order_fulfilled_date,
order_id,
order_submission_date,
order_type,
outpost_id,
status
FROM aws.outposts.orders
WHERE region = '{{ region }}' -- required
AND OutpostIdentifierFilter = '{{ OutpostIdentifierFilter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_order

Creates an order for an Outpost.

INSERT INTO aws.outposts.orders (
OutpostIdentifier,
QuoteIdentifier,
QuoteOptionIdentifier,
LineItems,
PaymentOption,
PaymentTerm,
region
)
SELECT 
'{{ OutpostIdentifier }}' /* required */,
'{{ QuoteIdentifier }}',
'{{ QuoteOptionIdentifier }}',
'{{ LineItems }}',
'{{ PaymentOption }}' /* required */,
'{{ PaymentTerm }}',
'{{ region }}'
RETURNING
order
;

Manifest

# Description fields are for documentation purposes
- name: orders
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the orders resource.
  - name: OutpostIdentifier
    value: "{{ OutpostIdentifier }}"
  - name: QuoteIdentifier
    value: "{{ QuoteIdentifier }}"
  - name: QuoteOptionIdentifier
    value: "{{ QuoteOptionIdentifier }}"
  - name: LineItems
    value:
      - CatalogItemId: "{{ CatalogItemId }}"
        Quantity: {{ Quantity }}
  - name: PaymentOption
    value: "{{ PaymentOption }}"
    valid_values: ['ALL_UPFRONT', 'NO_UPFRONT', 'PARTIAL_UPFRONT']
  - name: PaymentTerm
    value: "{{ PaymentTerm }}"
    valid_values: ['THREE_YEARS', 'ONE_YEAR', 'FIVE_YEARS']

Lifecycle Methods

cancel_order

Cancels the specified order for an Outpost.

EXEC aws.outposts.orders.cancel_order 
@order_id='{{ order_id }}' --required, 
@region='{{ region }}' --required
;