[ aws . privatenetworks ]

list-network-sites

Description

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-network-sites 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: networkSites

Synopsis

  list-network-sites
[--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. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

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

JSON Syntax:

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

networkSites -> (list)

Information about the network sites.

(structure)

Information about a network site.

availabilityZone -> (string)

The parent Availability Zone for the network site.

availabilityZoneId -> (string)

The parent Availability Zone ID for the network site.

createdAt -> (timestamp)

The creation time of the network site.

currentPlan -> (structure)

The current plan of the network site.

options -> (list)

The options of the plan.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

resourceDefinitions -> (list)

The resource definitions of the plan.

(structure)

Information about a network resource definition.

count -> (integer)

The count in the network resource definition.

options -> (list)

The options in the network resource definition.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

type -> (string)

The type in the network resource definition.

description -> (string)

The description of the network site.

networkArn -> (string)

The Amazon Resource Name (ARN) of the network to which the network site belongs.

networkSiteArn -> (string)

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

networkSiteName -> (string)

The name of the network site.

pendingPlan -> (structure)

The pending plan of the network site.

options -> (list)

The options of the plan.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

resourceDefinitions -> (list)

The resource definitions of the plan.

(structure)

Information about a network resource definition.

count -> (integer)

The count in the network resource definition.

options -> (list)

The options in the network resource definition.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

type -> (string)

The type in the network resource definition.

status -> (string)

The status of the network site.

statusReason -> (string)

The status reason of the network site.

nextToken -> (string)

The token for the next page of results.