[ aws . outposts ]

list-orders

Description

Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-orders
[--outpost-identifier-filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--outpost-identifier-filter (string)

The ID or the Amazon Resource Name (ARN) of the Outpost.

--next-token (string)

The pagination token.

--max-results (integer)

The maximum page size.

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

See ‘aws help’ for descriptions of global parameters.

Output

Orders -> (list)

Information about the orders.

(structure)

A summary of line items in your order.

OutpostId -> (string)

The ID of the Outpost.

OrderId -> (string)

The ID of the order.

OrderType -> (string)

The type of order.

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.

Note

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

LineItemCountsByStatus -> (map)

The status of all line items in the order.

key -> (string)

value -> (integer)

OrderSubmissionDate -> (timestamp)

Submission date for the order.

OrderFulfilledDate -> (timestamp)

Fulfilment date for the order.

NextToken -> (string)

The pagination token.