Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

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 <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

commitmentInformation -> (structure)

Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

commitmentConfiguration -> (structure)

The duration and renewal status of the commitment period for the radio unit.

automaticRenewal -> (boolean)

Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

Set to True , if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

You can do the following:

  • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
  • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
  • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

You cannot use the automatic-renewal option for a 60-day commitment.

commitmentLength -> (string)

The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

expiresOn -> (timestamp)

The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.

startAt -> (timestamp)

The date and time that the commitment period started.

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.

returnInformation -> (structure)

Information about a request to return the network resource.

replacementOrderArn -> (string)

The Amazon Resource Name (ARN) of the replacement order.

returnReason -> (string)

The reason for the return. If the return request did not include a reason for the return, this value is null.

shippingAddress -> (structure)

The shipping address.

city -> (string)

The city for this address.

company -> (string)

The company name for this address.

country -> (string)

The country for this address.

emailAddress -> (string)

The recipient's email address.

name -> (string)

The recipient's name for this address.

phoneNumber -> (string)

The recipient's phone number.

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.

shippingLabel -> (string)

The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN . For more information, see Return a radio unit .

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.