You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Route53Domains::Types::GetDomainSuggestionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb

Overview

Note:

When making an API call, you may pass GetDomainSuggestionsRequest data as a hash:

{
  domain_name: "DomainName", # required
  suggestion_count: 1, # required
  only_available: false, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

Returns:

  • (String)


866
867
868
869
870
871
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 866

class GetDomainSuggestionsRequest < Struct.new(
  :domain_name,
  :suggestion_count,
  :only_available)
  include Aws::Structure
end

#only_availableBoolean

If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon 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.

Returns:

  • (Boolean)


866
867
868
869
870
871
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 866

class GetDomainSuggestionsRequest < Struct.new(
  :domain_name,
  :suggestion_count,
  :only_available)
  include Aws::Structure
end

#suggestion_countInteger

The number of suggested domain names that you want Amazon Route 53 to return.

Returns:

  • (Integer)


866
867
868
869
870
871
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 866

class GetDomainSuggestionsRequest < Struct.new(
  :domain_name,
  :suggestion_count,
  :only_available)
  include Aws::Structure
end