ListCidrCollections - Amazon Route 53

ListCidrCollections

Returns a paginated list of CIDR collections in the AWS account (metadata only).

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

maxresults

The maximum number of CIDR collections 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"?> <ListCidrCollectionsResponse> <CidrCollections> <CollectionSummary> <Arn>string</Arn> <Id>string</Id> <Name>string</Name> <Version>long</Version> </CollectionSummary> </CidrCollections> <NextToken>string</NextToken> </ListCidrCollectionsResponse>

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.

ListCidrCollectionsResponse

Root level tag for the ListCidrCollectionsResponse parameters.

Required: Yes

CidrCollections

A complex type with information about the CIDR collection.

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

Examples

Example request

This example illustrates one usage of ListCidrCollections.

GET /2013-04-01/cidrcollection?maxresults=1

Example response

This example illustrates one usage of ListCidrCollections.

HTTP/1.1 200 <?xml version="1.0"?> <ListCidrCollectionsResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/">> <NextToken>eyJjb2xsZWN0aW9uSWQiOiIwNGJmZjEyZS04NTdjLTFiNmEtNTc2OS0wMTQwMzg4NmE1NzkiLCJjb2xsZWN0aW9uTmFtZSI6ImZlbndhLTEifQ==</NextToken> <CidrCollections> <member> <Arn>arn:aws:route53:::cidrcollection/c8c02a84-aaaa-bbbb-e0d2-d833a2f80106</<Arn> <Id>c8c02a84-aaaa-bbbb-e0d2-d833a2f80106</Id> <Name>isp-city-cidrs</Name> <Version>1</ersion> </member> </CidrCollections> </ListCidrCollectionsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: