amazonka-route53-domains-1.4.5: Amazon Route 53 Domains SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53Domains.RegisterDomain

Contents

Description

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. 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 for our registrar partner, Gandi, instead of the information you entered for 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 .

Synopsis

Creating a Request

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 will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No
  • rPrivacyProtectRegistrantContact - Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No
  • rAutoRenew - Indicates whether the domain will be automatically renewed (true ) or not (false ). Autorenewal only takes effect after the account is charged. Type: Boolean Valid values: true | false Default: true Required: No
  • rPrivacyProtectAdminContact - Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No
  • rIdNLangCode - Reserved for future use.
  • rDomainName - The name of a domain. Type: String Default: None 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. Required: Yes
  • rDurationInYears - The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Type: Integer Default: 1 Valid values: Integer from 1 to 10 Required: Yes
  • rAdminContact - Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes
  • rRegistrantContact - Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes
  • rTechContact - Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes

data RegisterDomain #

The RegisterDomain request includes the following elements.

See: registerDomain smart constructor.

Instances

Eq RegisterDomain # 
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 #

Read RegisterDomain # 
Show RegisterDomain # 
Generic RegisterDomain # 

Associated Types

type Rep RegisterDomain :: * -> * #

Hashable RegisterDomain # 
ToJSON RegisterDomain # 
NFData RegisterDomain # 

Methods

rnf :: RegisterDomain -> () #

AWSRequest RegisterDomain # 
ToQuery RegisterDomain # 
ToPath RegisterDomain # 
ToHeaders RegisterDomain # 
type Rep RegisterDomain # 
type Rs RegisterDomain # 

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 will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No

rPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool) #

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No

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. Type: Boolean Valid values: true | false Default: true Required: No

rPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool) #

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No

rIdNLangCode :: Lens' RegisterDomain (Maybe Text) #

Reserved for future use.

rDomainName :: Lens' RegisterDomain Text #

The name of a domain. Type: String Default: None 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. Required: Yes

rDurationInYears :: Lens' RegisterDomain Natural #

The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Type: Integer Default: 1 Valid values: Integer from 1 to 10 Required: Yes

rAdminContact :: Lens' RegisterDomain ContactDetail #

Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes

rRegistrantContact :: Lens' RegisterDomain ContactDetail #

Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes

rTechContact :: Lens' RegisterDomain ContactDetail #

Provides detailed contact information. Type: Complex Children: FirstName , MiddleName , LastName , ContactType , OrganizationName , AddressLine1 , AddressLine2 , City , State , CountryCode , ZipCode , PhoneNumber , Email , Fax , ExtraParams Required: Yes

Destructuring the Response

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. Type: String Default: None Constraints: Maximum 255 characters.

data RegisterDomainResponse #

The RegisterDomain response includes the following element.

See: registerDomainResponse smart constructor.

Instances

Eq RegisterDomainResponse # 
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 # 
Show RegisterDomainResponse # 
Generic RegisterDomainResponse # 
NFData RegisterDomainResponse # 

Methods

rnf :: RegisterDomainResponse -> () #

type Rep RegisterDomainResponse # 
type Rep RegisterDomainResponse = D1 (MetaData "RegisterDomainResponse" "Network.AWS.Route53Domains.RegisterDomain" "amazonka-route53-domains-1.4.5-6DkjyS06xBH5RIxQNY8K9j" False) (C1 (MetaCons "RegisterDomainResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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. Type: String Default: None Constraints: Maximum 255 characters.