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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

For more information about transferring domains, see the following topics:

For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

Synopsis

data TransferDomain = TransferDomain' {
- authCode :: Maybe (Sensitive Text)
- autoRenew :: Maybe Bool
- idnLangCode :: Maybe Text
- nameservers :: Maybe [Nameserver]
- privacyProtectAdminContact :: Maybe Bool
- privacyProtectRegistrantContact :: Maybe Bool
- privacyProtectTechContact :: Maybe Bool
- domainName :: Text
- durationInYears :: Natural
- adminContact :: Sensitive ContactDetail
- registrantContact :: Sensitive ContactDetail
- techContact :: Sensitive ContactDetail
}
newTransferDomain :: Text -> Natural -> ContactDetail -> ContactDetail -> ContactDetail -> TransferDomain
transferDomain_authCode :: Lens' TransferDomain (Maybe Text)
transferDomain_autoRenew :: Lens' TransferDomain (Maybe Bool)
transferDomain_idnLangCode :: Lens' TransferDomain (Maybe Text)
transferDomain_nameservers :: Lens' TransferDomain (Maybe [Nameserver])
transferDomain_privacyProtectAdminContact :: Lens' TransferDomain (Maybe Bool)
transferDomain_privacyProtectRegistrantContact :: Lens' TransferDomain (Maybe Bool)
transferDomain_privacyProtectTechContact :: Lens' TransferDomain (Maybe Bool)
transferDomain_domainName :: Lens' TransferDomain Text
transferDomain_durationInYears :: Lens' TransferDomain Natural
transferDomain_adminContact :: Lens' TransferDomain ContactDetail
transferDomain_registrantContact :: Lens' TransferDomain ContactDetail
transferDomain_techContact :: Lens' TransferDomain ContactDetail
data TransferDomainResponse = TransferDomainResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
}
newTransferDomainResponse :: Int -> TransferDomainResponse
transferDomainResponse_operationId :: Lens' TransferDomainResponse (Maybe Text)
transferDomainResponse_httpStatus :: Lens' TransferDomainResponse Int

Creating a Request

data TransferDomain Source #

The TransferDomain request includes the following elements.

See: newTransferDomain smart constructor.

Constructors

TransferDomain'

Fields

authCode :: Maybe (Sensitive Text)
The authorization code for the domain. You get this value from the current registrar.
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.
nameservers :: Maybe [Nameserver]
Contains details for the host and glue IP addresses.
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 (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 name of the domain that you want to transfer to Route 53. 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.
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.
Default: 1
adminContact :: Sensitive ContactDetail
Provides detailed contact information.
registrantContact :: Sensitive ContactDetail
Provides detailed contact information.
techContact :: Sensitive ContactDetail
Provides detailed contact information.

Instances

Instances details

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

newTransferDomain Source #

Arguments

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

Create a value of TransferDomain 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:

$sel:authCode:TransferDomain', transferDomain_authCode - The authorization code for the domain. You get this value from the current registrar.

TransferDomain, transferDomain_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:TransferDomain', transferDomain_idnLangCode - Reserved for future use.

$sel:nameservers:TransferDomain', transferDomain_nameservers - Contains details for the host and glue IP addresses.

$sel:privacyProtectAdminContact:TransferDomain', transferDomain_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:TransferDomain', transferDomain_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 (domain owner).

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

Default: true

$sel:privacyProtectTechContact:TransferDomain', transferDomain_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

TransferDomain, transferDomain_domainName - The name of the domain that you want to transfer to Route 53. 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.

$sel:durationInYears:TransferDomain', transferDomain_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.

Default: 1

$sel:adminContact:TransferDomain', transferDomain_adminContact - Provides detailed contact information.

$sel:registrantContact:TransferDomain', transferDomain_registrantContact - Provides detailed contact information.

$sel:techContact:TransferDomain', transferDomain_techContact - Provides detailed contact information.

Request Lenses

transferDomain_authCode :: Lens' TransferDomain (Maybe Text) Source #

The authorization code for the domain. You get this value from the current registrar.

transferDomain_autoRenew :: Lens' TransferDomain (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

transferDomain_idnLangCode :: Lens' TransferDomain (Maybe Text) Source #

Reserved for future use.

transferDomain_nameservers :: Lens' TransferDomain (Maybe [Nameserver]) Source #

Contains details for the host and glue IP addresses.

transferDomain_privacyProtectAdminContact :: Lens' TransferDomain (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

transferDomain_privacyProtectRegistrantContact :: Lens' TransferDomain (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 (domain owner).

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

Default: true

transferDomain_privacyProtectTechContact :: Lens' TransferDomain (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

transferDomain_domainName :: Lens' TransferDomain Text Source #

The name of the domain that you want to transfer to Route 53. 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.

transferDomain_durationInYears :: Lens' TransferDomain 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.

Default: 1

transferDomain_adminContact :: Lens' TransferDomain ContactDetail Source #

Provides detailed contact information.

transferDomain_registrantContact :: Lens' TransferDomain ContactDetail Source #

Provides detailed contact information.

transferDomain_techContact :: Lens' TransferDomain ContactDetail Source #

Provides detailed contact information.

Destructuring the Response

data TransferDomainResponse Source #

The TransferDomain response includes the following element.

See: newTransferDomainResponse smart constructor.

Constructors

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

newTransferDomainResponse Source #

Arguments

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

Create a value of TransferDomainResponse 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:

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

$sel:httpStatus:TransferDomainResponse', transferDomainResponse_httpStatus - The response's http status code.

Response Lenses

transferDomainResponse_operationId :: Lens' TransferDomainResponse (Maybe Text) Source #

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

transferDomainResponse_httpStatus :: Lens' TransferDomainResponse Int Source #

The response's http status code.