@datafire/amazonaws_route53domains
v5.0.0
Published
DataFire integration for Amazon Route 53 Domains
Downloads
6
Readme
@datafire/amazonaws_route53domains
Client library for Amazon Route 53 Domains
Installation and Usage
npm install --save @datafire/amazonaws_route53domains
let amazonaws_route53domains = require('@datafire/amazonaws_route53domains').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_route53domains.CheckDomainAvailability({
"DomainName": ""
}).then(data => {
console.log(data);
});
Description
Amazon Route 53 API actions let you register domain names and perform related operations.
Actions
CheckDomainAvailability
amazonaws_route53domains.CheckDomainAvailability({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
- IdnLangCode LangCode
Output
CheckDomainTransferability
amazonaws_route53domains.CheckDomainTransferability({
"DomainName": ""
}, context)
Input
- input
object
- AuthCode DomainAuthCode
- DomainName required DomainName
Output
DeleteTagsForDomain
amazonaws_route53domains.DeleteTagsForDomain({
"DomainName": "",
"TagsToDelete": []
}, context)
Input
- input
object
- DomainName required DomainName
- TagsToDelete required TagKeyList
Output
- output DeleteTagsForDomainResponse
DisableDomainAutoRenew
amazonaws_route53domains.DisableDomainAutoRenew({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
DisableDomainTransferLock
amazonaws_route53domains.DisableDomainTransferLock({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
EnableDomainAutoRenew
amazonaws_route53domains.EnableDomainAutoRenew({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
EnableDomainTransferLock
amazonaws_route53domains.EnableDomainTransferLock({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
GetContactReachabilityStatus
amazonaws_route53domains.GetContactReachabilityStatus({}, context)
Input
- input
object
- domainName DomainName
Output
GetDomainDetail
amazonaws_route53domains.GetDomainDetail({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
- output GetDomainDetailResponse
GetDomainSuggestions
amazonaws_route53domains.GetDomainSuggestions({
"DomainName": "",
"SuggestionCount": 0,
"OnlyAvailable": true
}, context)
Input
- input
object
- DomainName required DomainName
- OnlyAvailable required Boolean
- SuggestionCount required Integer
Output
- output GetDomainSuggestionsResponse
GetOperationDetail
amazonaws_route53domains.GetOperationDetail({
"OperationId": ""
}, context)
Input
- input
object
- OperationId required OperationId
Output
- output GetOperationDetailResponse
ListDomains
amazonaws_route53domains.ListDomains({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker PageMarker
- MaxItems PageMaxItems
- MaxItems
Output
- output ListDomainsResponse
ListOperations
amazonaws_route53domains.ListOperations({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker PageMarker
- MaxItems PageMaxItems
- MaxItems
Output
- output ListOperationsResponse
ListTagsForDomain
amazonaws_route53domains.ListTagsForDomain({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
- output ListTagsForDomainResponse
RegisterDomain
amazonaws_route53domains.RegisterDomain({
"DomainName": "",
"DurationInYears": 0,
"AdminContact": {},
"RegistrantContact": {},
"TechContact": {}
}, context)
Input
- input
object
- AdminContact required ContactDetail
- AutoRenew Boolean
- DomainName required DomainName
- DurationInYears required DurationInYears
- IdnLangCode LangCode
- PrivacyProtectAdminContact Boolean
- PrivacyProtectRegistrantContact Boolean
- PrivacyProtectTechContact Boolean
- RegistrantContact required ContactDetail
- TechContact required ContactDetail
Output
- output RegisterDomainResponse
RenewDomain
amazonaws_route53domains.RenewDomain({
"DomainName": "",
"CurrentExpiryYear": 0
}, context)
Input
- input
object
- CurrentExpiryYear required CurrentExpiryYear
- DomainName required DomainName
- DurationInYears DurationInYears
Output
- output RenewDomainResponse
ResendContactReachabilityEmail
amazonaws_route53domains.ResendContactReachabilityEmail({}, context)
Input
- input
object
- domainName DomainName
Output
RetrieveDomainAuthCode
amazonaws_route53domains.RetrieveDomainAuthCode({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
Output
TransferDomain
amazonaws_route53domains.TransferDomain({
"DomainName": "",
"DurationInYears": 0,
"AdminContact": {},
"RegistrantContact": {},
"TechContact": {}
}, context)
Input
- input
object
- AdminContact required ContactDetail
- AuthCode DomainAuthCode
- AutoRenew Boolean
- DomainName required DomainName
- DurationInYears required DurationInYears
- IdnLangCode LangCode
- Nameservers NameserverList
- PrivacyProtectAdminContact Boolean
- PrivacyProtectRegistrantContact Boolean
- PrivacyProtectTechContact Boolean
- RegistrantContact required ContactDetail
- TechContact required ContactDetail
Output
- output TransferDomainResponse
UpdateDomainContact
amazonaws_route53domains.UpdateDomainContact({
"DomainName": ""
}, context)
Input
- input
object
- AdminContact ContactDetail
- DomainName required DomainName
- RegistrantContact ContactDetail
- TechContact ContactDetail
Output
- output UpdateDomainContactResponse
UpdateDomainContactPrivacy
amazonaws_route53domains.UpdateDomainContactPrivacy({
"DomainName": ""
}, context)
Input
- input
object
- AdminPrivacy Boolean
- DomainName required DomainName
- RegistrantPrivacy Boolean
- TechPrivacy Boolean
Output
UpdateDomainNameservers
amazonaws_route53domains.UpdateDomainNameservers({
"DomainName": "",
"Nameservers": []
}, context)
Input
- input
object
- DomainName required DomainName
- FIAuthKey FIAuthKey
- Nameservers required NameserverList
Output
UpdateTagsForDomain
amazonaws_route53domains.UpdateTagsForDomain({
"DomainName": ""
}, context)
Input
- input
object
- DomainName required DomainName
- TagsToUpdate TagList
Output
- output UpdateTagsForDomainResponse
ViewBilling
amazonaws_route53domains.ViewBilling({}, context)
Input
- input
object
- End Timestamp
- Marker PageMarker
- MaxItems PageMaxItems
- Start Timestamp
Output
- output ViewBillingResponse
Definitions
AddressLine
- AddressLine
string
BillingRecord
- BillingRecord
object
: Information for one billing record.- BillDate Timestamp
- DomainName DomainName
- InvoiceId InvoiceId
- Operation OperationType
- Price Price
BillingRecords
- BillingRecords
array
- items BillingRecord
Boolean
- Boolean
boolean
CheckDomainAvailabilityRequest
- CheckDomainAvailabilityRequest
object
: The CheckDomainAvailability request contains the following elements.- DomainName required DomainName
- IdnLangCode LangCode
CheckDomainAvailabilityResponse
- CheckDomainAvailabilityResponse
object
: The CheckDomainAvailability response includes the following elements.- Availability required DomainAvailability
CheckDomainTransferabilityRequest
- CheckDomainTransferabilityRequest
object
: The CheckDomainTransferability request contains the following elements.- AuthCode DomainAuthCode
- DomainName required DomainName
CheckDomainTransferabilityResponse
- CheckDomainTransferabilityResponse
object
: The CheckDomainTransferability response includes the following elements.- Transferability required DomainTransferability
City
- City
string
ContactDetail
- ContactDetail
object
: ContactDetail includes the following elements.- AddressLine1 AddressLine
- AddressLine2 AddressLine
- City City
- ContactType ContactType
- CountryCode CountryCode
- Email Email
- ExtraParams ExtraParamList
- Fax ContactNumber
- FirstName ContactName
- LastName ContactName
- OrganizationName ContactName
- PhoneNumber ContactNumber
- State State
- ZipCode ZipCode
ContactName
- ContactName
string
ContactNumber
- ContactNumber
string
ContactType
- ContactType
string
(values: PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER)
CountryCode
- CountryCode
string
(values: 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, ID, IE, IL, IM, IN, IQ, IR, IS, IT, 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)
CurrentExpiryYear
- CurrentExpiryYear
integer
DNSSec
- DNSSec
string
DeleteTagsForDomainRequest
- DeleteTagsForDomainRequest
object
: The DeleteTagsForDomainRequest includes the following elements.- DomainName required DomainName
- TagsToDelete required TagKeyList
DeleteTagsForDomainResponse
- DeleteTagsForDomainResponse
object
DisableDomainAutoRenewRequest
- DisableDomainAutoRenewRequest
object
- DomainName required DomainName
DisableDomainAutoRenewResponse
- DisableDomainAutoRenewResponse
object
DisableDomainTransferLockRequest
- DisableDomainTransferLockRequest
object
: The DisableDomainTransferLock request includes the following element.- DomainName required DomainName
DisableDomainTransferLockResponse
- DisableDomainTransferLockResponse
object
: The DisableDomainTransferLock response includes the following element.- OperationId required OperationId
DomainAuthCode
- DomainAuthCode
string
DomainAvailability
- DomainAvailability
string
(values: AVAILABLE, AVAILABLE_RESERVED, AVAILABLE_PREORDER, UNAVAILABLE, UNAVAILABLE_PREMIUM, UNAVAILABLE_RESTRICTED, RESERVED, DONT_KNOW)
DomainLimitExceeded
- DomainLimitExceeded
object
: The number of domains has exceeded the allowed threshold for the account.- message ErrorMessage
DomainName
- DomainName
string
DomainStatus
- DomainStatus
string
DomainStatusList
- DomainStatusList
array
- items DomainStatus
DomainSuggestion
- DomainSuggestion
object
: Information about one suggested domain name.- Availability String
- DomainName DomainName
DomainSuggestionsList
- DomainSuggestionsList
array
- items DomainSuggestion
DomainSummary
- DomainSummary
object
: Summary information about one domain.- AutoRenew Boolean
- DomainName required DomainName
- Expiry Timestamp
- TransferLock Boolean
DomainSummaryList
- DomainSummaryList
array
- items DomainSummary
DomainTransferability
- DomainTransferability
object
- Transferable Transferable
DuplicateRequest
- DuplicateRequest
object
: The request is already in progress for the domain.- message ErrorMessage
DurationInYears
- DurationInYears
integer
- Email
string
EnableDomainAutoRenewRequest
- EnableDomainAutoRenewRequest
object
- DomainName required DomainName
EnableDomainAutoRenewResponse
- EnableDomainAutoRenewResponse
object
EnableDomainTransferLockRequest
- EnableDomainTransferLockRequest
object
: A request to set the transfer lock for the specified domain.- DomainName required DomainName
EnableDomainTransferLockResponse
- EnableDomainTransferLockResponse
object
: The EnableDomainTransferLock response includes the following elements.- OperationId required OperationId
ErrorMessage
- ErrorMessage
string
ExtraParam
- ExtraParam
object
: ExtraParam includes the following elements.- Name required ExtraParamName
- Value required ExtraParamValue
ExtraParamList
- ExtraParamList
array
- items ExtraParam
ExtraParamName
- ExtraParamName
string
(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, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER)
ExtraParamValue
- ExtraParamValue
string
FIAuthKey
- FIAuthKey
string
GetContactReachabilityStatusRequest
- GetContactReachabilityStatusRequest
object
- domainName DomainName
GetContactReachabilityStatusResponse
- GetContactReachabilityStatusResponse
object
- domainName DomainName
- status ReachabilityStatus
GetDomainDetailRequest
- GetDomainDetailRequest
object
: The GetDomainDetail request includes the following element.- DomainName required DomainName
GetDomainDetailResponse
- GetDomainDetailResponse
object
: The GetDomainDetail response includes the following elements.- AbuseContactEmail Email
- AbuseContactPhone ContactNumber
- AdminContact required ContactDetail
- AdminPrivacy Boolean
- AutoRenew Boolean
- CreationDate Timestamp
- DnsSec DNSSec
- DomainName required DomainName
- ExpirationDate Timestamp
- Nameservers required NameserverList
- RegistrantContact required ContactDetail
- RegistrantPrivacy Boolean
- RegistrarName RegistrarName
- RegistrarUrl RegistrarUrl
- RegistryDomainId RegistryDomainId
- Reseller Reseller
- StatusList DomainStatusList
- TechContact required ContactDetail
- TechPrivacy Boolean
- UpdatedDate Timestamp
- WhoIsServer RegistrarWhoIsServer
GetDomainSuggestionsRequest
- GetDomainSuggestionsRequest
object
- DomainName required DomainName
- OnlyAvailable required Boolean
- SuggestionCount required Integer
GetDomainSuggestionsResponse
- GetDomainSuggestionsResponse
object
- SuggestionsList DomainSuggestionsList
GetOperationDetailRequest
- GetOperationDetailRequest
object
: The GetOperationDetail request includes the following element.- OperationId required OperationId
GetOperationDetailResponse
- GetOperationDetailResponse
object
: The GetOperationDetail response includes the following elements.- DomainName DomainName
- Message ErrorMessage
- OperationId OperationId
- Status OperationStatus
- SubmittedDate Timestamp
- Type OperationType
GlueIp
- GlueIp
string
GlueIpList
- GlueIpList
array
- items GlueIp
HostName
- HostName
string
Integer
- Integer
integer
InvalidInput
- InvalidInput
object
: The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.- message ErrorMessage
InvoiceId
- InvoiceId
string
LangCode
- LangCode
string
ListDomainsRequest
- ListDomainsRequest
object
: The ListDomains request includes the following elements.- Marker PageMarker
- MaxItems PageMaxItems
ListDomainsResponse
- ListDomainsResponse
object
: The ListDomains response includes the following elements.- Domains required DomainSummaryList
- NextPageMarker PageMarker
ListOperationsRequest
- ListOperationsRequest
object
: The ListOperations request includes the following elements.- Marker PageMarker
- MaxItems PageMaxItems
ListOperationsResponse
- ListOperationsResponse
object
: The ListOperations response includes the following elements.- NextPageMarker PageMarker
- Operations required OperationSummaryList
ListTagsForDomainRequest
- ListTagsForDomainRequest
object
: The ListTagsForDomainRequest includes the following elements.- DomainName required DomainName
ListTagsForDomainResponse
- ListTagsForDomainResponse
object
: The ListTagsForDomain response includes the following elements.- TagList required TagList
Nameserver
- Nameserver
object
: Nameserver includes the following elements.- GlueIps GlueIpList
- Name required HostName
NameserverList
- NameserverList
array
- items Nameserver
OperationId
- OperationId
string
OperationLimitExceeded
- OperationLimitExceeded
object
: The number of operations or jobs running exceeded the allowed threshold for the account.- message ErrorMessage
OperationStatus
- OperationStatus
string
(values: SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED)
OperationSummary
- OperationSummary
object
: OperationSummary includes the following elements.- OperationId required OperationId
- Status required OperationStatus
- SubmittedDate required Timestamp
- Type required OperationType
OperationSummaryList
- OperationSummaryList
array
- items OperationSummary
OperationType
- OperationType
string
(values: REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK, ENABLE_AUTORENEW, DISABLE_AUTORENEW, ADD_DNSSEC, REMOVE_DNSSEC, EXPIRE_DOMAIN, TRANSFER_OUT_DOMAIN, CHANGE_DOMAIN_OWNER, RENEW_DOMAIN, PUSH_DOMAIN)
PageMarker
- PageMarker
string
PageMaxItems
- PageMaxItems
integer
Price
- Price
number
ReachabilityStatus
- ReachabilityStatus
string
(values: PENDING, DONE, EXPIRED)
RegisterDomainRequest
- RegisterDomainRequest
object
: The RegisterDomain request includes the following elements.- AdminContact required ContactDetail
- AutoRenew Boolean
- DomainName required DomainName
- DurationInYears required DurationInYears
- IdnLangCode LangCode
- PrivacyProtectAdminContact Boolean
- PrivacyProtectRegistrantContact Boolean
- PrivacyProtectTechContact Boolean
- RegistrantContact required ContactDetail
- TechContact required ContactDetail
RegisterDomainResponse
- RegisterDomainResponse
object
: The RegisterDomain response includes the following element.- OperationId required OperationId
RegistrarName
- RegistrarName
string
RegistrarUrl
- RegistrarUrl
string
RegistrarWhoIsServer
- RegistrarWhoIsServer
string
RegistryDomainId
- RegistryDomainId
string
RenewDomainRequest
- RenewDomainRequest
object
: A RenewDomain request includes the number of years that you want to renew for and the current expiration year.- CurrentExpiryYear required CurrentExpiryYear
- DomainName required DomainName
- DurationInYears DurationInYears
RenewDomainResponse
- RenewDomainResponse
object
- OperationId required OperationId
Reseller
- Reseller
string
ResendContactReachabilityEmailRequest
- ResendContactReachabilityEmailRequest
object
- domainName DomainName
ResendContactReachabilityEmailResponse
- ResendContactReachabilityEmailResponse
object
- domainName DomainName
- emailAddress Email
- isAlreadyVerified Boolean
RetrieveDomainAuthCodeRequest
- RetrieveDomainAuthCodeRequest
object
: A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide this value to the new registrar.- DomainName required DomainName
RetrieveDomainAuthCodeResponse
- RetrieveDomainAuthCodeResponse
object
: The RetrieveDomainAuthCode response includes the following element.- AuthCode required DomainAuthCode
State
- State
string
String
- String
string
TLDRulesViolation
- TLDRulesViolation
object
: The top-level domain does not support this operation.- message ErrorMessage
Tag
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagList
- TagList
array
- items Tag
TagValue
- TagValue
string
Timestamp
- Timestamp
string
TransferDomainRequest
- TransferDomainRequest
object
: The TransferDomain request includes the following elements.- AdminContact required ContactDetail
- AuthCode DomainAuthCode
- AutoRenew Boolean
- DomainName required DomainName
- DurationInYears required DurationInYears
- IdnLangCode LangCode
- Nameservers NameserverList
- PrivacyProtectAdminContact Boolean
- PrivacyProtectRegistrantContact Boolean
- PrivacyProtectTechContact Boolean
- RegistrantContact required ContactDetail
- TechContact required ContactDetail
TransferDomainResponse
- TransferDomainResponse
object
: The TranserDomain response includes the following element.- OperationId required OperationId
Transferable
- Transferable
string
(values: TRANSFERABLE, UNTRANSFERABLE, DONT_KNOW): Whether the domain name can be transferred to Amazon Route 53. You can transfer only domains that have a value of TRANSFERABLE for Transferable. Valid values: TRANSFERABLE The domain name can be transferred to Amazon Route 53. UNTRANSFERRABLE The domain name can't be transferred to Amazon Route 53. DONT_KNOW Reserved for future use.
UnsupportedTLD
- UnsupportedTLD
object
: Amazon Route 53 does not support this top-level domain (TLD).- message ErrorMessage
UpdateDomainContactPrivacyRequest
- UpdateDomainContactPrivacyRequest
object
: The UpdateDomainContactPrivacy request includes the following elements.- AdminPrivacy Boolean
- DomainName required DomainName
- RegistrantPrivacy Boolean
- TechPrivacy Boolean
UpdateDomainContactPrivacyResponse
- UpdateDomainContactPrivacyResponse
object
: The UpdateDomainContactPrivacy response includes the following element.- OperationId required OperationId
UpdateDomainContactRequest
- UpdateDomainContactRequest
object
: The UpdateDomainContact request includes the following elements.- AdminContact ContactDetail
- DomainName required DomainName
- RegistrantContact ContactDetail
- TechContact ContactDetail
UpdateDomainContactResponse
- UpdateDomainContactResponse
object
: The UpdateDomainContact response includes the following element.- OperationId required OperationId
UpdateDomainNameserversRequest
- UpdateDomainNameserversRequest
object
: Replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation 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 will be notified by email.- DomainName required DomainName
- FIAuthKey FIAuthKey
- Nameservers required NameserverList
UpdateDomainNameserversResponse
- UpdateDomainNameserversResponse
object
: The UpdateDomainNameservers response includes the following element.- OperationId required OperationId
UpdateTagsForDomainRequest
- UpdateTagsForDomainRequest
object
: The UpdateTagsForDomainRequest includes the following elements.- DomainName required DomainName
- TagsToUpdate TagList
UpdateTagsForDomainResponse
- UpdateTagsForDomainResponse
object
ViewBillingRequest
- ViewBillingRequest
object
: The ViewBilling request includes the following elements.- End Timestamp
- Marker PageMarker
- MaxItems PageMaxItems
- Start Timestamp
ViewBillingResponse
- ViewBillingResponse
object
: The ViewBilling response includes the following elements.- BillingRecords BillingRecords
- NextPageMarker PageMarker
ZipCode
- ZipCode
string