[ aws . outposts ]

get-order

Description

Gets an order.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-order
--order-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--order-id (string)

The ID of the order.

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

See ‘aws help’ for descriptions of global parameters.

Output

Order -> (structure)

Information about an order.

OutpostId -> (string)

The ID of the Outpost in the order.

OrderId -> (string)

The ID of the order.

Status -> (string)

The status of the order.

• PREPARING - Order is received and being prepared.

• IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the LineItem status.

• COMPLETED - Order is complete.

• CANCELLED - Order is cancelled.

• ERROR - Customer should contact support.

Note

The following status are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .

LineItems -> (list)

The line items for the order

(structure)

Information about a line item.

CatalogItemId -> (string)

The ID of the catalog item.

LineItemId -> (string)

The ID of the line item.

Quantity -> (integer)

The quantity of the line item.

Status -> (string)

The status of the line item.

PaymentOption -> (string)

The payment option for the order.

OrderSubmissionDate -> (timestamp)

The submission date for the order.

OrderFulfilledDate -> (timestamp)

The fulfillment date of the order.