Network.AWS.Route53Domains

Pending

See: AWS API Reference

Service Configuration

route53Domains :: Service

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

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

The number of operations or jobs running exceeded the allowed threshold for the account.

DomainLimitExceeded

_DomainLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError

The number of domains has exceeded the allowed threshold for the account.

UnsupportedTLD

_UnsupportedTLD :: AsError a => Getting (First ServiceError) a ServiceError

Amazon Route 53 does not support this top-level domain.

TLDRulesViolation

_TLDRulesViolation :: AsError a => Getting (First ServiceError) a ServiceError

The top-level domain does not support this operation.

DuplicateRequest

_DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError

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)

module Network.AWS.Route53Domains.ListOperations

GetDomainDetail

module Network.AWS.Route53Domains.GetDomainDetail

UpdateDomainContactPrivacy

module Network.AWS.Route53Domains.UpdateDomainContactPrivacy

GetOperationDetail

module Network.AWS.Route53Domains.GetOperationDetail

EnableDomainAutoRenew

module Network.AWS.Route53Domains.EnableDomainAutoRenew

DisableDomainAutoRenew

module Network.AWS.Route53Domains.DisableDomainAutoRenew

UpdateDomainContact

module Network.AWS.Route53Domains.UpdateDomainContact

EnableDomainTransferLock

module Network.AWS.Route53Domains.EnableDomainTransferLock

RegisterDomain

module Network.AWS.Route53Domains.RegisterDomain

DisableDomainTransferLock

module Network.AWS.Route53Domains.DisableDomainTransferLock

CheckDomainAvailability

module Network.AWS.Route53Domains.CheckDomainAvailability

ListTagsForDomain

module Network.AWS.Route53Domains.ListTagsForDomain

UpdateDomainNameservers

module Network.AWS.Route53Domains.UpdateDomainNameservers

DeleteTagsForDomain

module Network.AWS.Route53Domains.DeleteTagsForDomain

UpdateTagsForDomain

module Network.AWS.Route53Domains.UpdateTagsForDomain

RetrieveDomainAuthCode

module Network.AWS.Route53Domains.RetrieveDomainAuthCode

TransferDomain

module Network.AWS.Route53Domains.TransferDomain

ListDomains (Paginated)

module Network.AWS.Route53Domains.ListDomains

Types

ContactType

data ContactType

Constructors

Association

Company

Person

PublicBody

Reseller

Instances

Enum ContactType

Eq ContactType

Data ContactType

Ord ContactType

Read ContactType

Show ContactType

Generic ContactType

ToJSON ContactType

FromJSON ContactType

Hashable ContactType

ToHeader ContactType

ToQuery ContactType

ToByteString ContactType

FromText ContactType

ToText ContactType

type Rep ContactType

CountryCode

data CountryCode

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

Enum CountryCode

Eq CountryCode

Data CountryCode

Ord CountryCode

Read CountryCode

Show CountryCode

Generic CountryCode

ToJSON CountryCode

FromJSON CountryCode

Hashable CountryCode

ToHeader CountryCode

ToQuery CountryCode

ToByteString CountryCode

FromText CountryCode

ToText CountryCode

type Rep CountryCode

DomainAvailability

data DomainAvailability

Constructors

Available

AvailablePreorder

AvailableReserved

DontKnow

Reserved

Unavailable

UnavailablePremium

UnavailableRestricted

Instances

Enum DomainAvailability

Eq DomainAvailability

Data DomainAvailability

Ord DomainAvailability

Read DomainAvailability

Show DomainAvailability

Generic DomainAvailability

FromJSON DomainAvailability

Hashable DomainAvailability

ToHeader DomainAvailability

ToQuery DomainAvailability

ToByteString DomainAvailability

FromText DomainAvailability

ToText DomainAvailability

type Rep DomainAvailability

ExtraParamName

data ExtraParamName

Constructors

AuIdNumber

AuIdType

BirthCity

BirthCountry

BirthDateInYyyyMmDd

BirthDepartment

BrandNumber

CaLegalType

DocumentNumber

DunsNumber

EsIdentification

EsIdentificationType

EsLegalForm

FiBusinessNumber

FiIdNumber

ItPin

RuPassportData

SeIdNumber

SgIdNumber

VatNumber

Instances

Enum ExtraParamName

Eq ExtraParamName

Data ExtraParamName

Ord ExtraParamName

Read ExtraParamName

Show ExtraParamName

Generic ExtraParamName

ToJSON ExtraParamName

FromJSON ExtraParamName

Hashable ExtraParamName

ToHeader ExtraParamName

ToQuery ExtraParamName

ToByteString ExtraParamName

FromText ExtraParamName

ToText ExtraParamName

type Rep ExtraParamName

OperationStatus

data OperationStatus

Constructors

Error'

Failed

InProgress

Submitted

Successful

Instances

Enum OperationStatus

Eq OperationStatus

Data OperationStatus

Ord OperationStatus

Read OperationStatus

