ListCidrLocations
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
Request Syntax
GET /2013-04-01/cidrcollection/CidrCollectionId?maxresults=MaxResults&nexttoken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- CidrCollectionId
-
The CIDR collection ID.
Pattern:
[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}Required: Yes
- maxresults
-
The maximum number of CIDR collection locations to return in the response.
- nexttoken
-
An opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
Length Constraints: Maximum length of 1024.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListCidrLocationsResponse>
<CidrLocations>
<LocationSummary>
<LocationName>string</LocationName>
</LocationSummary>
</CidrLocations>
<NextToken>string</NextToken>
</ListCidrLocationsResponse>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListCidrLocationsResponse
-
Root level tag for the ListCidrLocationsResponse parameters.
Required: Yes
- CidrLocations
-
A complex type that contains information about the list of CIDR locations.
Type: Array of LocationSummary objects
- NextToken
-
An opaque pagination token to indicate where the service is to begin enumerating results.
If no value is provided, the listing of results starts from the beginning.
Type: String
Length Constraints: Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The input is not valid.
HTTP Status Code: 400
- NoSuchCidrCollectionException
-
The CIDR collection you specified, doesn't exist.
HTTP Status Code: 404
Examples
Example request
This example illustrates one usage of ListCidrLocations.
GET /2013-04-01/cidrcollection/c8c02a84-aaaa-bbbb-e0d2-d833a2f80106?maxresults=1
Example response
This example illustrates one usage of ListCidrLocations.
HTTP/1.1 200 <?xml version="1.0"?> <ListCidrLocationsResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/">> <NextToken>eyJjb2xsZWN0aW9uSWQiOiIwNGJmZjEyZS04NTdjLTFiNmEtNTc2OS0wMTQwMzg4NmE1NzkiLCJjb2xsZWN0aW9uTmFtZSI6ImZlbndhLTEifQ==</NextToken> <CidrLocations> <member> <LocationName>location-1</LocationName> </member> </CidrLocations> </ListCidrLocationsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
