Order - AWS Outposts

Order

Information about an order.

Contents

LineItems

The line items for the order

Type: Array of LineItem objects

Required: No

OrderFulfilledDate

The fulfillment date of the order.

Type: Timestamp

Required: No

OrderId

The ID of the order.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: oo-[a-f0-9]{17}$

Required: No

OrderSubmissionDate

The submission date for the order.

Type: Timestamp

Required: No

OrderType

The type of order.

Type: String

Valid Values: OUTPOST | REPLACEMENT

Required: No

OutpostId

The ID of the Outpost in the order.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^op-[a-f0-9]{17}$

Required: No

PaymentOption

The payment option for the order.

Type: String

Valid Values: ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT

Required: No

PaymentTerm

The payment term.

Type: String

Valid Values: THREE_YEARS | ONE_YEAR

Required: No

Status

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

Type: String

Valid Values: RECEIVED | PENDING | PROCESSING | INSTALLING | FULFILLED | CANCELLED | PREPARING | IN_PROGRESS | COMPLETED | ERROR

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: