Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Route53Domains.RegisterDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables auto renew, 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 administrative, registrant, and technical contacts.
You must specify the same privacy setting for the administrative, registrant, and technical 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 Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

Synopsis

data RegisterDomain = RegisterDomain' {
- autoRenew :: Maybe Bool
- idnLangCode :: Maybe Text
- privacyProtectAdminContact :: Maybe Bool
- privacyProtectRegistrantContact :: Maybe Bool
- privacyProtectTechContact :: Maybe Bool
- domainName :: Text
- durationInYears :: Natural
- adminContact :: Sensitive ContactDetail
- registrantContact :: Sensitive ContactDetail
- techContact :: Sensitive ContactDetail
}
newRegisterDomain :: Text -> Natural -> ContactDetail -> ContactDetail -> ContactDetail -> RegisterDomain
registerDomain_autoRenew :: Lens' RegisterDomain (Maybe Bool)
registerDomain_idnLangCode :: Lens' RegisterDomain (Maybe Text)
registerDomain_privacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool)
registerDomain_privacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool)
registerDomain_privacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool)
registerDomain_domainName :: Lens' RegisterDomain Text
registerDomain_durationInYears :: Lens' RegisterDomain Natural
registerDomain_adminContact :: Lens' RegisterDomain ContactDetail
registerDomain_registrantContact :: Lens' RegisterDomain ContactDetail
registerDomain_techContact :: Lens' RegisterDomain ContactDetail
data RegisterDomainResponse = RegisterDomainResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
}
newRegisterDomainResponse :: Int -> RegisterDomainResponse
registerDomainResponse_operationId :: Lens' RegisterDomainResponse (Maybe Text)
registerDomainResponse_httpStatus :: Lens' RegisterDomainResponse Int

Creating a Request

data RegisterDomain Source #

The RegisterDomain request includes the following elements.

See: newRegisterDomain smart constructor.

Constructors

RegisterDomain'

Fields

autoRenew :: Maybe Bool
Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.
Default: true
idnLangCode :: Maybe Text
Reserved for future use.
privacyProtectAdminContact :: 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.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
Default: true
privacyProtectRegistrantContact :: 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).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
Default: true
privacyProtectTechContact :: 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.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
Default: true
domainName :: Text
The domain name that you want to register. 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 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. For more information, see Formatting Internationalized Domain Names.
durationInYears :: 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
adminContact :: Sensitive ContactDetail
Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
registrantContact :: Sensitive ContactDetail
Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
techContact :: Sensitive ContactDetail
Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Instances

Instances details

ToJSON RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods toJSON :: RegisterDomain -> Value # toEncoding :: RegisterDomain -> Encoding # toJSONList :: [RegisterDomain] -> Value # toEncodingList :: [RegisterDomain] -> Encoding #
ToHeaders RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods toHeaders :: RegisterDomain -> [Header] #
ToPath RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods toPath :: RegisterDomain -> ByteString #
ToQuery RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods toQuery :: RegisterDomain -> QueryString #
AWSRequest RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Associated Types type AWSResponse RegisterDomain # Methods request :: (Service -> Service) -> RegisterDomain -> Request RegisterDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterDomain))) #
Generic RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Associated Types type Rep RegisterDomain :: Type -> Type # Methods from :: RegisterDomain -> Rep RegisterDomain x # to :: Rep RegisterDomain x -> RegisterDomain #
Show RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods showsPrec :: Int -> RegisterDomain -> ShowS # show :: RegisterDomain -> String # showList :: [RegisterDomain] -> ShowS #
NFData RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods rnf :: RegisterDomain -> () #
Eq RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods (==) :: RegisterDomain -> RegisterDomain -> Bool # (/=) :: RegisterDomain -> RegisterDomain -> Bool #
Hashable RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods hashWithSalt :: Int -> RegisterDomain -> Int # hash :: RegisterDomain -> Int #
type AWSResponse RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain type AWSResponse RegisterDomain = RegisterDomainResponse
type Rep RegisterDomain Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain type Rep RegisterDomain = D1 ('MetaData "RegisterDomain" "Amazonka.Route53Domains.RegisterDomain" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "RegisterDomain'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoRenew") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "idnLangCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "privacyProtectAdminContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "privacyProtectRegistrantContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "privacyProtectTechContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "durationInYears") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "adminContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail)) :: (S1 ('MetaSel ('Just "registrantContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail)) :*: S1 ('MetaSel ('Just "techContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail)))))))

