[ aws . privatenetworks ]

list-network-resources

Description

Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.

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-network-resources 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: networkResources

Synopsis

  list-network-resources
[--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.

• ORDER - The Amazon Resource Name (ARN) of the order.

• STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).

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:
  ORDER
  STATUS

JSON Syntax:

{"ORDER"|"STATUS": ["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

networkResources -> (list)

Information about network resources.

(structure)

Information about a network resource.

attributes -> (list)

The attributes of the network resource.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

createdAt -> (timestamp)

The creation time of the network resource.

description -> (string)

The description of the network resource.

health -> (string)

The health of the network resource.

model -> (string)

The model of the network resource.

networkArn -> (string)

The Amazon Resource Name (ARN) of the network on which this network resource appears.

networkResourceArn -> (string)

The Amazon Resource Name (ARN) of the network resource.

networkSiteArn -> (string)

The Amazon Resource Name (ARN) of the network site on which this network resource appears.

orderArn -> (string)

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

position -> (structure)

The position of the network resource.

elevation -> (double)

The elevation of the equipment at this position.

elevationReference -> (string)

The reference point from which elevation is reported.

elevationUnit -> (string)

The units used to measure the elevation of the position.

latitude -> (double)

The latitude of the position.

longitude -> (double)

The longitude of the position.

serialNumber -> (string)

The serial number of the network resource.

status -> (string)

The status of the network resource.

statusReason -> (string)

The status reason of the network resource.

type -> (string)

The type of the network resource.

vendor -> (string)

The vendor of the network resource.

nextToken -> (string)

The token for the next page of results.