import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListHostedZonesByNameRequest, ListHostedZonesByNameResponse } from "../models/models_0"; import type { Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListHostedZonesByNameCommand}. */ export interface ListHostedZonesByNameCommandInput extends ListHostedZonesByNameRequest { } /** * @public * * The output of {@link ListHostedZonesByNameCommand}. */ export interface ListHostedZonesByNameCommandOutput extends ListHostedZonesByNameResponse, __MetadataBearer { } declare const ListHostedZonesByNameCommand_base: { new (input: ListHostedZonesByNameCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [ListHostedZonesByNameCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Retrieves a list of your hosted zones in lexicographic order. The response includes a * HostedZones child element for each hosted zone created by the current * Amazon Web Services account.

*

* ListHostedZonesByName sorts hosted zones by name with the labels * reversed. For example:

*

* com.example.www. *

*

Note the trailing dot, which can change the sort order in some circumstances.

*

If the domain name includes escape characters or Punycode, * ListHostedZonesByName alphabetizes the domain name using the escaped or * Punycoded value, which is the format that Amazon Route 53 saves in its database. For * example, to create a hosted zone for exämple.com, you specify ex\344mple.com for * the domain name. ListHostedZonesByName alphabetizes it as:

*

* com.ex\344mple. *

*

The labels are reversed and alphabetized using the escaped value. For more information * about valid domain name formats, including internationalized domain names, see DNS * Domain Name Format in the Amazon Route 53 Developer * Guide.

*

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, * use the MaxItems parameter to list them in groups of up to 100. The * response includes values that help navigate from one group of MaxItems * hosted zones to the next:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { Route53Client, ListHostedZonesByNameCommand } from "@aws-sdk/client-route-53"; // ES Modules import * // const { Route53Client, ListHostedZonesByNameCommand } = require("@aws-sdk/client-route-53"); // CommonJS import * // import type { Route53ClientConfig } from "@aws-sdk/client-route-53"; * const config = {}; // type is Route53ClientConfig * const client = new Route53Client(config); * const input = { // ListHostedZonesByNameRequest * DNSName: "STRING_VALUE", * HostedZoneId: "STRING_VALUE", * MaxItems: Number("int"), * }; * const command = new ListHostedZonesByNameCommand(input); * const response = await client.send(command); * // { // ListHostedZonesByNameResponse * // HostedZones: [ // HostedZones // required * // { // HostedZone * // Id: "STRING_VALUE", // required * // Name: "STRING_VALUE", // required * // CallerReference: "STRING_VALUE", // required * // Config: { // HostedZoneConfig * // Comment: "STRING_VALUE", * // PrivateZone: true || false, * // }, * // ResourceRecordSetCount: Number("long"), * // LinkedService: { // LinkedService * // ServicePrincipal: "STRING_VALUE", * // Description: "STRING_VALUE", * // }, * // Features: { // HostedZoneFeatures * // AcceleratedRecoveryStatus: "ENABLING" || "ENABLE_FAILED" || "ENABLING_HOSTED_ZONE_LOCKED" || "ENABLED" || "DISABLING" || "DISABLE_FAILED" || "DISABLED" || "DISABLING_HOSTED_ZONE_LOCKED", * // FailureReasons: { // HostedZoneFailureReasons * // AcceleratedRecovery: "STRING_VALUE", * // }, * // }, * // }, * // ], * // DNSName: "STRING_VALUE", * // HostedZoneId: "STRING_VALUE", * // IsTruncated: true || false, // required * // NextDNSName: "STRING_VALUE", * // NextHostedZoneId: "STRING_VALUE", * // MaxItems: Number("int"), // required * // }; * * ``` * * @param ListHostedZonesByNameCommandInput - {@link ListHostedZonesByNameCommandInput} * @returns {@link ListHostedZonesByNameCommandOutput} * @see {@link ListHostedZonesByNameCommandInput} for command's `input` shape. * @see {@link ListHostedZonesByNameCommandOutput} for command's `response` shape. * @see {@link Route53ClientResolvedConfig | config} for Route53Client's `config` shape. * * @throws {@link InvalidDomainName} (client fault) *

The specified domain name is not valid.

* * @throws {@link InvalidInput} (client fault) *

The input is not valid.

* * @throws {@link Route53ServiceException} *

Base exception class for all service exceptions from Route53 service.

* * * @public */ export declare class ListHostedZonesByNameCommand extends ListHostedZonesByNameCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListHostedZonesByNameRequest; output: ListHostedZonesByNameResponse; }; sdk: { input: ListHostedZonesByNameCommandInput; output: ListHostedZonesByNameCommandOutput; }; }; }