[ aws . outposts ]

create-order

Description

Creates an order for an Outpost.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-order
--outpost-identifier <value>
--line-items <value>
--payment-option <value>
[--payment-term <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--outpost-identifier (string)

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

--line-items (list)

The line items that make up the order.

(structure)

Information about a line item request.

CatalogItemId -> (string)

The ID of the catalog item.

Quantity -> (integer)

The quantity of a line item request.

Shorthand Syntax:

CatalogItemId=string,Quantity=integer ...

JSON Syntax:

[
  {
    "CatalogItemId": "string",
    "Quantity": integer
  }
  ...
]

--payment-option (string)

The payment option for the order.

Possible values:

• ALL_UPFRONT

• NO_UPFRONT

• PARTIAL_UPFRONT

--payment-term (string)

The payment terms for the order.

Possible values:

• THREE_YEARS

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

Order -> (structure)

Information about this 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.

ShipmentInformation -> (structure)

Information about a line item shipment.

ShipmentTrackingNumber -> (string)

The tracking number of the shipment.

ShipmentCarrier -> (string)

The carrier of the shipment.

AssetInformationList -> (list)

Information about assets.

(structure)

Information about a line item asset.

AssetId -> (string)

The ID of the asset.

MacAddressList -> (list)

MAC addresses of the asset.

(string)

PaymentOption -> (string)

The payment option for the order.

OrderSubmissionDate -> (timestamp)

The submission date for the order.

OrderFulfilledDate -> (timestamp)

The fulfillment date of the order.