newRegisterDomain Source #

Arguments

:: Text	`RegisterDomain`
-> Natural	`$sel:durationInYears:RegisterDomain'`
-> ContactDetail	`$sel:adminContact:RegisterDomain'`
-> ContactDetail	`$sel:registrantContact:RegisterDomain'`
-> ContactDetail	`$sel:techContact:RegisterDomain'`
-> RegisterDomain

Create a value of RegisterDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterDomain, registerDomain_autoRenew - Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.

Default: true

$sel:idnLangCode:RegisterDomain', registerDomain_idnLangCode - Reserved for future use.

$sel:privacyProtectAdminContact:RegisterDomain', registerDomain_privacyProtectAdminContact - 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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

$sel:privacyProtectRegistrantContact:RegisterDomain', registerDomain_privacyProtectRegistrantContact - 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).

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

$sel:privacyProtectTechContact:RegisterDomain', registerDomain_privacyProtectTechContact - 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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

RegisterDomain, registerDomain_domainName - The domain name that you want to register. 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 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. For more information, see Formatting Internationalized Domain Names.

$sel:durationInYears:RegisterDomain', registerDomain_durationInYears - 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

$sel:adminContact:RegisterDomain', registerDomain_adminContact - Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

$sel:registrantContact:RegisterDomain', registerDomain_registrantContact - Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

$sel:techContact:RegisterDomain', registerDomain_techContact - Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Request Lenses

registerDomain_autoRenew :: Lens' RegisterDomain (Maybe Bool) Source #

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

Default: true

registerDomain_idnLangCode :: Lens' RegisterDomain (Maybe Text) Source #

Reserved for future use.

registerDomain_privacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool) Source #

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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

registerDomain_privacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool) Source #

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).

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

registerDomain_privacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool) Source #

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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

Default: true

registerDomain_domainName :: Lens' RegisterDomain Text Source #

The domain name that you want to register. 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 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. For more information, see Formatting Internationalized Domain Names.

registerDomain_durationInYears :: Lens' RegisterDomain Natural Source #

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

registerDomain_adminContact :: Lens' RegisterDomain ContactDetail Source #

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

registerDomain_registrantContact :: Lens' RegisterDomain ContactDetail Source #

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

registerDomain_techContact :: Lens' RegisterDomain ContactDetail Source #

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Destructuring the Response

data RegisterDomainResponse Source #

The RegisterDomain response includes the following element.

See: newRegisterDomainResponse smart constructor.

Constructors

RegisterDomainResponse'
Fields operationId :: Maybe Text Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Associated Types type Rep RegisterDomainResponse :: Type -> Type # Methods from :: RegisterDomainResponse -> Rep RegisterDomainResponse x # to :: Rep RegisterDomainResponse x -> RegisterDomainResponse #
Read RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods readsPrec :: Int -> ReadS RegisterDomainResponse # readList :: ReadS [RegisterDomainResponse] # readPrec :: ReadPrec RegisterDomainResponse # readListPrec :: ReadPrec [RegisterDomainResponse] #
Show RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods showsPrec :: Int -> RegisterDomainResponse -> ShowS # show :: RegisterDomainResponse -> String # showList :: [RegisterDomainResponse] -> ShowS #
NFData RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods rnf :: RegisterDomainResponse -> () #
Eq RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain Methods (==) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool # (/=) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool #
type Rep RegisterDomainResponse Source #
Instance details Defined in Amazonka.Route53Domains.RegisterDomain type Rep RegisterDomainResponse = D1 ('MetaData "RegisterDomainResponse" "Amazonka.Route53Domains.RegisterDomain" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "RegisterDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterDomainResponse'`
-> RegisterDomainResponse

Create a value of RegisterDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterDomainResponse, registerDomainResponse_operationId - Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.

$sel:httpStatus:RegisterDomainResponse', registerDomainResponse_httpStatus - The response's http status code.

Response Lenses

registerDomainResponse_operationId :: Lens' RegisterDomainResponse (Maybe Text) Source #

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

registerDomainResponse_httpStatus :: Lens' RegisterDomainResponse Int Source #

The response's http status code.