[ aws . privatenetworks ]

list-orders

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-orders is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: orders

Synopsis

  list-orders
[--filters <value>]
--network-arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filters (map)

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.

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

  KeyName1=string,string,KeyName2=string,string

Where valid key names are:
  STATUS
  NETWORK_SITE

JSON Syntax:

{"STATUS"|"NETWORK_SITE": ["string", ...]
  ...}

--network-arn (string)

The Amazon Resource Name (ARN) of the network.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

nextToken -> (string)

The token for the next page of results.

orders -> (list)

Information about the orders.

(structure)

Information about an order.

acknowledgmentStatus -> (string)

The acknowledgement status of the order.

createdAt -> (timestamp)

The creation time of the order.

networkArn -> (string)

The Amazon Resource Name (ARN) of the network associated with this order.

networkSiteArn -> (string)

The Amazon Resource Name (ARN) of the network site associated with this order.

orderArn -> (string)

The Amazon Resource Name (ARN) of the order.

shippingAddress -> (structure)

The shipping address of the order.

city -> (string)

The city for this address.

company -> (string)

The company name for this address.

country -> (string)

The country for this address.

name -> (string)

The recipient’s name for this address.

phoneNumber -> (string)

The phone number for this address.

postalCode -> (string)

The postal code for this address.

stateOrProvince -> (string)

The state or province for this address.

street1 -> (string)

The first line of the street address.

street2 -> (string)

The second line of the street address.

street3 -> (string)

The third line of the street address.

trackingInformation -> (list)

The tracking information of the order.

(structure)

Information about tracking a shipment.

trackingNumber -> (string)

The tracking number of the shipment.