Skip to content

GetDomainSuggestions

Source: src/AWS/Route53Domains/GetDomainSuggestions.ts

Runtime binding for route53domains:GetDomainSuggestions — return a list of suggested domain names based on a seed name, optionally restricted to names that are currently available for registration.

Route 53 Domains is a global registration API with no resource-level IAM: the binding takes no arguments and grants the function route53domains:GetDomainSuggestions on *. Calls are pinned to us-east-1, the only region that serves the Route 53 Domains API, regardless of where the function runs.

Provide the implementation with Effect.provide(AWS.Route53Domains.GetDomainSuggestionsHttp).

// init
const getDomainSuggestions =
yield* AWS.Route53Domains.GetDomainSuggestions();
// runtime
const result = yield* getDomainSuggestions({
DomainName: "example.com",
SuggestionCount: 10,
OnlyAvailable: true,
});
const names = (result.SuggestionsList ?? []).map((s) => s.DomainName);