NAME

Paws::Route53Domains::GetDomainSuggestions - Arguments for method GetDomainSuggestions on Paws::Route53Domains

DESCRIPTION

This class represents the parameters used for calling the method GetDomainSuggestions on the Amazon Route 53 Domains service. Use the attributes of this class as arguments to method GetDomainSuggestions.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDomainSuggestions.

SYNOPSIS

    my $route53domains = Paws->service('Route53Domains');
    my $GetDomainSuggestionsResponse = $route53domains->GetDomainSuggestions(
      DomainName      => 'MyDomainName',
      OnlyAvailable   => 1,
      SuggestionCount => 1,
    );
    # Results:
    my $SuggestionsList = $GetDomainSuggestionsResponse->SuggestionsList;
    # Returns a L<Paws::Route53Domains::GetDomainSuggestionsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/route53domains/GetDomainSuggestions>

ATTRIBUTES

REQUIRED DomainName => Str

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the "." in "example.com".

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html).

REQUIRED OnlyAvailable => Bool

If "OnlyAvailable" is "true", Route 53 returns only domain names that are available. If "OnlyAvailable" is "false", Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call "checkDomainAvailability" for each suggestion.

REQUIRED SuggestionCount => Int

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>