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

ListSites

Lists the Outpost sites for your AWS account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Request Syntax


GET /sites?MaxResults=MaxResults&NextToken=NextToken&OperatingAddressCityFilter=OperatingAddressCityFilter&OperatingAddressCountryCodeFilter=OperatingAddressCountryCodeFilter&OperatingAddressStateOrRegionFilter=OperatingAddressStateOrRegionFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum page size.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The pagination token.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(\d+)##(\S+)$

OperatingAddressCityFilter

Filters the results by city.

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^\S[\S ]*$

OperatingAddressCountryCodeFilter

Filters the results by country code.

Length Constraints: Fixed length of 2.

Pattern: ^[A-Z]{2}$

OperatingAddressStateOrRegionFilter

Filters the results by state or region.

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^\S[\S ]*$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Sites": [ 
      { 
         "AccountId": "string",
         "Description": "string",
         "Name": "string",
         "Notes": "string",
         "OperatingAddressCity": "string",
         "OperatingAddressCountryCode": "string",
         "OperatingAddressStateOrRegion": "string",
         "RackPhysicalProperties": { 
            "FiberOpticCableType": "string",
            "MaximumSupportedWeightLbs": "string",
            "OpticalStandard": "string",
            "PowerConnector": "string",
            "PowerDrawKva": "string",
            "PowerFeedDrop": "string",
            "PowerPhase": "string",
            "UplinkCount": "string",
            "UplinkGbps": "string"
         },
         "SiteArn": "string",
         "SiteId": "string",
         "Tags": { 
            "string" : "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.

NextToken

The pagination token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(\d+)##(\S+)$

Sites

Information about the sites.

Type: Array of Site objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ValidationException

A parameter is not valid.

HTTP Status Code: 400