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

ListCidrBlocks

Returns a paginated list of location objects and their CIDR blocks.

Request Syntax


GET /2013-04-01/cidrcollection/CidrCollectionId/cidrblocks?location=LocationName&maxresults=MaxResults&nexttoken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CidrCollectionId

The UUID of the CIDR collection.

Pattern: [0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}

Required: Yes

location

The name of the CIDR collection location.

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

Pattern: [0-9A-Za-z_\-]+

maxresults

Maximum number of results you want returned.

nexttoken

An opaque pagination token to indicate where the service is to begin enumerating results.

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"?>
<ListCidrBlocksResponse>
   <CidrBlocks>
      <CidrBlockSummary>
         <CidrBlock>string</CidrBlock>
         <LocationName>string</LocationName>
      </CidrBlockSummary>
   </CidrBlocks>
   <NextToken>string</NextToken>
</ListCidrBlocksResponse>

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.

ListCidrBlocksResponse

Root level tag for the ListCidrBlocksResponse parameters.

Required: Yes

CidrBlocks

A complex type that contains information about the CIDR blocks.

Type: Array of CidrBlockSummary 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

NoSuchCidrLocationException

The CIDR collection location doesn't match any locations in your account.

HTTP Status Code: 404

Examples

Example request

This example illustrates one usage of ListCidrBlocks.


GET /2013-04-01/cidrcollection/c8c02a84-aaec-7a26-e0d2-d833a2f80106/cidrblocks?location=location-1&maxresults=1

Example response

This example illustrates one usage of ListCidrBlocks.



HTTP/1.1 200
<?xml version="1.0"?>   				
<ListCidrBlocksResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
  <NextToken>eyJjb2xsZWN0aW9uSWQiOiIwNGJmZjEyZS04NTdjLTFiNmEtNTc2OS0wMTQwMzg4NmE1NzkiLCJsb2NhdGlvbk5hbWUiOiJhMSIsImNpZHIiOiIyLjMuMS4wLzI0In0=</NextToken>
    <CidrBlocks>
      <member>
        <CidrBlock>1.1.1.0/24</CidrBlock>
        <LocationName>location-1</LocationName>
      </member>
   </CidrBlocks>
</ListCidrBlocksResponse>