Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListNetworkSites

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.

Request Syntax


POST /v1/network-sites/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. 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.

Type: String to array of strings map

Valid Keys: STATUS

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

{
   "networkSites": [ 
      { 
         "availabilityZone": "string",
         "availabilityZoneId": "string",
         "createdAt": "string",
         "currentPlan": { 
            "options": [ 
               { 
                  "name": "string",
                  "value": "string"
               }
            ],
            "resourceDefinitions": [ 
               { 
                  "count": number,
                  "options": [ 
                     { 
                        "name": "string",
                        "value": "string"
                     }
                  ],
                  "type": "string"
               }
            ]
         },
         "description": "string",
         "networkArn": "string",
         "networkSiteArn": "string",
         "networkSiteName": "string",
         "pendingPlan": { 
            "options": [ 
               { 
                  "name": "string",
                  "value": "string"
               }
            ],
            "resourceDefinitions": [ 
               { 
                  "count": number,
                  "options": [ 
                     { 
                        "name": "string",
                        "value": "string"
                     }
                  ],
                  "type": "string"
               }
            ]
         },
         "status": "string",
         "statusReason": "string"
      }
   ],
   "nextToken": "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.

networkSites

Information about the network sites.

Type: Array of NetworkSite objects

nextToken

The token for the next page of results.

Type: String

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