ListOrders
Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
Request Syntax
POST /v1/orders/list HTTP/1.1
Content-type: application/json
{
"filters": {
"string" : [ "string" ]
},
"maxResults": number,
"networkArn": "string",
"startToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filters
-
The filters.
-
NETWORK_SITE- The Amazon Resource Name (ARN) of the network site. -
STATUS- The status (ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an
OR, and the request returns all results that match any of the specified values.Type: String to array of strings map
Valid Keys:
STATUS | NETWORK_SITERequired: No
-
- maxResults
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- networkArn
-
The Amazon Resource Name (ARN) of the network.
Type: String
Pattern:
^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$Required: Yes
- startToken
-
The token for the next page of results.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"orders": [
{
"acknowledgmentStatus": "string",
"createdAt": "string",
"networkArn": "string",
"networkSiteArn": "string",
"orderArn": "string",
"orderedResources": [
{
"commitmentConfiguration": {
"automaticRenewal": boolean,
"commitmentLength": "string"
},
"count": number,
"type": "string"
}
],
"shippingAddress": {
"city": "string",
"company": "string",
"country": "string",
"emailAddress": "string",
"name": "string",
"phoneNumber": "string",
"postalCode": "string",
"stateOrProvince": "string",
"street1": "string",
"street2": "string",
"street3": "string"
},
"trackingInformation": [
{
"trackingNumber": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
Information about an internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource was not found.
HTTP Status Code: 404
- ValidationException
-
The request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
