ListOrders
Lists the Outpost orders for your AWS account.
Request Syntax
GET /list-orders?MaxResults=MaxResults&NextToken=NextToken&OutpostIdentifierFilter=OutpostIdentifierFilter HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum page size.
Valid Range: Minimum value of 1. Maximum value of 1000.
- NextToken
-
The pagination token.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(\d+)##(\S+)$ - OutpostIdentifierFilter
-
The ID or the Amazon Resource Name (ARN) of the Outpost.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern:
^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Orders": [
{
"LineItemCountsByStatus": {
"string" : number
},
"OrderFulfilledDate": number,
"OrderId": "string",
"OrderSubmissionDate": number,
"OrderType": "string",
"OutpostId": "string",
"Status": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(\d+)##(\S+)$ - Orders
-
Information about the orders.
Type: Array of OrderSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have permission to perform this operation.
HTTP Status Code: 403
- InternalServerException
-
An internal error has occurred.
HTTP Status Code: 500
- NotFoundException
-
The specified request is not valid.
HTTP Status Code: 404
- ValidationException
-
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
