The CheckDomainAvailability request contains the following elements.
" }, "output":{ "shape":"CheckDomainAvailabilityResponse", "documentation":"The CheckDomainAvailability response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
" }, "DeleteTagsForDomain":{ "name":"DeleteTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteTagsForDomainRequest", "documentation":"The DeleteTagsForDomainRequest includes the following elements.
" }, "output":{"shape":"DeleteTagsForDomainResponse"}, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.
" }, "DisableDomainAutoRenew":{ "name":"DisableDomainAutoRenew", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableDomainAutoRenewRequest"}, "output":{"shape":"DisableDomainAutoRenewResponse"}, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"This operation disables automatic renewal of domain registration for the specified domain.
The DisableDomainTransferLock request includes the following element.
" }, "output":{ "shape":"DisableDomainTransferLockResponse", "documentation":"The DisableDomainTransferLock response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" }, "EnableDomainTransferLock":{ "name":"EnableDomainTransferLock", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"EnableDomainTransferLockRequest", "documentation":"The EnableDomainTransferLock request includes the following element.
" }, "output":{ "shape":"EnableDomainTransferLockResponse", "documentation":"The EnableDomainTransferLock response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
The GetDomainDetail request includes the following element.
" }, "output":{ "shape":"GetDomainDetailResponse", "documentation":"The GetDomainDetail response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
" }, "GetOperationDetail":{ "name":"GetOperationDetail", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"GetOperationDetailRequest", "documentation":"The GetOperationDetail request includes the following element.
" }, "output":{ "shape":"GetOperationDetailResponse", "documentation":"The GetOperationDetail response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" } ], "documentation":"This operation returns the current status of an operation that is not completed.
" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListDomainsRequest", "documentation":"The ListDomains request includes the following elements.
" }, "output":{ "shape":"ListDomainsResponse", "documentation":"The ListDomains response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" } ], "documentation":"This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
" }, "ListOperations":{ "name":"ListOperations", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListOperationsRequest", "documentation":"The ListOperations request includes the following elements.
" }, "output":{ "shape":"ListOperationsResponse", "documentation":"The ListOperations response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" } ], "documentation":"This operation returns the operation IDs of operations that are not yet complete.
" }, "ListTagsForDomain":{ "name":"ListTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListTagsForDomainRequest", "documentation":"The ListTagsForDomainRequest includes the following elements.
" }, "output":{ "shape":"ListTagsForDomainResponse", "documentation":"The ListTagsForDomain response includes the following elements.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" }, "RegisterDomain":{ "name":"RegisterDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RegisterDomainRequest", "documentation":"The RegisterDomain request includes the following elements.
" }, "output":{ "shape":"RegisterDomainResponse", "documentation":"The RegisterDomain response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"DomainLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of domains has exceeded the allowed threshold for the account.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" } ], "documentation":"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:
The RetrieveDomainAuthCode request includes the following element.
" }, "output":{ "shape":"RetrieveDomainAuthCodeResponse", "documentation":"The RetrieveDomainAuthCode response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
" }, "TransferDomain":{ "name":"TransferDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"TransferDomainRequest", "documentation":"The TransferDomain request includes the following elements.
" }, "output":{ "shape":"TransferDomainResponse", "documentation":"The TranserDomain response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"DomainLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of domains has exceeded the allowed threshold for the account.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" } ], "documentation":"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.
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.
" }, "UpdateDomainContact":{ "name":"UpdateDomainContact", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateDomainContactRequest", "documentation":"The UpdateDomainContact request includes the following elements.
" }, "output":{ "shape":"UpdateDomainContactResponse", "documentation":"The UpdateDomainContact response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" }, "UpdateDomainContactPrivacy":{ "name":"UpdateDomainContactPrivacy", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateDomainContactPrivacyRequest", "documentation":"The UpdateDomainContactPrivacy request includes the following elements.
" }, "output":{ "shape":"UpdateDomainContactPrivacyResponse", "documentation":"The UpdateDomainContactPrivacy response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" }, "UpdateDomainNameservers":{ "name":"UpdateDomainNameservers", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateDomainNameserversRequest", "documentation":"The UpdateDomainNameserver request includes the following elements.
" }, "output":{ "shape":"UpdateDomainNameserversResponse", "documentation":"The UpdateDomainNameservers response includes the following element.
" }, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"DuplicateRequest", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, { "shape":"TLDRulesViolation", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" }, "UpdateTagsForDomain":{ "name":"UpdateTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateTagsForDomainRequest", "documentation":"The UpdateTagsForDomainRequest includes the following elements.
" }, "output":{"shape":"UpdateTagsForDomainResponse"}, "errors":[ { "shape":"InvalidInput", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, { "shape":"OperationLimitExceeded", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, { "shape":"UnsupportedTLD", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" } ], "documentation":"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.
" } }, "shapes":{ "AddressLine":{ "type":"string", "max":255 }, "Boolean":{"type":"boolean"}, "CheckDomainAvailabilityRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"Reserved for future use.
" } }, "documentation":"The CheckDomainAvailability request contains the following elements.
" }, "CheckDomainAvailabilityResponse":{ "type":"structure", "required":["Availability"], "members":{ "Availability":{ "shape":"DomainAvailability", "documentation":"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.The CheckDomainAvailability response includes the following elements.
" }, "City":{ "type":"string", "max":255 }, "ContactDetail":{ "type":"structure", "members":{ "FirstName":{ "shape":"ContactName", "documentation":"First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "LastName":{ "shape":"ContactName", "documentation":"Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "ContactType":{ "shape":"ContactType", "documentation":"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
" }, "OrganizationName":{ "shape":"ContactName", "documentation":"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
" }, "AddressLine1":{ "shape":"AddressLine", "documentation":"First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "AddressLine2":{ "shape":"AddressLine", "documentation":"Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" }, "City":{ "shape":"City", "documentation":"The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "State":{ "shape":"State", "documentation":"The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "ZipCode":{ "shape":"ZipCode", "documentation":"The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" }, "PhoneNumber":{ "shape":"ContactNumber", "documentation":"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
" }, "Email":{ "shape":"Email", "documentation":"Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" }, "Fax":{ "shape":"ContactNumber", "documentation":"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
" }, "ExtraParams":{ "shape":"ExtraParamList", "documentation":"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
" } }, "sensitive":true, "documentation":"ContactDetail includes the following elements.
" }, "ContactName":{ "type":"string", "max":255 }, "ContactNumber":{ "type":"string", "max":30 }, "ContactType":{ "type":"string", "enum":[ "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" ] }, "CountryCode":{ "type":"string", "enum":[ "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" ] }, "DNSSec":{"type":"string"}, "DeleteTagsForDomainRequest":{ "type":"structure", "required":[ "DomainName", "TagsToDelete" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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 theyaposre surrounded by letters, numbers, or other hyphens. You canapost 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
" }, "TagsToDelete":{ "shape":"TagKeyList", "documentation":"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
'>" } }, "documentation":"The DeleteTagsForDomainRequest includes the following elements.
" }, "DeleteTagsForDomainResponse":{ "type":"structure", "members":{ } }, "DisableDomainAutoRenewRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DisableDomainAutoRenewResponse":{ "type":"structure", "members":{ } }, "DisableDomainTransferLockRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" } }, "documentation":"The DisableDomainTransferLock request includes the following element.
" }, "DisableDomainTransferLockResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The DisableDomainTransferLock response includes the following element.
" }, "DomainAuthCode":{ "type":"string", "max":1024, "sensitive":true }, "DomainAvailability":{ "type":"string", "enum":[ "AVAILABLE", "AVAILABLE_RESERVED", "AVAILABLE_PREORDER", "UNAVAILABLE", "UNAVAILABLE_PREMIUM", "UNAVAILABLE_RESTRICTED", "RESERVED", "DONT_KNOW" ] }, "DomainLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of domains has exceeded the allowed threshold for the account.
" }, "DomainName":{ "type":"string", "max":255, "pattern":"[a-zA-Z0-9_\\-.]*" }, "DomainStatus":{"type":"string"}, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"} }, "DomainSummary":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The name of a domain.
Type: String
" }, "AutoRenew":{ "shape":"Boolean", "documentation":"Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
" } } }, "DomainSummaryList":{ "type":"list", "member":{"shape":"DomainSummary"} }, "DuplicateRequest":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The request is already in progress for the domain.
" }, "DurationInYears":{ "type":"integer", "min":1, "max":10 }, "Email":{ "type":"string", "max":254 }, "EnableDomainAutoRenewRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "EnableDomainAutoRenewResponse":{ "type":"structure", "members":{ } }, "EnableDomainTransferLockRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" } }, "documentation":"The EnableDomainTransferLock request includes the following element.
" }, "EnableDomainTransferLockResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The EnableDomainTransferLock response includes the following elements.
" }, "ErrorMessage":{"type":"string"}, "ExtraParam":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"ExtraParamName", "documentation":"Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
" }, "Value":{ "shape":"ExtraParamValue", "documentation":"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
" } }, "documentation":"ExtraParam includes the following elements.
" }, "ExtraParamList":{ "type":"list", "member":{"shape":"ExtraParam"} }, "ExtraParamName":{ "type":"string", "enum":[ "DUNS_NUMBER", "BRAND_NUMBER", "BIRTH_DEPARTMENT", "BIRTH_DATE_IN_YYYY_MM_DD", "BIRTH_COUNTRY", "BIRTH_CITY", "DOCUMENT_NUMBER", "AU_ID_NUMBER", "AU_ID_TYPE", "CA_LEGAL_TYPE", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER" ] }, "ExtraParamValue":{ "type":"string", "max":2048 }, "FIAuthKey":{"type":"string"}, "GetDomainDetailRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" } }, "documentation":"The GetDomainDetail request includes the following element.
" }, "GetDomainDetailResponse":{ "type":"structure", "required":[ "DomainName", "Nameservers", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The name of a domain.
Type: String
" }, "Nameservers":{ "shape":"NameserverList", "documentation":"The name of the domain.
Type: String
" }, "AutoRenew":{ "shape":"Boolean", "documentation":"Specifies whether the domain registration is set to renew automatically.
Type: Boolean
" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"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
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
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
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
" }, "RegistrantPrivacy":{ "shape":"Boolean", "documentation":"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
" }, "TechPrivacy":{ "shape":"Boolean", "documentation":"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
" }, "RegistrarName":{ "shape":"RegistrarName", "documentation":"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
" }, "WhoIsServer":{ "shape":"RegistrarWhoIsServer", "documentation":"The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
" }, "RegistrarUrl":{ "shape":"RegistrarUrl", "documentation":"Web address of the registrar.
Type: String
" }, "AbuseContactEmail":{ "shape":"Email", "documentation":"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
" }, "AbuseContactPhone":{ "shape":"ContactNumber", "documentation":"Phone number for reporting abuse.
Type: String
" }, "RegistryDomainId":{ "shape":"RegistryDomainId", "documentation":"Reserved for future use.
" }, "CreationDate":{ "shape":"Timestamp", "documentation":"The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
" }, "UpdatedDate":{ "shape":"Timestamp", "documentation":"The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
" }, "ExpirationDate":{ "shape":"Timestamp", "documentation":"The date when the registration for the domain is set to expire. The date format is Unix time.
" }, "Reseller":{ "shape":"Reseller", "documentation":"Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.
Type: String
" }, "DnsSec":{ "shape":"DNSSec", "documentation":"Reserved for future use.
" }, "StatusList":{ "shape":"DomainStatusList", "documentation":"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
" } }, "documentation":"The GetDomainDetail response includes the following elements.
" }, "GetOperationDetailRequest":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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
" } }, "documentation":"The GetOperationDetail request includes the following element.
" }, "GetOperationDetailResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"The identifier for the operation.
Type: String
" }, "Status":{ "shape":"OperationStatus", "documentation":"The current status of the requested operation in the system.
Type: String
" }, "Message":{ "shape":"ErrorMessage", "documentation":"Detailed information on the status including possible errors.
Type: String
" }, "DomainName":{ "shape":"DomainName", "documentation":"The name of a domain.
Type: String
" }, "Type":{ "shape":"OperationType", "documentation":"The type of operation that was requested.
Type: String
" }, "SubmittedDate":{ "shape":"Timestamp", "documentation":"The date when the request was submitted.
" } }, "documentation":"The GetOperationDetail response includes the following elements.
" }, "GlueIp":{ "type":"string", "max":45 }, "GlueIpList":{ "type":"list", "member":{"shape":"GlueIp"} }, "HostName":{ "type":"string", "max":255, "pattern":"[a-zA-Z0-9_\\-.]*" }, "InvalidInput":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" }, "LangCode":{ "type":"string", "max":3 }, "ListDomainsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"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
" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
" } }, "documentation":"The ListDomains request includes the following elements.
" }, "ListDomainsResponse":{ "type":"structure", "required":["Domains"], "members":{ "Domains":{ "shape":"DomainSummaryList", "documentation":"A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName, Expiry, TransferLock
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
The ListDomains response includes the following elements.
" }, "ListOperationsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"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
" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
" } }, "documentation":"The ListOperations request includes the following elements.
" }, "ListOperationsResponse":{ "type":"structure", "required":["Operations"], "members":{ "Operations":{ "shape":"OperationSummaryList", "documentation":"Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status, SubmittedDate, Type
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
The ListOperations response includes the following elements.
" }, "ListTagsForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The domain for which you want to get a list of tags.
" } }, "documentation":"The ListTagsForDomainRequest includes the following elements.
" }, "ListTagsForDomainResponse":{ "type":"structure", "required":["TagList"], "members":{ "TagList":{ "shape":"TagList", "documentation":"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
The ListTagsForDomain response includes the following elements.
" }, "Nameserver":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"HostName", "documentation":"The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
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
Nameserver includes the following elements.
" }, "NameserverList":{ "type":"list", "member":{"shape":"Nameserver"} }, "OperationId":{ "type":"string", "max":255 }, "OperationLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" }, "OperationStatus":{ "type":"string", "enum":[ "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED" ] }, "OperationSummary":{ "type":"structure", "required":[ "OperationId", "Status", "Type", "SubmittedDate" ], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"Identifier returned to track the requested action.
Type: String
" }, "Status":{ "shape":"OperationStatus", "documentation":"The current status of the requested operation in the system.
Type: String
" }, "Type":{ "shape":"OperationType", "documentation":"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
The date when the request was submitted.
" } }, "documentation":"OperationSummary includes the following elements.
" }, "OperationSummaryList":{ "type":"list", "member":{"shape":"OperationSummary"} }, "OperationType":{ "type":"string", "enum":[ "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK" ] }, "PageMarker":{ "type":"string", "max":4096 }, "PageMaxItems":{ "type":"integer", "max":100 }, "RegisterDomainRequest":{ "type":"structure", "required":[ "DomainName", "DurationInYears", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"Reserved for future use.
" }, "DurationInYears":{ "shape":"DurationInYears", "documentation":"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
" }, "AutoRenew":{ "shape":"Boolean", "documentation":"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
" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "TechContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "PrivacyProtectAdminContact":{ "shape":"Boolean", "documentation":"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
" }, "PrivacyProtectRegistrantContact":{ "shape":"Boolean", "documentation":"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
" }, "PrivacyProtectTechContact":{ "shape":"Boolean", "documentation":"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
" } }, "documentation":"The RegisterDomain request includes the following elements.
" }, "RegisterDomainResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The RegisterDomain response includes the following element.
" }, "RegistrarName":{"type":"string"}, "RegistrarUrl":{"type":"string"}, "RegistrarWhoIsServer":{"type":"string"}, "RegistryDomainId":{"type":"string"}, "Reseller":{"type":"string"}, "RetrieveDomainAuthCodeRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" } }, "documentation":"The RetrieveDomainAuthCode request includes the following element.
" }, "RetrieveDomainAuthCodeResponse":{ "type":"structure", "required":["AuthCode"], "members":{ "AuthCode":{ "shape":"DomainAuthCode", "documentation":"The authorization code for the domain.
Type: String
" } }, "documentation":"The RetrieveDomainAuthCode response includes the following element.
" }, "State":{ "type":"string", "max":255 }, "TLDRulesViolation":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The top-level domain does not support this operation.
" }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"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
" }, "Value":{ "shape":"TagValue", "documentation":"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
" } }, "documentation":"Each tag includes the following elements.
" }, "TagKey":{"type":"string"}, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{"type":"string"}, "Timestamp":{"type":"timestamp"}, "TransferDomainRequest":{ "type":"structure", "required":[ "DomainName", "DurationInYears", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"Reserved for future use.
" }, "DurationInYears":{ "shape":"DurationInYears", "documentation":"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
" }, "Nameservers":{ "shape":"NameserverList", "documentation":"Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
Required: No
" }, "AuthCode":{ "shape":"DomainAuthCode", "documentation":"The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
" }, "AutoRenew":{ "shape":"Boolean", "documentation":"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
" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "TechContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "PrivacyProtectAdminContact":{ "shape":"Boolean", "documentation":"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
" }, "PrivacyProtectRegistrantContact":{ "shape":"Boolean", "documentation":"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
" }, "PrivacyProtectTechContact":{ "shape":"Boolean", "documentation":"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
" } }, "documentation":"The TransferDomain request includes the following elements.
" }, "TransferDomainResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The TranserDomain response includes the following element.
" }, "UnsupportedTLD":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Amazon Route 53 does not support this top-level domain.
" }, "UpdateDomainContactPrivacyRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "AdminPrivacy":{ "shape":"Boolean", "documentation":"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
" }, "RegistrantPrivacy":{ "shape":"Boolean", "documentation":"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
" }, "TechPrivacy":{ "shape":"Boolean", "documentation":"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
" } }, "documentation":"The UpdateDomainContactPrivacy request includes the following elements.
" }, "UpdateDomainContactPrivacyResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The UpdateDomainContactPrivacy response includes the following element.
" }, "UpdateDomainContactRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" }, "TechContact":{ "shape":"ContactDetail", "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" } }, "documentation":"The UpdateDomainContact request includes the following elements.
" }, "UpdateDomainContactResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The UpdateDomainContact response includes the following element.
" }, "UpdateDomainNameserversRequest":{ "type":"structure", "required":[ "DomainName", "Nameservers" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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
" }, "FIAuthKey":{ "shape":"FIAuthKey", "documentation":"The authorization key for .fi domains
" }, "Nameservers":{ "shape":"NameserverList", "documentation":"A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
" } }, "documentation":"The UpdateDomainNameserver request includes the following elements.
" }, "UpdateDomainNameserversResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"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.
" } }, "documentation":"The UpdateDomainNameservers response includes the following element.
" }, "UpdateTagsForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"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 theyaposre surrounded by letters, numbers, or other hyphens. You canapost 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
" }, "TagsToUpdate":{ "shape":"TagList", "documentation":"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
The UpdateTagsForDomainRequest includes the following elements.
" }, "UpdateTagsForDomainResponse":{ "type":"structure", "members":{ } }, "ZipCode":{ "type":"string", "max":255 } } }