ListCidrCollectionsCommand

Suggest an Edit

Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Route53Client, ListCidrCollectionsCommand } from "@aws-sdk/client-route-53"; // ES Modules import
// const { Route53Client, ListCidrCollectionsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import
const client = new Route53Client(config);
const input = { // ListCidrCollectionsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListCidrCollectionsCommand(input);
const response = await client.send(command);
// { // ListCidrCollectionsResponse
//   NextToken: "STRING_VALUE",
//   CidrCollections: [ // CollectionSummaries
//     { // CollectionSummary
//       Arn: "STRING_VALUE",
//       Id: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Version: Number("long"),
//     },
//   ],
// };

ListCidrCollectionsCommand Input

See ListCidrCollectionsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of CIDR collections to return in the response.

NextToken
string | undefined

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.

ListCidrCollectionsCommand Output

See ListCidrCollectionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CidrCollections
CollectionSummary[] | undefined

A complex type with information about the CIDR collection.

NextToken
string | undefined

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.

Throws

Name
Fault
Details
InvalidInput
client

The input is not valid.

Route53ServiceException
Base exception class for all service exceptions from Route53 service.