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

Copyright(c) 2013-2015 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.Types

Contents

Description

 

Synopsis

Service Configuration

route53Domains :: Service Source

API version '2014-05-15' of the Amazon Route 53 Domains SDK configuration.

Errors

_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 :: AsError a => Getting (First ServiceError) a ServiceError Source

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

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

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

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

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

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

The top-level domain does not support this operation.

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

The request is already in progress for the domain.

ContactType

CountryCode

DomainAvailability

ExtraParamName

OperationStatus

OperationType

ContactDetail

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

DomainSummary

domainSummary Source

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

extraParam Source

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

nameserver Source

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

operationSummary Source

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

data Tag Source

Each tag includes the following elements.

See: tag smart constructor.

tag :: Tag Source

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 :: Lens' Tag (Maybe Text) Source

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

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