Show OperationStatus

Generic OperationStatus

FromJSON OperationStatus

Hashable OperationStatus

ToHeader OperationStatus

ToQuery OperationStatus

ToByteString OperationStatus

FromText OperationStatus

ToText OperationStatus

type Rep OperationStatus

OperationType

data OperationType

Constructors

ChangePrivacyProtection

DeleteDomain

DomainLock

RegisterDomain

TransferInDomain

UpdateDomainContact

UpdateNameserver

Instances

Enum OperationType

Eq OperationType

Data OperationType

Ord OperationType

Read OperationType

Show OperationType

Generic OperationType

FromJSON OperationType

Hashable OperationType

ToHeader OperationType

ToQuery OperationType

ToByteString OperationType

FromText OperationType

ToText OperationType

type Rep OperationType

ContactDetail

data ContactDetail

ContactDetail includes the following elements.

See: contactDetail smart constructor.

Instances

Eq ContactDetail

Data ContactDetail

Read ContactDetail

Show ContactDetail

Generic ContactDetail

ToJSON ContactDetail

FromJSON ContactDetail

type Rep ContactDetail

contactDetail :: ContactDetail

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
• cdEmail
• cdState
• cdFax
• cdLastName
• cdExtraParams
• cdZipCode
• cdAddressLine1
• cdCity
• cdPhoneNumber
• cdAddressLine2
• cdFirstName
• cdCountryCode
• cdContactType

cdOrganizationName :: Lens' ContactDetail (Maybe Text)

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)

Email address of the contact.

Type: String

Default: None

Constraints: Maximum 254 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

cdState :: Lens' ContactDetail (Maybe Text)

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)

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)

Last name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

cdExtraParams :: Lens' ContactDetail [ExtraParam]

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)

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)

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)

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)

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)

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)

First name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

cdCountryCode :: Lens' ContactDetail (Maybe CountryCode)

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)

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

DomainSummary

data DomainSummary

See: domainSummary smart constructor.

Instances

Eq DomainSummary

Data DomainSummary

Read DomainSummary

Show DomainSummary

Generic DomainSummary

FromJSON DomainSummary

type Rep DomainSummary

domainSummary

Arguments

:: Text

dsDomainName

-> 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
• dsTransferLock
• dsAutoRenew
• dsDomainName

dsExpiry :: Lens' DomainSummary (Maybe UTCTime)

Expiration date of the domain in Coordinated Universal Time (UTC).

Type: Long

dsTransferLock :: Lens' DomainSummary (Maybe Bool)

Indicates whether a domain is locked from unauthorized transfer to another party.

Type: Boolean

Valid values: True | False

dsAutoRenew :: Lens' DomainSummary (Maybe Bool)

Indicates whether the domain is automatically renewed upon expiration.

Type: Boolean

Valid values: True | False

dsDomainName :: Lens' DomainSummary Text

The name of a domain.

Type: String

ExtraParam

data ExtraParam

ExtraParam includes the following elements.

See: extraParam smart constructor.

Instances

Eq ExtraParam

Data ExtraParam

Read ExtraParam

Show ExtraParam

Generic ExtraParam

ToJSON ExtraParam

FromJSON ExtraParam

type Rep ExtraParam

extraParam

Arguments

:: ExtraParamName

epName

-> Text

epValue

-> 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
• epValue

epName :: Lens' ExtraParam ExtraParamName

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

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

Nameserver includes the following elements.

See: nameserver smart constructor.

Instances

Eq Nameserver

Data Nameserver

Read Nameserver

Show Nameserver

Generic Nameserver

ToJSON Nameserver

FromJSON Nameserver

type Rep Nameserver

nameserver

Arguments

:: Text

nName

-> 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
• nName

nGlueIPs :: Lens' Nameserver [Text]

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

The fully qualified host name of the name server.

Type: String

Constraint: Maximum 255 characterss

Parent: Nameservers

OperationSummary

data OperationSummary

OperationSummary includes the following elements.

See: operationSummary smart constructor.

Instances

Eq OperationSummary

Data OperationSummary

Read OperationSummary

Show OperationSummary

Generic OperationSummary

FromJSON OperationSummary

type Rep OperationSummary

operationSummary

Arguments

:: Text

osOperationId

-> OperationStatus

osStatus

-> OperationType

osType

-> UTCTime

osSubmittedDate

-> 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
• osStatus
• osType
• osSubmittedDate

osOperationId :: Lens' OperationSummary Text

Identifier returned to track the requested action.

Type: String

osStatus :: Lens' OperationSummary OperationStatus

The current status of the requested operation in the system.

Type: String

osType :: Lens' OperationSummary OperationType

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

The date when the request was submitted.

Tag

data Tag

Each tag includes the following elements.

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

ToJSON Tag

FromJSON Tag

type Rep Tag

tag :: Tag

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
• tagKey

tagValue :: Lens' Tag (Maybe Text)

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: Yes

tagKey :: Lens' Tag (Maybe Text)

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