route53domains.d.ts (70825B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class Route53Domains extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Route53Domains.Types.ClientConfiguration) 13 config: Config & Route53Domains.Types.ClientConfiguration; 14 /** 15 * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. 16 */ 17 checkDomainAvailability(params: Route53Domains.Types.CheckDomainAvailabilityRequest, callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request<Route53Domains.Types.CheckDomainAvailabilityResponse, AWSError>; 18 /** 19 * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. 20 */ 21 checkDomainAvailability(callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request<Route53Domains.Types.CheckDomainAvailabilityResponse, AWSError>; 22 /** 23 * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 24 */ 25 deleteTagsForDomain(params: Route53Domains.Types.DeleteTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request<Route53Domains.Types.DeleteTagsForDomainResponse, AWSError>; 26 /** 27 * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 28 */ 29 deleteTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request<Route53Domains.Types.DeleteTagsForDomainResponse, AWSError>; 30 /** 31 * This operation disables automatic renewal of domain registration for the specified domain. 32 */ 33 disableDomainAutoRenew(params: Route53Domains.Types.DisableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.DisableDomainAutoRenewResponse, AWSError>; 34 /** 35 * This operation disables automatic renewal of domain registration for the specified domain. 36 */ 37 disableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.DisableDomainAutoRenewResponse, AWSError>; 38 /** 39 * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission 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. 40 */ 41 disableDomainTransferLock(params: Route53Domains.Types.DisableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request<Route53Domains.Types.DisableDomainTransferLockResponse, AWSError>; 42 /** 43 * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission 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. 44 */ 45 disableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request<Route53Domains.Types.DisableDomainTransferLockResponse, AWSError>; 46 /** 47 * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. 48 */ 49 enableDomainAutoRenew(params: Route53Domains.Types.EnableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.EnableDomainAutoRenewResponse, AWSError>; 50 /** 51 * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. 52 */ 53 enableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.EnableDomainAutoRenewResponse, AWSError>; 54 /** 55 * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission 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. 56 */ 57 enableDomainTransferLock(params: Route53Domains.Types.EnableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request<Route53Domains.Types.EnableDomainTransferLockResponse, AWSError>; 58 /** 59 * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission 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. 60 */ 61 enableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request<Route53Domains.Types.EnableDomainTransferLockResponse, AWSError>; 62 /** 63 * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation. 64 */ 65 getContactReachabilityStatus(params: Route53Domains.Types.GetContactReachabilityStatusRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request<Route53Domains.Types.GetContactReachabilityStatusResponse, AWSError>; 66 /** 67 * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation. 68 */ 69 getContactReachabilityStatus(callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request<Route53Domains.Types.GetContactReachabilityStatusResponse, AWSError>; 70 /** 71 * This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output. 72 */ 73 getDomainDetail(params: Route53Domains.Types.GetDomainDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request<Route53Domains.Types.GetDomainDetailResponse, AWSError>; 74 /** 75 * This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output. 76 */ 77 getDomainDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request<Route53Domains.Types.GetDomainDetailResponse, AWSError>; 78 /** 79 * The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces). Parameters: DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified. SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1. OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration. 80 */ 81 getDomainSuggestions(params: Route53Domains.Types.GetDomainSuggestionsRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request<Route53Domains.Types.GetDomainSuggestionsResponse, AWSError>; 82 /** 83 * The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces). Parameters: DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified. SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1. OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration. 84 */ 85 getDomainSuggestions(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request<Route53Domains.Types.GetDomainSuggestionsResponse, AWSError>; 86 /** 87 * This operation returns the current status of an operation that is not completed. 88 */ 89 getOperationDetail(params: Route53Domains.Types.GetOperationDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request<Route53Domains.Types.GetOperationDetailResponse, AWSError>; 90 /** 91 * This operation returns the current status of an operation that is not completed. 92 */ 93 getOperationDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request<Route53Domains.Types.GetOperationDetailResponse, AWSError>; 94 /** 95 * This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. 96 */ 97 listDomains(params: Route53Domains.Types.ListDomainsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request<Route53Domains.Types.ListDomainsResponse, AWSError>; 98 /** 99 * This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. 100 */ 101 listDomains(callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request<Route53Domains.Types.ListDomainsResponse, AWSError>; 102 /** 103 * This operation returns the operation IDs of operations that are not yet complete. 104 */ 105 listOperations(params: Route53Domains.Types.ListOperationsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request<Route53Domains.Types.ListOperationsResponse, AWSError>; 106 /** 107 * This operation returns the operation IDs of operations that are not yet complete. 108 */ 109 listOperations(callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request<Route53Domains.Types.ListOperationsResponse, AWSError>; 110 /** 111 * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 112 */ 113 listTagsForDomain(params: Route53Domains.Types.ListTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request<Route53Domains.Types.ListTagsForDomainResponse, AWSError>; 114 /** 115 * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 116 */ 117 listTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request<Route53Domains.Types.ListTagsForDomainResponse, AWSError>; 118 /** 119 * This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts. If registration is successful, 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 is notified by email. Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. 120 */ 121 registerDomain(params: Route53Domains.Types.RegisterDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request<Route53Domains.Types.RegisterDomainResponse, AWSError>; 122 /** 123 * This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts. If registration is successful, 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 is notified by email. Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. 124 */ 125 registerDomain(callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request<Route53Domains.Types.RegisterDomainResponse, AWSError>; 126 /** 127 * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 documentation. 128 */ 129 renewDomain(params: Route53Domains.Types.RenewDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request<Route53Domains.Types.RenewDomainResponse, AWSError>; 130 /** 131 * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 documentation. 132 */ 133 renewDomain(callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request<Route53Domains.Types.RenewDomainResponse, AWSError>; 134 /** 135 * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. 136 */ 137 resendContactReachabilityEmail(params: Route53Domains.Types.ResendContactReachabilityEmailRequest, callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request<Route53Domains.Types.ResendContactReachabilityEmailResponse, AWSError>; 138 /** 139 * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. 140 */ 141 resendContactReachabilityEmail(callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request<Route53Domains.Types.ResendContactReachabilityEmailResponse, AWSError>; 142 /** 143 * This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. 144 */ 145 retrieveDomainAuthCode(params: Route53Domains.Types.RetrieveDomainAuthCodeRequest, callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request<Route53Domains.Types.RetrieveDomainAuthCodeResponse, AWSError>; 146 /** 147 * This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. 148 */ 149 retrieveDomainAuthCode(callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request<Route53Domains.Types.RetrieveDomainAuthCodeResponse, AWSError>; 150 /** 151 * This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 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 consider transferring your DNS service to Amazon 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. Caution! 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. 152 */ 153 transferDomain(params: Route53Domains.Types.TransferDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request<Route53Domains.Types.TransferDomainResponse, AWSError>; 154 /** 155 * This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 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 consider transferring your DNS service to Amazon 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. Caution! 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. 156 */ 157 transferDomain(callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request<Route53Domains.Types.TransferDomainResponse, AWSError>; 158 /** 159 * This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. If the update is successful, this method 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. 160 */ 161 updateDomainContact(params: Route53Domains.Types.UpdateDomainContactRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request<Route53Domains.Types.UpdateDomainContactResponse, AWSError>; 162 /** 163 * This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. If the update is successful, this method 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. 164 */ 165 updateDomainContact(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request<Route53Domains.Types.UpdateDomainContactResponse, AWSError>; 166 /** 167 * This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features. This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. 168 */ 169 updateDomainContactPrivacy(params: Route53Domains.Types.UpdateDomainContactPrivacyRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request<Route53Domains.Types.UpdateDomainContactPrivacyResponse, AWSError>; 170 /** 171 * This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features. This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. 172 */ 173 updateDomainContactPrivacy(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request<Route53Domains.Types.UpdateDomainContactPrivacyResponse, AWSError>; 174 /** 175 * This operation 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. 176 */ 177 updateDomainNameservers(params: Route53Domains.Types.UpdateDomainNameserversRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request<Route53Domains.Types.UpdateDomainNameserversResponse, AWSError>; 178 /** 179 * This operation 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. 180 */ 181 updateDomainNameservers(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request<Route53Domains.Types.UpdateDomainNameserversResponse, AWSError>; 182 /** 183 * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 184 */ 185 updateTagsForDomain(params: Route53Domains.Types.UpdateTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request<Route53Domains.Types.UpdateTagsForDomainResponse, AWSError>; 186 /** 187 * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. 188 */ 189 updateTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request<Route53Domains.Types.UpdateTagsForDomainResponse, AWSError>; 190 /** 191 * This operation returns all the domain-related billing records for the current AWS account for a specified period 192 */ 193 viewBilling(params: Route53Domains.Types.ViewBillingRequest, callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request<Route53Domains.Types.ViewBillingResponse, AWSError>; 194 /** 195 * This operation returns all the domain-related billing records for the current AWS account for a specified period 196 */ 197 viewBilling(callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request<Route53Domains.Types.ViewBillingResponse, AWSError>; 198 } 199 declare namespace Route53Domains.Types { 200 export type AddressLine = string; 201 export interface BillingRecord { 202 /** 203 * The name of a domain. Type: String 204 */ 205 DomainName?: DomainName; 206 /** 207 * The operation that you were charged for. Type: String Valid values: REGISTER_DOMAIN TRANSFER_IN_DOMAIN RENEW_DOMAIN CHANGE_DOMAIN_OWNER 208 */ 209 Operation?: OperationType; 210 /** 211 * The ID of the invoice that is associated with the billing record. Type: String 212 */ 213 InvoiceId?: InvoiceId; 214 /** 215 * The date that the operation was billed, in Unix format. Type: Double 216 */ 217 BillDate?: Timestamp; 218 /** 219 * The price that you were charged for the operation, in US dollars. Type: Double Example value: 12.0 220 */ 221 Price?: Price; 222 } 223 export type BillingRecords = BillingRecord[]; 224 export type Boolean = boolean; 225 export interface CheckDomainAvailabilityRequest { 226 /** 227 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 228 */ 229 DomainName: DomainName; 230 /** 231 * Reserved for future use. 232 */ 233 IdnLangCode?: LangCode; 234 } 235 export interface CheckDomainAvailabilityResponse { 236 /** 237 * Whether the domain name is available for registering. You can only register domains designated as AVAILABLE. Type: String Valid values: AVAILABLE – The domain name is available. AVAILABLE_RESERVED – The domain name is reserved under specific conditions. AVAILABLE_PREORDER – The domain name is available and can be preordered. UNAVAILABLE – The domain name is not available. UNAVAILABLE_PREMIUM – The domain name is not available. UNAVAILABLE_RESTRICTED – The domain name is forbidden. RESERVED – The domain name has been reserved for another person or organization. DONT_KNOW – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later. 238 */ 239 Availability: DomainAvailability; 240 } 241 export type City = string; 242 export interface ContactDetail { 243 /** 244 * First name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 245 */ 246 FirstName?: ContactName; 247 /** 248 * Last name of contact. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 249 */ 250 LastName?: ContactName; 251 /** 252 * 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 253 */ 254 ContactType?: ContactType; 255 /** 256 * 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 257 */ 258 OrganizationName?: ContactName; 259 /** 260 * First line of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 261 */ 262 AddressLine1?: AddressLine; 263 /** 264 * Second line of contact's address, if any. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: No 265 */ 266 AddressLine2?: AddressLine; 267 /** 268 * The city of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 269 */ 270 City?: City; 271 /** 272 * The state or province of the contact's city. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: No 273 */ 274 State?: State; 275 /** 276 * Code for the country of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 277 */ 278 CountryCode?: CountryCode; 279 /** 280 * The zip or postal code of the contact's address. Type: String Default: None Constraints: Maximum 255 characters. Parents: RegistrantContact, AdminContact, TechContact Required: No 281 */ 282 ZipCode?: ZipCode; 283 /** 284 * 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 285 */ 286 PhoneNumber?: ContactNumber; 287 /** 288 * Email address of the contact. Type: String Default: None Constraints: Maximum 254 characters. Parents: RegistrantContact, AdminContact, TechContact Required: Yes 289 */ 290 Email?: Email; 291 /** 292 * 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 293 */ 294 Fax?: ContactNumber; 295 /** 296 * 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 297 */ 298 ExtraParams?: ExtraParamList; 299 } 300 export type ContactName = string; 301 export type ContactNumber = string; 302 export type ContactType = "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER"|string; 303 export type 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"|"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"|string; 304 export type CurrentExpiryYear = number; 305 export type DNSSec = string; 306 export interface DeleteTagsForDomainRequest { 307 /** 308 * The domain for which you want to delete one or more tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes 309 */ 310 DomainName: DomainName; 311 /** 312 * A list of tag keys to delete. Type: A list that contains the keys of the tags that you want to delete. Default: None Required: No'> 313 */ 314 TagsToDelete: TagKeyList; 315 } 316 export interface DeleteTagsForDomainResponse { 317 } 318 export interface DisableDomainAutoRenewRequest { 319 DomainName: DomainName; 320 } 321 export interface DisableDomainAutoRenewResponse { 322 } 323 export interface DisableDomainTransferLockRequest { 324 /** 325 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 326 */ 327 DomainName: DomainName; 328 } 329 export interface DisableDomainTransferLockResponse { 330 /** 331 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 332 */ 333 OperationId: OperationId; 334 } 335 export type DomainAuthCode = string; 336 export type DomainAvailability = "AVAILABLE"|"AVAILABLE_RESERVED"|"AVAILABLE_PREORDER"|"UNAVAILABLE"|"UNAVAILABLE_PREMIUM"|"UNAVAILABLE_RESTRICTED"|"RESERVED"|"DONT_KNOW"|string; 337 export type DomainName = string; 338 export type DomainStatus = string; 339 export type DomainStatusList = DomainStatus[]; 340 export interface DomainSuggestion { 341 DomainName?: DomainName; 342 Availability?: String; 343 } 344 export type DomainSuggestionsList = DomainSuggestion[]; 345 export interface DomainSummary { 346 /** 347 * The name of a domain. Type: String 348 */ 349 DomainName: DomainName; 350 /** 351 * Indicates whether the domain is automatically renewed upon expiration. Type: Boolean Valid values: True | False 352 */ 353 AutoRenew?: Boolean; 354 /** 355 * Indicates whether a domain is locked from unauthorized transfer to another party. Type: Boolean Valid values: True | False 356 */ 357 TransferLock?: Boolean; 358 /** 359 * Expiration date of the domain in Coordinated Universal Time (UTC). Type: Long 360 */ 361 Expiry?: Timestamp; 362 } 363 export type DomainSummaryList = DomainSummary[]; 364 export type DurationInYears = number; 365 export type Email = string; 366 export interface EnableDomainAutoRenewRequest { 367 DomainName: DomainName; 368 } 369 export interface EnableDomainAutoRenewResponse { 370 } 371 export interface EnableDomainTransferLockRequest { 372 /** 373 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 374 */ 375 DomainName: DomainName; 376 } 377 export interface EnableDomainTransferLockResponse { 378 /** 379 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 380 */ 381 OperationId: OperationId; 382 } 383 export type ErrorMessage = string; 384 export interface ExtraParam { 385 /** 386 * 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 387 */ 388 Name: ExtraParamName; 389 /** 390 * 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 391 */ 392 Value: ExtraParamValue; 393 } 394 export type ExtraParamList = ExtraParam[]; 395 export type ExtraParamName = "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"|string; 396 export type ExtraParamValue = string; 397 export type FIAuthKey = string; 398 export interface GetContactReachabilityStatusRequest { 399 /** 400 * The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid. Type: String Default: None Required: Yes 401 */ 402 domainName?: DomainName; 403 } 404 export interface GetContactReachabilityStatusResponse { 405 /** 406 * The domain name for which you requested the reachability status. 407 */ 408 domainName?: DomainName; 409 /** 410 * Whether the registrant contact has responded. PENDING indicates that we sent the confirmation email and haven't received a response yet, DONE indicates that we sent the email and got confirmation from the registrant contact, and EXPIRED indicates that the time limit expired before the registrant contact responded. Type: String Valid values: PENDING, DONE, EXPIRED 411 */ 412 status?: ReachabilityStatus; 413 } 414 export interface GetDomainDetailRequest { 415 /** 416 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 417 */ 418 DomainName: DomainName; 419 } 420 export interface GetDomainDetailResponse { 421 /** 422 * The name of a domain. Type: String 423 */ 424 DomainName: DomainName; 425 /** 426 * The name of the domain. Type: String 427 */ 428 Nameservers: NameserverList; 429 /** 430 * Specifies whether the domain registration is set to renew automatically. Type: Boolean 431 */ 432 AutoRenew?: Boolean; 433 /** 434 * Provides details about the domain administrative contact. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams 435 */ 436 AdminContact: ContactDetail; 437 /** 438 * Provides details about the domain registrant. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams 439 */ 440 RegistrantContact: ContactDetail; 441 /** 442 * Provides details about the domain technical contact. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams 443 */ 444 TechContact: ContactDetail; 445 /** 446 * Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean 447 */ 448 AdminPrivacy?: Boolean; 449 /** 450 * Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean 451 */ 452 RegistrantPrivacy?: Boolean; 453 /** 454 * Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean 455 */ 456 TechPrivacy?: Boolean; 457 /** 458 * Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is "GANDI SAS". Type: String 459 */ 460 RegistrarName?: RegistrarName; 461 /** 462 * The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain. Type: String 463 */ 464 WhoIsServer?: RegistrarWhoIsServer; 465 /** 466 * Web address of the registrar. Type: String 467 */ 468 RegistrarUrl?: RegistrarUrl; 469 /** 470 * Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse. Type: String 471 */ 472 AbuseContactEmail?: Email; 473 /** 474 * Phone number for reporting abuse. Type: String 475 */ 476 AbuseContactPhone?: ContactNumber; 477 /** 478 * Reserved for future use. 479 */ 480 RegistryDomainId?: RegistryDomainId; 481 /** 482 * The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time. 483 */ 484 CreationDate?: Timestamp; 485 /** 486 * The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time. 487 */ 488 UpdatedDate?: Timestamp; 489 /** 490 * The date when the registration for the domain is set to expire. The date format is Unix time. 491 */ 492 ExpirationDate?: Timestamp; 493 /** 494 * Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller. Type: String 495 */ 496 Reseller?: Reseller; 497 /** 498 * Reserved for future use. 499 */ 500 DnsSec?: DNSSec; 501 /** 502 * An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes. ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes. For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.) Type: Array of String 503 */ 504 StatusList?: DomainStatusList; 505 } 506 export interface GetDomainSuggestionsRequest { 507 DomainName: DomainName; 508 SuggestionCount: Integer; 509 OnlyAvailable: Boolean; 510 } 511 export interface GetDomainSuggestionsResponse { 512 SuggestionsList?: DomainSuggestionsList; 513 } 514 export interface GetOperationDetailRequest { 515 /** 516 * The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request. Type: String Default: None Required: Yes 517 */ 518 OperationId: OperationId; 519 } 520 export interface GetOperationDetailResponse { 521 /** 522 * The identifier for the operation. Type: String 523 */ 524 OperationId?: OperationId; 525 /** 526 * The current status of the requested operation in the system. Type: String 527 */ 528 Status?: OperationStatus; 529 /** 530 * Detailed information on the status including possible errors. Type: String 531 */ 532 Message?: ErrorMessage; 533 /** 534 * The name of a domain. Type: String 535 */ 536 DomainName?: DomainName; 537 /** 538 * The type of operation that was requested. Type: String 539 */ 540 Type?: OperationType; 541 /** 542 * The date when the request was submitted. 543 */ 544 SubmittedDate?: Timestamp; 545 } 546 export type GlueIp = string; 547 export type GlueIpList = GlueIp[]; 548 export type HostName = string; 549 export type Integer = number; 550 export type InvoiceId = string; 551 export type LangCode = string; 552 export interface ListDomainsRequest { 553 /** 554 * For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. Type: String Default: None Constraints: The marker must match the value specified in the previous request. Required: No 555 */ 556 Marker?: PageMarker; 557 /** 558 * Number of domains to be returned. Type: Integer Default: 20 Constraints: A numeral between 1 and 100. Required: No 559 */ 560 MaxItems?: PageMaxItems; 561 } 562 export interface ListDomainsResponse { 563 /** 564 * A summary of domains. Type: Complex type containing a list of domain summaries. Children: AutoRenew, DomainName, Expiry, TransferLock 565 */ 566 Domains: DomainSummaryList; 567 /** 568 * If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. Type: String Parent: Operations 569 */ 570 NextPageMarker?: PageMarker; 571 } 572 export interface ListOperationsRequest { 573 /** 574 * For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. Type: String Default: None Required: No 575 */ 576 Marker?: PageMarker; 577 /** 578 * Number of domains to be returned. Type: Integer Default: 20 Constraints: A value between 1 and 100. Required: No 579 */ 580 MaxItems?: PageMaxItems; 581 } 582 export interface ListOperationsResponse { 583 /** 584 * Lists summaries of the operations. Type: Complex type containing a list of operation summaries Children: OperationId, Status, SubmittedDate, Type 585 */ 586 Operations: OperationSummaryList; 587 /** 588 * If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. Type: String Parent: Operations 589 */ 590 NextPageMarker?: PageMarker; 591 } 592 export interface ListTagsForDomainRequest { 593 /** 594 * The domain for which you want to get a list of tags. 595 */ 596 DomainName: DomainName; 597 } 598 export interface ListTagsForDomainResponse { 599 /** 600 * A list of the tags that are associated with the specified domain. Type: A complex type containing a list of tags Each tag includes the following elements. Key The key (name) of a tag. Type: String Value The value of a tag. Type: String 601 */ 602 TagList: TagList; 603 } 604 export interface Nameserver { 605 /** 606 * The fully qualified host name of the name server. Type: String Constraint: Maximum 255 characterss Parent: Nameservers 607 */ 608 Name: HostName; 609 /** 610 * 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 611 */ 612 GlueIps?: GlueIpList; 613 } 614 export type NameserverList = Nameserver[]; 615 export type OperationId = string; 616 export type OperationStatus = "SUBMITTED"|"IN_PROGRESS"|"ERROR"|"SUCCESSFUL"|"FAILED"|string; 617 export interface OperationSummary { 618 /** 619 * Identifier returned to track the requested action. Type: String 620 */ 621 OperationId: OperationId; 622 /** 623 * The current status of the requested operation in the system. Type: String 624 */ 625 Status: OperationStatus; 626 /** 627 * 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 628 */ 629 Type: OperationType; 630 /** 631 * The date when the request was submitted. 632 */ 633 SubmittedDate: Timestamp; 634 } 635 export type OperationSummaryList = OperationSummary[]; 636 export type OperationType = "REGISTER_DOMAIN"|"DELETE_DOMAIN"|"TRANSFER_IN_DOMAIN"|"UPDATE_DOMAIN_CONTACT"|"UPDATE_NAMESERVER"|"CHANGE_PRIVACY_PROTECTION"|"DOMAIN_LOCK"|string; 637 export type PageMarker = string; 638 export type PageMaxItems = number; 639 export type Price = number; 640 export type ReachabilityStatus = "PENDING"|"DONE"|"EXPIRED"|string; 641 export interface RegisterDomainRequest { 642 /** 643 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 644 */ 645 DomainName: DomainName; 646 /** 647 * Reserved for future use. 648 */ 649 IdnLangCode?: LangCode; 650 /** 651 * The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Type: Integer Default: 1 Valid values: Integer from 1 to 10 Required: Yes 652 */ 653 DurationInYears: DurationInYears; 654 /** 655 * Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Type: Boolean Valid values: true | false Default: true Required: No 656 */ 657 AutoRenew?: Boolean; 658 /** 659 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 660 */ 661 AdminContact: ContactDetail; 662 /** 663 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 664 */ 665 RegistrantContact: ContactDetail; 666 /** 667 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 668 */ 669 TechContact: ContactDetail; 670 /** 671 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 672 */ 673 PrivacyProtectAdminContact?: Boolean; 674 /** 675 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 676 */ 677 PrivacyProtectRegistrantContact?: Boolean; 678 /** 679 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 680 */ 681 PrivacyProtectTechContact?: Boolean; 682 } 683 export interface RegisterDomainResponse { 684 /** 685 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 686 */ 687 OperationId: OperationId; 688 } 689 export type RegistrarName = string; 690 export type RegistrarUrl = string; 691 export type RegistrarWhoIsServer = string; 692 export type RegistryDomainId = string; 693 export interface RenewDomainRequest { 694 DomainName: DomainName; 695 /** 696 * The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 documentation. Type: Integer Default: 1 Valid values: Integer from 1 to 10 Required: No 697 */ 698 DurationInYears?: DurationInYears; 699 /** 700 * The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain. Type: Integer Default: None Valid values: Integer Required: Yes 701 */ 702 CurrentExpiryYear: CurrentExpiryYear; 703 } 704 export interface RenewDomainResponse { 705 OperationId: OperationId; 706 } 707 export type Reseller = string; 708 export interface ResendContactReachabilityEmailRequest { 709 /** 710 * The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact. Type: String Default: None Required: Yes 711 */ 712 domainName?: DomainName; 713 } 714 export interface ResendContactReachabilityEmailResponse { 715 /** 716 * The domain name for which you requested a confirmation email. 717 */ 718 domainName?: DomainName; 719 /** 720 * The email address for the registrant contact at the time that we sent the verification email. 721 */ 722 emailAddress?: Email; 723 /** 724 * True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email. 725 */ 726 isAlreadyVerified?: Boolean; 727 } 728 export interface RetrieveDomainAuthCodeRequest { 729 /** 730 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 731 */ 732 DomainName: DomainName; 733 } 734 export interface RetrieveDomainAuthCodeResponse { 735 /** 736 * The authorization code for the domain. Type: String 737 */ 738 AuthCode: DomainAuthCode; 739 } 740 export type State = string; 741 export type String = string; 742 export interface Tag { 743 /** 744 * 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 745 */ 746 Key?: TagKey; 747 /** 748 * 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 749 */ 750 Value?: TagValue; 751 } 752 export type TagKey = string; 753 export type TagKeyList = TagKey[]; 754 export type TagList = Tag[]; 755 export type TagValue = string; 756 export type Timestamp = Date; 757 export interface TransferDomainRequest { 758 /** 759 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 760 */ 761 DomainName: DomainName; 762 /** 763 * Reserved for future use. 764 */ 765 IdnLangCode?: LangCode; 766 /** 767 * The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Type: Integer Default: 1 Valid values: Integer from 1 to 10 Required: Yes 768 */ 769 DurationInYears: DurationInYears; 770 /** 771 * Contains details for the host and glue IP addresses. Type: Complex Children: GlueIps, Name Required: No 772 */ 773 Nameservers?: NameserverList; 774 /** 775 * The authorization code for the domain. You get this value from the current registrar. Type: String Required: Yes 776 */ 777 AuthCode?: DomainAuthCode; 778 /** 779 * Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Type: Boolean Valid values: true | false Default: true Required: No 780 */ 781 AutoRenew?: Boolean; 782 /** 783 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 784 */ 785 AdminContact: ContactDetail; 786 /** 787 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 788 */ 789 RegistrantContact: ContactDetail; 790 /** 791 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 792 */ 793 TechContact: ContactDetail; 794 /** 795 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 796 */ 797 PrivacyProtectAdminContact?: Boolean; 798 /** 799 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 800 */ 801 PrivacyProtectRegistrantContact?: Boolean; 802 /** 803 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: true Valid values: true | false Required: No 804 */ 805 PrivacyProtectTechContact?: Boolean; 806 } 807 export interface TransferDomainResponse { 808 /** 809 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 810 */ 811 OperationId: OperationId; 812 } 813 export interface UpdateDomainContactPrivacyRequest { 814 /** 815 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 816 */ 817 DomainName: DomainName; 818 /** 819 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: None Valid values: true | false Required: No 820 */ 821 AdminPrivacy?: Boolean; 822 /** 823 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: None Valid values: true | false Required: No 824 */ 825 RegistrantPrivacy?: Boolean; 826 /** 827 * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Type: Boolean Default: None Valid values: true | false Required: No 828 */ 829 TechPrivacy?: Boolean; 830 } 831 export interface UpdateDomainContactPrivacyResponse { 832 /** 833 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 834 */ 835 OperationId: OperationId; 836 } 837 export interface UpdateDomainContactRequest { 838 /** 839 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 840 */ 841 DomainName: DomainName; 842 /** 843 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 844 */ 845 AdminContact?: ContactDetail; 846 /** 847 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 848 */ 849 RegistrantContact?: ContactDetail; 850 /** 851 * Provides detailed contact information. Type: Complex Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams Required: Yes 852 */ 853 TechContact?: ContactDetail; 854 } 855 export interface UpdateDomainContactResponse { 856 /** 857 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 858 */ 859 OperationId: OperationId; 860 } 861 export interface UpdateDomainNameserversRequest { 862 /** 863 * The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. Required: Yes 864 */ 865 DomainName: DomainName; 866 /** 867 * The authorization key for .fi domains 868 */ 869 FIAuthKey?: FIAuthKey; 870 /** 871 * A list of new name servers for the domain. Type: Complex Children: Name, GlueIps Required: Yes 872 */ 873 Nameservers: NameserverList; 874 } 875 export interface UpdateDomainNameserversResponse { 876 /** 877 * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. Type: String Default: None Constraints: Maximum 255 characters. 878 */ 879 OperationId: OperationId; 880 } 881 export interface UpdateTagsForDomainRequest { 882 /** 883 * The domain for which you want to add or update tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes 884 */ 885 DomainName: DomainName; 886 /** 887 * A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. Type: A complex type containing a list of tags Default: None Required: No'> Each tag includes the following elements: Key The key (name) of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each key can be 1-128 characters long. Required: Yes Value The value of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each value can be 0-256 characters long. Required: Yes 888 */ 889 TagsToUpdate?: TagList; 890 } 891 export interface UpdateTagsForDomainResponse { 892 } 893 export interface ViewBillingRequest { 894 /** 895 * The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. Type: Double Default: None Required: Yes 896 */ 897 Start?: Timestamp; 898 /** 899 * The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. Type: Double Default: None Required: Yes 900 */ 901 End?: Timestamp; 902 /** 903 * For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. Type: String Default: None Constraints: The marker must match the value of NextPageMarker that was returned in the previous response. Required: No 904 */ 905 Marker?: PageMarker; 906 /** 907 * The number of billing records to be returned. Type: Integer Default: 20 Constraints: A value between 1 and 100. Required: No 908 */ 909 MaxItems?: PageMaxItems; 910 } 911 export interface ViewBillingResponse { 912 /** 913 * If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. Type: String Parent: BillingRecords 914 */ 915 NextPageMarker?: PageMarker; 916 /** 917 * A summary of billing records. Type: Complex type containing a list of billing record summaries. Children: DomainName, Operation, InvoiceId, BillDate and Price 918 */ 919 BillingRecords?: BillingRecords; 920 } 921 export type ZipCode = string; 922 /** 923 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 924 */ 925 export type apiVersion = "2014-05-15"|"latest"|string; 926 export interface ClientApiVersions { 927 /** 928 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 929 */ 930 apiVersion?: apiVersion; 931 } 932 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 933 } 934 export = Route53Domains;