Network.AWS.Route53Domains.RegisterDomain

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

• Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
• Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
• Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
• If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
• Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing .

Creating a Request

registerDomain

Arguments

:: Text

rDomainName

-> Natural

rDurationInYears

-> ContactDetail

rAdminContact

-> ContactDetail

rRegistrantContact

-> ContactDetail

rTechContact

-> RegisterDomain

Creates a value of RegisterDomain with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rPrivacyProtectTechContact - Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the technical contact. Default: true
• rPrivacyProtectRegistrantContact - Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the registrant contact (the domain owner). Default: true
• rAutoRenew - Indicates whether the domain will be automatically renewed (true ) or not (false ). Autorenewal only takes effect after the account is charged. Default: true
• rPrivacyProtectAdminContact - Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the admin contact. Default: true
• rIdNLangCode - Reserved for future use.
• rDomainName - The domain name that you want to register. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
• rDurationInYears - The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide . Default: 1
• rAdminContact - Provides detailed contact information.
• rRegistrantContact - Provides detailed contact information.
• rTechContact - Provides detailed contact information.

data RegisterDomain

The RegisterDomain request includes the following elements.

See: registerDomain smart constructor.

Instances

Eq RegisterDomain

Methods

(==) :: RegisterDomain -> RegisterDomain -> Bool

(/=) :: RegisterDomain -> RegisterDomain -> Bool

Data RegisterDomain

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDomain -> c RegisterDomain

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDomain

toConstr :: RegisterDomain -> Constr

dataTypeOf :: RegisterDomain -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDomain)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDomain)

gmapT :: (forall b. Data b => b -> b) -> RegisterDomain -> RegisterDomain

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomain -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomain -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterDomain -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDomain -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain

Show RegisterDomain

Methods

showsPrec :: Int -> RegisterDomain -> ShowS

show :: RegisterDomain -> String

showList :: [RegisterDomain] -> ShowS

Generic RegisterDomain

Associated Types

type Rep RegisterDomain :: * -> *

Methods

from :: RegisterDomain -> Rep RegisterDomain x

to :: Rep RegisterDomain x -> RegisterDomain

Hashable RegisterDomain

Methods

hashWithSalt :: Int -> RegisterDomain -> Int

hash :: RegisterDomain -> Int

ToJSON RegisterDomain

Methods

toJSON :: RegisterDomain -> Value

toEncoding :: RegisterDomain -> Encoding

toJSONList :: [RegisterDomain] -> Value

toEncodingList :: [RegisterDomain] -> Encoding

NFData RegisterDomain

Methods

rnf :: RegisterDomain -> ()

AWSRequest RegisterDomain

Associated Types

type Rs RegisterDomain :: *

Methods

request :: RegisterDomain -> Request RegisterDomain

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RegisterDomain -> ClientResponse -> m (Response RegisterDomain)

ToHeaders RegisterDomain

Methods

toHeaders :: RegisterDomain -> [Header]

ToPath RegisterDomain

Methods

toPath :: RegisterDomain -> ByteString

ToQuery RegisterDomain

Methods

toQuery :: RegisterDomain -> QueryString

type Rep RegisterDomain

type Rep RegisterDomain = D1 * (MetaData "RegisterDomain" "Network.AWS.Route53Domains.RegisterDomain" "amazonka-route53-domains-1.6.0-DMj3MRpMzLoGzgJ257wZEh" False) (C1 * (MetaCons "RegisterDomain'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rPrivacyProtectTechContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_rPrivacyProtectRegistrantContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rAutoRenew") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rPrivacyProtectAdminContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_rIdNLangCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rDurationInYears") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rAdminContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive ContactDetail))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rRegistrantContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive ContactDetail))) (S1 * (MetaSel (Just Symbol "_rTechContact") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive ContactDetail))))))))

type Rs RegisterDomain

type Rs RegisterDomain = RegisterDomainResponse

Request Lenses

rPrivacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool)

Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the technical contact. Default: true

rPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool)

Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the registrant contact (the domain owner). Default: true

rAutoRenew :: Lens' RegisterDomain (Maybe Bool)

Indicates whether the domain will be automatically renewed (true ) or not (false ). Autorenewal only takes effect after the account is charged. Default: true

rPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool)

Whether you want to conceal contact information from WHOIS queries. If you specify true , WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the admin contact. Default: true

rIdNLangCode :: Lens' RegisterDomain (Maybe Text)

Reserved for future use.

rDomainName :: Lens' RegisterDomain Text

The domain name that you want to register. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

rDurationInYears :: Lens' RegisterDomain Natural

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide . Default: 1

rAdminContact :: Lens' RegisterDomain ContactDetail

Provides detailed contact information.

rRegistrantContact :: Lens' RegisterDomain ContactDetail

Provides detailed contact information.

rTechContact :: Lens' RegisterDomain ContactDetail

Provides detailed contact information.

Destructuring the Response

registerDomainResponse

Arguments

:: Int

rdrsResponseStatus

-> Text

rdrsOperationId

-> RegisterDomainResponse

Creates a value of RegisterDomainResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdrsResponseStatus - -- | The response status code.
• rdrsOperationId - Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

data RegisterDomainResponse

The RegisterDomain response includes the following element.

See: registerDomainResponse smart constructor.

Instances

Eq RegisterDomainResponse

Methods

(==) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool

(/=) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool

Data RegisterDomainResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDomainResponse -> c RegisterDomainResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDomainResponse

toConstr :: RegisterDomainResponse -> Constr

dataTypeOf :: RegisterDomainResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDomainResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDomainResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterDomainResponse -> RegisterDomainResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomainResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomainResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterDomainResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDomainResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse

Read RegisterDomainResponse

Methods

readsPrec :: Int -> ReadS RegisterDomainResponse

readList :: ReadS [RegisterDomainResponse]

readPrec :: ReadPrec RegisterDomainResponse

readListPrec :: ReadPrec [RegisterDomainResponse]

Show RegisterDomainResponse

Methods

showsPrec :: Int -> RegisterDomainResponse -> ShowS

show :: RegisterDomainResponse -> String

showList :: [RegisterDomainResponse] -> ShowS

Generic RegisterDomainResponse

Associated Types

type Rep RegisterDomainResponse :: * -> *

Methods

from :: RegisterDomainResponse -> Rep RegisterDomainResponse x

to :: Rep RegisterDomainResponse x -> RegisterDomainResponse

NFData RegisterDomainResponse

Methods

rnf :: RegisterDomainResponse -> ()

type Rep RegisterDomainResponse

type Rep RegisterDomainResponse = D1 * (MetaData "RegisterDomainResponse" "Network.AWS.Route53Domains.RegisterDomain" "amazonka-route53-domains-1.6.0-DMj3MRpMzLoGzgJ257wZEh" False) (C1 * (MetaCons "RegisterDomainResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_rdrsOperationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

Response Lenses

rdrsResponseStatus :: Lens' RegisterDomainResponse Int

• - | The response status code.

rdrsOperationId :: Lens' RegisterDomainResponse Text

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .