| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Route53Domains
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListOperations (Paginated)
- GetDomainDetail
- UpdateDomainContactPrivacy
- GetOperationDetail
- EnableDomainAutoRenew
- ResendContactReachabilityEmail
- DisableDomainAutoRenew
- RenewDomain
- ViewBilling
- UpdateDomainContact
- EnableDomainTransferLock
- RegisterDomain
- GetDomainSuggestions
- DisableDomainTransferLock
- CheckDomainAvailability
- GetContactReachabilityStatus
- ListTagsForDomain
- UpdateDomainNameservers
- DeleteTagsForDomain
- UpdateTagsForDomain
- RetrieveDomainAuthCode
- TransferDomain
- ListDomains (Paginated)
- Types
Description
Pending
- route53Domains :: Service
- _InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _DomainLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedTLD :: AsError a => Getting (First ServiceError) a ServiceError
- _TLDRulesViolation :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Route53Domains.ListOperations
- module Network.AWS.Route53Domains.GetDomainDetail
- module Network.AWS.Route53Domains.UpdateDomainContactPrivacy
- module Network.AWS.Route53Domains.GetOperationDetail
- module Network.AWS.Route53Domains.EnableDomainAutoRenew
- module Network.AWS.Route53Domains.ResendContactReachabilityEmail
- module Network.AWS.Route53Domains.DisableDomainAutoRenew
- module Network.AWS.Route53Domains.RenewDomain
- module Network.AWS.Route53Domains.ViewBilling
- module Network.AWS.Route53Domains.UpdateDomainContact
- module Network.AWS.Route53Domains.EnableDomainTransferLock
- module Network.AWS.Route53Domains.RegisterDomain
- module Network.AWS.Route53Domains.GetDomainSuggestions
- module Network.AWS.Route53Domains.DisableDomainTransferLock
- module Network.AWS.Route53Domains.CheckDomainAvailability
- module Network.AWS.Route53Domains.GetContactReachabilityStatus
- module Network.AWS.Route53Domains.ListTagsForDomain
- module Network.AWS.Route53Domains.UpdateDomainNameservers
- module Network.AWS.Route53Domains.DeleteTagsForDomain
- module Network.AWS.Route53Domains.UpdateTagsForDomain
- module Network.AWS.Route53Domains.RetrieveDomainAuthCode
- module Network.AWS.Route53Domains.TransferDomain
- module Network.AWS.Route53Domains.ListDomains
- data ContactType
- data CountryCode
- = AD
- | AE
- | AF
- | AG
- | AI
- | AL
- | AM
- | AN
- | AO
- | AQ
- | AR
- | AS
- | AT
- | AU
- | AW
- | AZ
- | BA
- | BB
- | BD
- | BE
- | BF
- | BG
- | BH
- | BI
- | BJ
- | BL
- | BM
- | BN
- | BO
- | BR
- | BS
- | BT
- | BW
- | BY
- | BZ
- | CA
- | CC
- | CD
- | CF
- | CG
- | CH
- | CI
- | CK
- | CL
- | CM
- | CN
- | CO
- | CR
- | CU
- | CV
- | CX
- | CY
- | CZ
- | DE
- | DJ
- | DK
- | DM
- | DO
- | DZ
- | EC
- | EE
- | EG
- | ER
- | ES
- | ET
- | FI
- | FJ
- | FK
- | FM
- | FO
- | FR
- | GA
- | GB
- | GD
- | GE
- | GH
- | GI
- | GL
- | GM
- | GN
- | GQ
- | GR
- | GT'
- | GU
- | GW
- | GY
- | HK
- | HN
- | HR
- | HT
- | HU
- | IE
- | IL
- | IM
- | IN
- | IQ
- | IR
- | IS
- | IT
- | Id
- | JM
- | JO
- | JP
- | KE
- | KG
- | KH
- | KI
- | KM
- | KN
- | KP
- | KR
- | KW
- | KY
- | KZ
- | LA
- | LB
- | LC
- | LI
- | LK
- | LR
- | LS
- | LT'
- | LU
- | LV
- | LY
- | MA
- | MC
- | MD
- | ME
- | MF
- | MG
- | MH
- | MK
- | ML
- | MM
- | MN
- | MO
- | MP
- | MR
- | MS
- | MT
- | MU
- | MV
- | MW
- | MX
- | MY
- | MZ
- | NA
- | NC
- | NE
- | NG
- | NI
- | NL
- | NO
- | NP
- | NR
- | NU
- | NZ
- | OM
- | PA
- | PE
- | PF
- | PG
- | PH
- | PK
- | PL
- | PM
- | PN
- | PR
- | PT
- | PW
- | PY
- | QA
- | RO
- | RS
- | RU
- | RW
- | SA
- | SB
- | SC
- | SD
- | SE
- | SG
- | SH
- | SI
- | SK
- | SL
- | SM
- | SN
- | SO
- | SR
- | ST
- | SV
- | SY
- | SZ
- | TC
- | TD
- | TG
- | TH
- | TJ
- | TK
- | TL
- | TM
- | TN
- | TO
- | TR
- | TT
- | TV
- | TW
- | TZ
- | UA
- | UG
- | US
- | UY
- | UZ
- | VA
- | VC
- | VE
- | VG
- | VI
- | VN
- | VU
- | WF
- | WS
- | YE
- | YT
- | ZA
- | ZM
- | ZW
- data DomainAvailability
- data ExtraParamName
- = AuIdNumber
- | AuIdType
- | BirthCity
- | BirthCountry
- | BirthDateInYyyyMmDd
- | BirthDepartment
- | BrandNumber
- | CaBusinessEntityType
- | CaLegalType
- | DocumentNumber
- | DunsNumber
- | EsIdentification
- | EsIdentificationType
- | EsLegalForm
- | FiBusinessNumber
- | FiIdNumber
- | ItPin
- | RuPassportData
- | SeIdNumber
- | SgIdNumber
- | VatNumber
- data OperationStatus
- data OperationType
- data ReachabilityStatus
- data BillingRecord
- billingRecord :: BillingRecord
- brOperation :: Lens' BillingRecord (Maybe OperationType)
- brInvoiceId :: Lens' BillingRecord (Maybe Text)
- brDomainName :: Lens' BillingRecord (Maybe Text)
- brBillDate :: Lens' BillingRecord (Maybe UTCTime)
- brPrice :: Lens' BillingRecord (Maybe Double)
- data ContactDetail
- contactDetail :: ContactDetail
- cdOrganizationName :: Lens' ContactDetail (Maybe Text)
- cdEmail :: Lens' ContactDetail (Maybe Text)
- cdState :: Lens' ContactDetail (Maybe Text)
- cdFax :: Lens' ContactDetail (Maybe Text)
- cdLastName :: Lens' ContactDetail (Maybe Text)
- cdExtraParams :: Lens' ContactDetail [ExtraParam]
- cdZipCode :: Lens' ContactDetail (Maybe Text)
- cdAddressLine1 :: Lens' ContactDetail (Maybe Text)
- cdCity :: Lens' ContactDetail (Maybe Text)
- cdPhoneNumber :: Lens' ContactDetail (Maybe Text)
- cdAddressLine2 :: Lens' ContactDetail (Maybe Text)
- cdFirstName :: Lens' ContactDetail (Maybe Text)
- cdCountryCode :: Lens' ContactDetail (Maybe CountryCode)
- cdContactType :: Lens' ContactDetail (Maybe ContactType)
- data DomainSuggestion
- domainSuggestion :: DomainSuggestion
- dAvailability :: Lens' DomainSuggestion (Maybe Text)
- dDomainName :: Lens' DomainSuggestion (Maybe Text)
- data DomainSummary
- domainSummary :: Text -> DomainSummary
- dsExpiry :: Lens' DomainSummary (Maybe UTCTime)
- dsTransferLock :: Lens' DomainSummary (Maybe Bool)
- dsAutoRenew :: Lens' DomainSummary (Maybe Bool)
- dsDomainName :: Lens' DomainSummary Text
- data ExtraParam
- extraParam :: ExtraParamName -> Text -> ExtraParam
- epName :: Lens' ExtraParam ExtraParamName
- epValue :: Lens' ExtraParam Text
- data Nameserver
- nameserver :: Text -> Nameserver
- nGlueIPs :: Lens' Nameserver [Text]
- nName :: Lens' Nameserver Text
- data OperationSummary
- operationSummary :: Text -> OperationStatus -> OperationType -> UTCTime -> OperationSummary
- osOperationId :: Lens' OperationSummary Text
- osStatus :: Lens' OperationSummary OperationStatus
- osType :: Lens' OperationSummary OperationType
- osSubmittedDate :: Lens' OperationSummary UTCTime
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
Service Configuration
route53Domains :: Service Source #
API version 2014-05-15 of the Amazon Route 53 Domains SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Route53Domains.
InvalidInput
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
OperationLimitExceeded
_OperationLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of operations or jobs running exceeded the allowed threshold for the account.
DomainLimitExceeded
_DomainLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of domains has exceeded the allowed threshold for the account.
UnsupportedTLD
_UnsupportedTLD :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Route 53 does not support this top-level domain.
TLDRulesViolation
_TLDRulesViolation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The top-level domain does not support this operation.
DuplicateRequest
_DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is already in progress for the domain.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListOperations (Paginated)
GetDomainDetail
UpdateDomainContactPrivacy
GetOperationDetail
EnableDomainAutoRenew
ResendContactReachabilityEmail
DisableDomainAutoRenew
RenewDomain
ViewBilling
UpdateDomainContact
EnableDomainTransferLock
RegisterDomain
GetDomainSuggestions
DisableDomainTransferLock
CheckDomainAvailability
GetContactReachabilityStatus
ListTagsForDomain
UpdateDomainNameservers
DeleteTagsForDomain
UpdateTagsForDomain
RetrieveDomainAuthCode
TransferDomain
ListDomains (Paginated)
Types
ContactType
data ContactType Source #
Constructors
| Association | |
| Company | |
| Person | |
| PublicBody | |
| Reseller |
Instances
CountryCode
data CountryCode Source #
Constructors
| AD | |
| AE | |
| AF | |
| AG | |
| AI | |
| AL | |
| AM | |
| AN | |
| AO | |
| AQ | |
| AR | |
| AS | |
| AT | |
| AU | |
| AW | |
| AZ | |
| BA | |
| BB | |
| BD | |
| BE | |
| BF | |
| BG | |
| BH | |
| BI | |
| BJ | |
| BL | |
| BM | |
| BN | |
| BO | |
| BR | |
| BS | |
| BT | |
| BW | |
| BY | |
| BZ | |
| CA | |
| CC | |
| CD | |
| CF | |
| CG | |
| CH | |
| CI | |
| CK | |
| CL | |
| CM | |
| CN | |
| CO | |
| CR | |
| CU | |
| CV | |
| CX | |
| CY | |
| CZ | |
| DE | |
| DJ | |
| DK | |
| DM | |
| DO | |
| DZ | |
| EC | |
| EE | |
| EG | |
| ER | |
| ES | |
| ET | |
| FI | |
| FJ | |
| FK | |
| FM | |
| FO | |
| FR | |
| GA | |
| GB | |
| GD | |
| GE | |
| GH | |
| GI | |
| GL | |
| GM | |
| GN | |
| GQ | |
| GR | |
| GT' | |
| GU | |
| GW | |
| GY | |
| HK | |
| HN | |
| HR | |
| HT | |
| HU | |
| IE | |
| IL | |
| IM | |
| IN | |
| IQ | |
| IR | |
| IS | |
| IT | |
| Id | |
| JM | |
| JO | |
| JP | |
| KE | |
| KG | |
| KH | |
| KI | |
| KM | |
| KN | |
| KP | |
| KR | |
| KW | |
| KY | |
| KZ | |
| LA | |
| LB | |
| LC | |
| LI | |
| LK | |
| LR | |
| LS | |
| LT' | |
| LU | |
| LV | |
| LY | |
| MA | |
| MC | |
| MD | |
| ME | |
| MF | |
| MG | |
| MH | |
| MK | |
| ML | |
| MM | |
| MN | |
| MO | |
| MP | |
| MR | |
| MS | |
| MT | |
| MU | |
| MV | |
| MW | |
| MX | |
| MY | |
| MZ | |
| NA | |
| NC | |
| NE | |
| NG | |
| NI | |
| NL | |
| NO | |
| NP | |
| NR | |
| NU | |
| NZ | |
| OM | |
| PA | |
| PE | |
| PF | |
| PG | |
| PH | |
| PK | |
| PL | |
| PM | |
| PN | |
| PR | |
| PT | |
| PW | |
| PY | |
| QA | |
| RO | |
| RS | |
| RU | |
| RW | |
| SA | |
| SB | |
| SC | |
| SD | |
| SE | |
| SG | |
| SH | |
| SI | |
| SK | |
| SL | |
| SM | |
| SN | |
| SO | |
| SR | |
| ST | |
| SV | |
| SY | |
| SZ | |
| TC | |
| TD | |
| TG | |
| TH | |
| TJ | |
| TK | |
| TL | |
| TM | |
| TN | |
| TO | |
| TR | |
| TT | |
| TV | |
| TW | |
| TZ | |
| UA | |
| UG | |
| US | |
| UY | |
| UZ | |
| VA | |
| VC | |
| VE | |
| VG | |
| VI | |
| VN | |
| VU | |
| WF | |
| WS | |
| YE | |
| YT | |
| ZA | |
| ZM | |
| ZW |
Instances
DomainAvailability
data DomainAvailability Source #
Constructors
| Available | |
| AvailablePreorder | |
| AvailableReserved | |
| DontKnow | |
| Reserved | |
| Unavailable | |
| UnavailablePremium | |
| UnavailableRestricted |
Instances
ExtraParamName
data ExtraParamName Source #
Constructors
Instances
OperationStatus
data OperationStatus Source #
Constructors
| Error' | |
| Failed | |
| InProgress | |
| Submitted | |
| Successful |
Instances
OperationType
data OperationType Source #
Constructors
| ChangePrivacyProtection | |
| DeleteDomain | |
| DomainLock | |
| RegisterDomain | |
| TransferInDomain | |
| UpdateDomainContact | |
| UpdateNameserver |
Instances
ReachabilityStatus
data ReachabilityStatus Source #
Instances
BillingRecord
data BillingRecord Source #
See: billingRecord smart constructor.
billingRecord :: BillingRecord Source #
Creates a value of BillingRecord with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brOperation- The operation that you were charged for. Type: String Valid values: *REGISTER_DOMAIN*TRANSFER_IN_DOMAIN*RENEW_DOMAIN*CHANGE_DOMAIN_OWNERbrInvoiceId- The ID of the invoice that is associated with the billing record. Type: StringbrDomainName- The name of a domain. Type: StringbrBillDate- The date that the operation was billed, in Unix format. Type: DoublebrPrice- The price that you were charged for the operation, in US dollars. Type: Double Example value: 12.0
brOperation :: Lens' BillingRecord (Maybe OperationType) Source #
The operation that you were charged for. Type: String Valid values: * REGISTER_DOMAIN * TRANSFER_IN_DOMAIN * RENEW_DOMAIN * CHANGE_DOMAIN_OWNER
brInvoiceId :: Lens' BillingRecord (Maybe Text) Source #
The ID of the invoice that is associated with the billing record. Type: String
brDomainName :: Lens' BillingRecord (Maybe Text) Source #
The name of a domain. Type: String
brBillDate :: Lens' BillingRecord (Maybe UTCTime) Source #
The date that the operation was billed, in Unix format. Type: Double
brPrice :: Lens' BillingRecord (Maybe Double) Source #
The price that you were charged for the operation, in US dollars. Type: Double Example value: 12.0
ContactDetail
data ContactDetail Source #
ContactDetail includes the following elements.
See: contactDetail smart constructor.
Instances
contactDetail :: ContactDetail Source #
Creates a value of ContactDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdOrganizationName- Name of the organization for contact types other thanPERSON. Type: String Default: None Constraints: Maximum 255 characters. Contact type must not bePERSON. Parents:RegistrantContact,AdminContact,TechContactRequired: NocdEmail- Email address of the contact. Type: String Default: None Constraints: Maximum 254 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdState- The state or province of the contact's city. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: NocdFax- Fax number of the contact. Type: String Default: None Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as"+1.1234567890". Parents:RegistrantContact,AdminContact,TechContactRequired: NocdLastName- Last name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdExtraParams- A list of name-value pairs for parameters required by certain top-level domains. Type: Complex Default: None Parents:RegistrantContact,AdminContact,TechContactChildren:Name,ValueRequired: NocdZipCode- The zip or postal code of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: NocdAddressLine1- First line of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdCity- The city of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdPhoneNumber- The phone number of the contact. Type: String Default: None Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as"+1.1234567890". Parents:RegistrantContact,AdminContact,TechContactRequired: YescdAddressLine2- Second line of contact's address, if any. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: NocdFirstName- First name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdCountryCode- Code for the country of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents:RegistrantContact,AdminContact,TechContactRequired: YescdContactType- Indicates whether the contact is a person, company, association, or public organization. If you choose an option other thanPERSON, you must enter an organization name, and you can't enable privacy protection for the contact. Type: String Default: None Constraints: Maximum 255 characters. Valid values:PERSON|COMPANY|ASSOCIATION|PUBLIC_BODYParents:RegistrantContact,AdminContact,TechContactRequired: Yes
cdOrganizationName :: Lens' ContactDetail (Maybe Text) Source #
Name of the organization for contact types other than PERSON . Type: String Default: None Constraints: Maximum 255 characters. Contact type must not be PERSON . Parents: RegistrantContact , AdminContact , TechContact Required: No
cdEmail :: Lens' ContactDetail (Maybe Text) Source #
Email address of the contact. Type: String Default: None Constraints: Maximum 254 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdState :: Lens' ContactDetail (Maybe Text) Source #
The state or province of the contact's city. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: No
cdFax :: Lens' ContactDetail (Maybe Text) Source #
Fax number of the contact. Type: String Default: None Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" . Parents: RegistrantContact , AdminContact , TechContact Required: No
cdLastName :: Lens' ContactDetail (Maybe Text) Source #
Last name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdExtraParams :: Lens' ContactDetail [ExtraParam] Source #
A list of name-value pairs for parameters required by certain top-level domains. Type: Complex Default: None Parents: RegistrantContact , AdminContact , TechContact Children: Name , Value Required: No
cdZipCode :: Lens' ContactDetail (Maybe Text) Source #
The zip or postal code of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: No
cdAddressLine1 :: Lens' ContactDetail (Maybe Text) Source #
First line of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdCity :: Lens' ContactDetail (Maybe Text) Source #
The city of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdPhoneNumber :: Lens' ContactDetail (Maybe Text) Source #
The phone number of the contact. Type: String Default: None Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890" . Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdAddressLine2 :: Lens' ContactDetail (Maybe Text) Source #
Second line of contact's address, if any. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: No
cdFirstName :: Lens' ContactDetail (Maybe Text) Source #
First name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdCountryCode :: Lens' ContactDetail (Maybe CountryCode) Source #
Code for the country of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact , AdminContact , TechContact Required: Yes
cdContactType :: Lens' ContactDetail (Maybe ContactType) Source #
Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can't enable privacy protection for the contact. Type: String Default: None Constraints: Maximum 255 characters. Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY Parents: RegistrantContact , AdminContact , TechContact Required: Yes
DomainSuggestion
domainSuggestion :: DomainSuggestion Source #
Creates a value of DomainSuggestion with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dAvailability- Undocumented member.dDomainName- Undocumented member.
dAvailability :: Lens' DomainSuggestion (Maybe Text) Source #
Undocumented member.
dDomainName :: Lens' DomainSuggestion (Maybe Text) Source #
Undocumented member.
DomainSummary
data DomainSummary Source #
See: domainSummary smart constructor.
Arguments
| :: Text | |
| -> DomainSummary |
Creates a value of DomainSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsExpiry- Expiration date of the domain in Coordinated Universal Time (UTC). Type: LongdsTransferLock- Indicates whether a domain is locked from unauthorized transfer to another party. Type: Boolean Valid values:True|FalsedsAutoRenew- Indicates whether the domain is automatically renewed upon expiration. Type: Boolean Valid values:True|FalsedsDomainName- The name of a domain. Type: String
dsExpiry :: Lens' DomainSummary (Maybe UTCTime) Source #
Expiration date of the domain in Coordinated Universal Time (UTC). Type: Long
dsTransferLock :: Lens' DomainSummary (Maybe Bool) Source #
Indicates whether a domain is locked from unauthorized transfer to another party. Type: Boolean Valid values: True | False
dsAutoRenew :: Lens' DomainSummary (Maybe Bool) Source #
Indicates whether the domain is automatically renewed upon expiration. Type: Boolean Valid values: True | False
dsDomainName :: Lens' DomainSummary Text Source #
The name of a domain. Type: String
ExtraParam
data ExtraParam Source #
ExtraParam includes the following elements.
See: extraParam smart constructor.
Arguments
| :: ExtraParamName | |
| -> Text | |
| -> ExtraParam |
Creates a value of ExtraParam with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epName- Name of the additional parameter required by the top-level domain. Type: String Default: None Valid values:DUNS_NUMBER|BRAND_NUMBER|BIRTH_DEPARTMENT|BIRTH_DATE_IN_YYYY_MM_DD|BIRTH_COUNTRY|BIRTH_CITY|DOCUMENT_NUMBER|AU_ID_NUMBER|AU_ID_TYPE|CA_LEGAL_TYPE|CA_BUSINESS_ENTITY_TYPE|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|IT_PIN|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBERParent:ExtraParamsRequired: YesepValue- Values corresponding to the additional parameter names required by some top-level domains. Type: String Default: None Constraints: Maximum 2048 characters. Parent:ExtraParamsRequired: Yes
epName :: Lens' ExtraParam ExtraParamName Source #
Name of the additional parameter required by the top-level domain. Type: String Default: None Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | CA_BUSINESS_ENTITY_TYPE |ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER Parent: ExtraParams Required: Yes
epValue :: Lens' ExtraParam Text Source #
Values corresponding to the additional parameter names required by some top-level domains. Type: String Default: None Constraints: Maximum 2048 characters. Parent: ExtraParams Required: Yes
Nameserver
data Nameserver Source #
Nameserver includes the following elements.
See: nameserver smart constructor.
Arguments
| :: Text | |
| -> Nameserver |
Creates a value of Nameserver with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nGlueIPs- Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com. Type: List of IP addresses. Constraints: The list can contain only one IPv4 and one IPv6 address. Parent:NameserversnName- The fully qualified host name of the name server. Type: String Constraint: Maximum 255 characterss Parent:Nameservers
nGlueIPs :: Lens' Nameserver [Text] Source #
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com. Type: List of IP addresses. Constraints: The list can contain only one IPv4 and one IPv6 address. Parent: Nameservers
nName :: Lens' Nameserver Text Source #
The fully qualified host name of the name server. Type: String Constraint: Maximum 255 characterss Parent: Nameservers
OperationSummary
data OperationSummary Source #
OperationSummary includes the following elements.
See: operationSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> OperationStatus | |
| -> OperationType | |
| -> UTCTime | |
| -> OperationSummary |
Creates a value of OperationSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osOperationId- Identifier returned to track the requested action. Type: StringosStatus- The current status of the requested operation in the system. Type: StringosType- Type of the action requested. Type: String Valid values:REGISTER_DOMAIN|DELETE_DOMAIN|TRANSFER_IN_DOMAIN|UPDATE_DOMAIN_CONTACT|UPDATE_NAMESERVER|CHANGE_PRIVACY_PROTECTION|DOMAIN_LOCKosSubmittedDate- The date when the request was submitted.
osOperationId :: Lens' OperationSummary Text Source #
Identifier returned to track the requested action. Type: String
osStatus :: Lens' OperationSummary OperationStatus Source #
The current status of the requested operation in the system. Type: String
osType :: Lens' OperationSummary OperationType Source #
Type of the action requested. Type: String Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK
osSubmittedDate :: Lens' OperationSummary UTCTime Source #
The date when the request was submitted.
Tag
Each tag includes the following elements.
See: tag smart constructor.
Creates a value of Tag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagValue- The value of a tag. Type: String Default: None Valid values: A-Z, a-z, 0-9, space, ".:/=+-@" Constraints: Each value can be 0-256 characters long. Required: YestagKey- The key (name) of a tag. Type: String Default: None Valid values: A-Z, a-z, 0-9, space, ".:/=+-@" Constraints: Each key can be 1-128 characters long. Required: Yes