ListOrdersCommand

Suggest an Edit

Lists the Outpost orders for your Amazon Web Services account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OutpostsClient, ListOrdersCommand } from "@aws-sdk/client-outposts"; // ES Modules import
// const { OutpostsClient, ListOrdersCommand } = require("@aws-sdk/client-outposts"); // CommonJS import
const client = new OutpostsClient(config);
const input = { // ListOrdersInput
  OutpostIdentifierFilter: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListOrdersCommand(input);
const response = await client.send(command);
// { // ListOrdersOutput
//   Orders: [ // OrderSummaryListDefinition
//     { // OrderSummary
//       OutpostId: "STRING_VALUE",
//       OrderId: "STRING_VALUE",
//       OrderType: "OUTPOST" || "REPLACEMENT",
//       Status: "RECEIVED" || "PENDING" || "PROCESSING" || "INSTALLING" || "FULFILLED" || "CANCELLED" || "PREPARING" || "IN_PROGRESS" || "DELIVERED" || "COMPLETED" || "ERROR",
//       LineItemCountsByStatus: { // LineItemStatusCounts
//         "<keys>": Number("int"),
//       },
//       OrderSubmissionDate: new Date("TIMESTAMP"),
//       OrderFulfilledDate: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListOrdersCommand Input

See ListOrdersCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum page size.

NextToken
string | undefined

The pagination token.

OutpostIdentifierFilter
string | undefined

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

ListOrdersCommand Output

See ListOrdersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The pagination token.

Orders
OrderSummary[] | undefined

Information about the orders.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have permission to perform this operation.

InternalServerException
server

An internal error has occurred.

NotFoundException
client

The specified request is not valid.

ValidationException
client

A parameter is not valid.

OutpostsServiceException
Base exception class for all service exceptions from Outposts service.